Tracked Call REST Service

Tracked Call API is a RESTful web service that allows authorized third parties to generate the visual alert on dealer desktop(s) and indicate when a call is complete.

Since the API is based on REST principles, it’s very easy to write and test applications. You can use your browser to access URLs, and you can use pretty much any HTTP client in any programming language to interact with the API. The ContactAtOnce! Initiate MTC Variation REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

The Tracked Call API REST web service uses Basic Authentication. ContactAtOnce! can issue you an APIKEY to use. A username and password are not necessary.

Requests

Base URL (regionally defined):

North America : https://api.contactatonce.com/
Australia : https://api.contactatonce.com.au/
Europe : https://api.contactatonce.co.uk/

Register

This REST service is used to generate the visual alert on dealer desktop(s) at the phone call begin time.
Format : JSON
Method : POST
URI : /api/v1.0/TrackedCall/Register

Resource Properties

Request
Parameter	Type	Required	Description
CallId	String	Required	Unique Id assigned to the call by the Publisher.
ConsumerPhone	String	Required	The Consumer's mobile phone number.
MerchantPhone	String	Required	The phone number the consumer called.
StartTime	DateTime	Required	Date and Time the call started.
ConsumerName	String	Optional	Consumers First and Last name.
ConsumerCity	String	Optional	Consumers city.
ConsumerState	String	Optional	Consumers state.
ConsumerAddress1	String	Optional	Consumers address line 1.
ConsumerAddress2	String	Optional	Consumers address line 2.
ConsumerZip	String	Optional	Consumers zipcode.

Response
Paremeter	Type	Description
Status	Boolean	0 - Success 1 - Failure
FailureDescription	String	Nullable. Descriptive text that describes user exceptions.

Sample Header- JSON

Authorization: Basic {YOUR_API_KEY}
Accept: version=2;

Sample POST- JSON

{
    "CallId":"123abcdefg",
    "ConsumerPhone":"+11235556666",
    "MerchantPhone":"+19143804085",
    "StartTime":"2015-12-02 4:30:00 PM",
    "ConsumerName":"first last",
    "ConsumerCity":"city",
    "ConsumerState":"state",
    "ConsumerAddress1":"123 fff",
    "ConsumerAddress2":"",
    "ConsumerZip":"11111"
	}

Sample Response- JSON

{
   "Status": 0,
   "FailureDescription": null
}

Complete

This REST service is used to indicate that call has completed; (and if applicable, call audio location) at the phone call end time.

Format : JSON
Method : POST
URI : /api/v1.0/TrackedCall/Complete

Resource Properties

Request
Parameter	Type	Required	Description
CallId	String	Required	Unique Id assigned to the call by the Publisher.
Status	String	Required	0 - COMPLETE 1 - NOANSWER 2 - HANGUP 3 - VOICEMAIL 4 - BUSY 5 - CANCEL 6 - CONGESTION 7 - ERROR 8 - NOFORWARDS
Duration	String	Required	Duration of the call in seconds.
EndTime	DateTime	Required	Date and Time the call ended.
AdudioFileURL	String	Optional	URL of the call audio file.

Response
Paremeter	Type	Description
Status	Boolean	0 - Success 1 - Failure
FailureDescription	String	Nullable. Descriptive text that describes user exceptions.

Sample Header- JSON

Authorization: Basic {YOUR_API_KEY}
Accept: version=2;

Sample POST- JSON

{
    "CallId":"123abcdefg",
    "Status":"0",    
    "EndTime":"2015-12-02 4:30:30 PM",
    "Duration":"30",
    "AdudioFileURL":"https://audio.somesite.com/audiofiles/123"
	}

Sample Response- JSON

{
   "Status": 0,
   "FailureDescription": null
}