Contacts Web Service

Contacts JSON

Contacts can be imported into the app via REST API. The URL, username and password for the API can be entered with the rest of the configuration settings. Once present the app will sync contacts with the server every 30 minutes. The contacts will be imported using either GET or POST method as specified by the setting in the SessionCloud portal. The response should be JSON as shown below.

‍

JSON Response:

[
	{
	"Id":"602bf55338975909a8e36a48",
    	"Checksum":"89540476",
	"Avatar":"https://example.com/avatar.png",
	"LargeAvatar":"https://example.com/largeavatar.png",
	"Birthday":"1985-06-12",
	"FirstName":"Jane",
	"LastName":"Doe",
    	"Street":"James Avenue",
    	"Zip":"34344",
    	"City":"Atlanta",
    	"Country":"USA",
    	"CountryCode":"US",
	"State":"GA",
	"Notes":"",
	"Website":"",
	"Email":["JDoeSmith@outlook.com"],
	"Softphone":["03423423","125345345"],
	"WorkNumber":["100000000","011111111111"],
	"HomeNumber":["02222222","033333333"],
	"MobileNumber":["044444444","055555555"],
	"Fax":["0666666","07777777"],
	"Other":["0888888888","099999999"]
	},
  	{
	"Id":"602a52f538975909a8e36a49",
    	"Checksum":"14890479",
	"Avatar":"https://example.com/avatar.png",
	"LargeAvatar":"https://example.com/largeavatar.png",
	"Birthday":"1978-01-26",
	"FirstName":"John",
	"LastName":"Doe",
    	"Street":"Privet Drive",
    	"Zip":"12844",
    	"City":"Dallas",
	"State":"TX",
    	"Country":"USA",
    	"CountryCode":"US",
	"Notes":"",
	"Website":"",
	"Email":["JDoe@gmail.com"],
	"Softphone":["23423423","345345345"],
	"HomeNumber":["22222222","333333333"],
	"MobileNumber":["444444444","555555555"],
	"Fax":["6666666","77777777"],
    	"WorkNumber":["000000000","111111111111"],
	"Other":["8888888888","999999999"]
	}
]

Description of Keys

‍

Id

Unique identifier of contact. Contacts without this will be ignored

‍

Checksum

A string value which should change if any field in the contact changes. The softphone will use this

to determine whether to update the contact with new information

‍

HomeNumber, MobileNumber, WorkNumber, Fax, Softphone, Other

Array of string values containing phone numbers.

‍

CountryCode

ISO2 country code

‍

Email

Array of strings containing email addresses

‍

The strings inside contacts should use UTF-8 encoding.

Remote PhoneBook

if enabled the softphone will attempt to import contacts via REST API from the url specified in Remote Phonebook Url field

‍

Title shown in Apps

This is the Group ( Desktop softphones) that the contacts will be assigned to within the apps

‍

Remote Phonebook Url

REST API endpoint

‍

Remote Phonebook POST Data

If present the app will use POST rather than GET

Example for application/json

{"username" : "%user%","password" : "%pwd%"}