Response

Each API request you send generates a unique record token. This token is our internal identifier for your record and will be used in all future responses, including reports. It allows you to track individual records, especially in projects with multiple instances of the same phone number.

Fields

FieldTypeDescription
TokenguidThis is the unique ID in our system for your request.
SuccessbooleanDid we successfully process this request?
ResponseCodeintSee “Response Codese” below for a brief description.
MessagestringA brief description of what happened.
{  
"Token": "27C3CF6D-5542-4106-AF37-BF16045D6535",  
"Success": true,  
"ResponseCode":1,  
"Message":"Success"  
}

Response Codes

Code(s)Description
0, 2, 11, 13, 20, 21An unknown error has occurred.
1This request has been successfully processed.
3The API token is invalid.
4The API token is not authorized for this request.
10Invalid data was provided.
12The request error was not able to be logged.
14The Record Disposition is missing.
17The project source is paused.
18The records Phone and DID are the same.
22A duplicate of the record you are trying to insert already exists.
23The Record you are trying to insert is mobile and is being rejected.
24The Phone provided is an invalid device type.
26The Record is rejected due to the CarrierId not being accepted on the project.
27The Record you are trying to insert is a landline and is being rejected.