Retrieve call logs
GET
/call_logs/list
Retrieve call log list.
In the path parameters, include access token, paging.
A successful request returns the HTTP 200 OK status code and a JSON response body that contains call log array.
Request
Lists call logs by call ID.
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.timestamp
string
required
The earliest timestamp to filter records. Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z).
Sample Request
https://example.com/api/call_logs/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT×tamp=10
Response
A successful request returns the HTTP 200 OK status code and a JSON response body that contains call log array.
pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.page_count
integer
required
The total count of pages.count
integer
required
Current pagesize.details
array
required
Show child attributesFailure code in case the call failed.
Sample Response
{
"pagination": 1,
"pagesize": 100,
"sort_by": "DEFAULT",
"page_count": 100,
"count": 100,
"details": [
{
"call_id": "101ffertwyy4",
"caller": "abcdefg",
"callee": 1,
"start_time": "2017-01-01 00:00:00 UTC",
"answer_time": "2017-01-01 00:00:00 UTC",
"end_time": "2017-01-01 00:00:00 UTC",
"duration": 1,
"call_prefix": 473,
"rate_value": 1.23,
"cost": 23.56,
"status": "READED"
}
]
}
Search call logs
GET
/call_logs/search
Search call log list.
In the path parameters, include access token, paging.
A successful request returns the HTTP 200 OK status code and a JSON response body that contains call log array.
Request
Lists call logs by call ID.
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.timestamp
string
required
The earliest timestamp to filter records. Date-time string in ISO 8601 format (e.g. 2017-01-01T00:00:00.00Z).condition
string
required
Search condition.
Sample Request
https://example.com/api/call_logs/search?access_token=196ACE20C6F34027895F7F95402BB164&condition=100&pagesize=100&pagination=1&sort_by=DEFAULT×tamp=10
Response
A successful request returns the HTTP 200 OK status code and a JSON response body that contains call log array.
pagination
integer
required
The pagination of paging.pagesize
integer
optional
The pagesize of paging.sort_by
enum
optional
Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.page_count
integer
required
The total count of pages.count
integer
required
Current pagesize.details
array
required
Show child attributesFailure code in case the call failed.
Sample Response
{
"pagination": 1,
"pagesize": 100,
"sort_by": "DEFAULT",
"page_count": 100,
"count": 100,
"details": [
{
"call_id": "101ffertwyy4",
"caller": "abcdefg",
"callee": 1,
"start_time": "2017-01-01 00:00:00 UTC",
"answer_time": "2017-01-01 00:00:00 UTC",
"end_time": "2017-01-01 00:00:00 UTC",
"duration": 1,
"call_prefix": 473,
"rate_value": 1.23,
"cost": 23.56,
"status": "READED"
}
]
}
Show certain account
GET
/call_logs/show
Placeholders
Request
Placeholders
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.call_id
string
required
The call ID.
Sample Request
https://example.com/api/call_logs/show?access_token=196ACE20C6F34027895F7F95402BB164&call_id=157eb957e774
Response
Placeholders
count
integer
required
The call ID.targets
array
required
Show child attributesThe call ID.
Sample Response
{
"count": 1,
"targets": [
{
"destination": 123213,
"add_time": "2017-01-01 00:00:00 UTC",
"answer_time": "2017-01-01 00:00:00 UTC",
"end_time": "2017-01-01 00:00:00 UTC",
"talk_time": 213,
"end_reason": "DISCONNECT",
"fail_code": 123
}
]
}
Update call logs status
POST
/call_logs/status/update
Set call log status
Request
Lists call logs by call ID.
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.call_id
string
required
ID of call.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"call_id": "101ffertwyy4"
}
Response
Placeholders