Post a Call Log Status API
Returns the status of the telephony call log request.
- Pass the
x-api-key
in the header, see Async API. - Pass the
RequestId
parameter returned by the Post a Call Log (Async), in the query string. Content-Type
isapplication/json
.
Note: To get metrics for the Post a Call Log (Async), see Get Post Call Log Metrics API.
The response JSON contains the following parameters –
Parameter |
Description | Type | |
RequestId | ID of the request. | String | |
TaskStatus | Top-level parameter. Contains details of the task status. | Object | |
TaskType | The task type related to the request. For example, “Lead Capture”. | String | |
Status | The status of the task. Returned values are “Success” or “Error”. | Boolean | |
StatusReason | Text explaining the reason for the above status. If “Success”, then “Request was successfully completed” is returned; otherwise, error reason is returned. | String | |
TaskCurrentStep | Current step the request is in. | Enum | |
TaskLastStep | Previous step the request completed. | Enum | |
RequestBody | The body that was passed in the Async API request. | Object | |
Message | If successful, response data for the original API request is returned; otherwise null is returned. | Object |
API URL
URL Parameters
Parameter | Description |
---|---|
RequestID | Id of the request returned by the Post a Call Log (Async) API. |
Response
{ "RequestId":"6697028b-01a1-4f71-9afc-7b4723eb9d02", "TaskStatus":{ "TaskType":"Telephony-LogCall", "Status":"Success", "StatusReason":"Request was successfully completed", "TaskCurrentStep":null, "TaskLastStep":"In-Process-Queue", "RequestBody":"{\"SourceNumber\":\"8077128602\",\"DestinationNumber\":\"9399822316\",\"DisplayNumber\":\"8068121655\",\"StartTime\":\"2020-09-30 13:33:00\",\"EndTime\":\"2020-09-30 13:58:00\",\"CallSessionId\":\"61df8827-63d1-4f31-bd3c-ae2d9947161d\",\"CallDuration\":\"1497\",\"Status\":\"Answered\",\"ResourceURL\":\"https://sr.knowlarity.com/vr/fetchsound/?callid=61df8827-63d1-4f31-bd3c-ae2d9947161d\",\"Direction\":\"Inbound\"}", "Message":"{\"Status\":\"Success\",\"Message\":\"Phone Call Logged Successfully\",\"ProspectActivityId\":\"a9532087-0378-11eb-b8e7-0641ba0398c2\"}" } }
HTTP Response Codes
Code | Description |
---|---|
200 OK | This is the status code for successful API call. |
401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
404 Not Found | The API could not be found. Please check the API signature. |
429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |