To enable asynchronous call responses (Webhooks), store the token provided in the initial API response.
Fields
Field | Type | Description |
---|---|---|
Token | guid | This is the unique id in our system for your request. |
Success | boolean | Did we successfully process this request? |
ResponseCode | int | See “Response Code Reference” for a description of each code |
Message | string | A brief description of what happened. |
Processed | datetimeoffset | The current DTO of when we finished processing this request. |
{
"Token": "27C3CF6D-5542-4106-AF37-BF16045D6535",
"Success": true,
"ResponseCode":1,
"Message":"Success"
"Processed": "2017-06-12T05:45:24.1996732+00:00"
}
Response Codes
Code(s) | Description |
---|---|
0 | An unknown failure has occurred. |
1, 24 | The transaction was successful, no errors. |
2 | The Record was created, but an error occurred in the routing action. |
3, 8 | A general error occurred during the Record insert. |
4 | The data provided for the Record was invalid. For example, it could be missing required information such as Phone. |
5 | A duplicate of the Record you are trying to insert already exists. |
6, 12 | An invalid Phone number was provided. |
7 | An error occurred for the Record based on project settings. |
9 | The record was created, but an error occurred in the first Drip of the assigned campaign. |
11 | The CountryCode provided is invalid. |
13 | Invalid data was provided. |
14 | An error occurred trying to route the Converted record. |
15 | An error occurred trying to route the Closed record. |
21 | The LongURL provided was invalid. |
22 | A ShortURL failed to be assigned to the record. |
23 | The area code provided is invalid. |
25 | The Record was successfully routed to a project. |
26 | An error occurred when trying to route the Record to the project. |
27 | The Record was rejected due to carrier being blacklisted. |