contactLoad: Upload the contact file

Function Description:

Upload the address book file of the Total Control server to the phone address book, Restore your phone contacts.

Corresponding JS API:
contactLoad(fileName, fields, opt, rule)
Whether to support multiple devices:

No

Version:

For Total Control version 6.9.0 and higher

Resource Information:

Method POST
URL .../devices/:device/contacts?type=export&file_url=:file_url&rule=:rule&fields=:fields
Requires authentication? Yes


Method Parameters:

Parameter Type Required Description
device String Yes ID value of the device
type String Yes A fixed value: export.
file_url String Yes URL of the recovered address book file.
1. Upload the address book file to the “tcbr/contacts” folder of the Total Control server. The value of the returned “file_url” field is the URL to restore the address book file.
How to upload a file? please click here.
2. If you want to use the backed up address book file to recover your contacts, This value is the file_url field returned by the REST API backup address book (contactSave).
In Total Control 7.0.0 and later, the phone address book supports recovery of address book files in xls, xlsx format.
rule Int Yes Restore the rules of the phone address book:
1 means to retain duplicate data
2 means replace duplicate data
3 means skipping duplicate data
fields Array No Restore the fields specified in the contact details. If you do not fill in, restore all fields. If you only restore some fields, you must also include the name and a phone number field.
For example, if we want to upload the company field, the value of this parameter is: ['name', 'phone1', 'company']


Response Parameters:

A JSON string representing an array of objects with the following fields:

Field Type Description
status Boolean Return true for success and null for failure
value String If the value of status is true, an empty string is returned;
If the value of status is a null object, an error message or empty string is returned.


Request Example:
http://localhost:8090/TotalControl/v1/devices/device@1174886816/contacts
{
    'type': 'export', 
    'file_url': 'http://127.0.0.1:8090/TotalControl/v1/storage/tcbr/contacts/HUAWEI-HUAWEI P7-L07-2018-34-01-17-34-58.json', 
    'rule': '2', 
    'token': 'd7Dsw6Si4VQ341g7'
}
Response Example:

If this API executes successfully, it returns:

{
    "status": true,
    "value": ""
}

If the value of HTTP status code is 200, but the value of status is a null object, it returns:

{
    "status": null,
    "value": "<Error message>"
}


Example:

Warm tip:
Get the token needed for Total Control script development,see here.
Get the id value of the master device, see here.

RingoJS Example:
// Import the packages
var {request} = require("ringo/httpclient");
var base64 = require("ringo/base64");

// The username and password are separated by a single : and sent on the wire base64 encoded
var userpass = base64.encode("sigma:3D391497");

// First step: Get the API token
var gettoken = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/login",
	headers: {
		"Authorization": userpass
	}
});
var ret_token = JSON.parse(gettoken.content); 
var token = ret_token.value.token; 
print("//The value of token is:" + token);

// Second step: Get the device id value of the master device
var getdevice = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/devices/main?token=" + token
});
var device = JSON.parse(getdevice.content).id; 
print("//The value of device ID is:"+ device);

// Third step: Execute this REST API
var resp = request({
	method: "POST",
	url: "http://localhost:8090/TotalControl/v1/devices/" + device + "/contacts",
	data: {
		"type": "export",
		"file_url": "http://127.0.0.1:8090/TotalControl/v1/storage/tcbr/contacts/mycontact3.xls",
		"rule": 2,
		"fields": "['name','phone1','company']",
		"token": token,
	}
});
var obj = JSON.parse(resp.content); 
var ret = obj.status;
if (ret == true) {
	print("//Executed successfully,Return value: \n"+resp.content);	
} else if (ret != true & resp.status == 200){
	print("An error message is returned: "+resp.content);
} else {
	print("This API failed to execute.");
}
The running result of the RingoJS:

If it executes successfully, it will return:

//The value of token is:R6x0t15Wt7aN97Y9
//The value of device ID is:device@33254183
//Executed successfully,Return value: 
{"status":true, "value":""}
Python Example:
#!/user/bin/python
#-*- coding:utf-8 -*-
import base64
import requests

# The username and password are separated by a single : and sent on the wire base64 encoded
user_pass = 'sigma:3D391497'
encodeStr = base64.b64encode(user_pass.encode("UTF-8"))

# First step: Get the API token
LoginUrl = "http://localhost:8090/TotalControl/v1/login"
response = requests.get(LoginUrl, headers={'Authorization':encodeStr})
print("Get the token,Return value: ",response.json())
token = response.json()['value']['token']
print("The value of token is: ",token)

# Second step: Get the device id value of the master device
if token is not None:
    GetDeviceUrl = "http://localhost:8090/TotalControl/v1/devices/main?token=" + token
    response = requests.get(url=GetDeviceUrl)
    print("Get the device id,Return value: ", response.json())
    device = response.json()['id']
    print("The value of device id is: ", device)
    if device is not None:
        # Third step: Execute this REST API
        APIUrl = "http://localhost:8090/TotalControl/v1/devices/" + device + "/contacts"
        data = {
            "type": "export",
            "file_url": "http://127.0.0.1:8090/TotalControl/v1/storage/tcbr/contacts/mycontact1.xls",
            "rule": 1,
            "fields": "['name','phone1','company']",
            "token": token
        }
        response = requests.post(url=APIUrl, params=data)
        ret = response.json()['status']
        # Determine if this REST API is executed successfully
        if ret is True:
            print("Executed successfully,Return value: ", response.json())
        elif response.status_code == 200 and ret is not True:
            print("An error message is returned: ",response.json())
        else:
            print("This API failed to execute.")
    else:
        print("Failed to get device id.")
else:
    print("Failed to get token.")
The running result of the python:

If it executes successfully, it will return:

Get the token,Return value:  {'status': True, 'value': {'token': 'R6x0t15Wt7aN97Y9'}}
The value of token is:  R6x0t15Wt7aN97Y9
Get the device id,Return value:  {'id': 'device@33254183'}
The value of device id is:  device@33254183
Executed successfully,Return value:  {'status': True, 'value': ''}