Get Calls
This request will return a list of Call objects scheduled for some time in the future.
get | /calls |
All Call objects that are returned will have a delay
parameter of more than 0
. By default, the delay
parameter is set to 0
, so calls will be executed immediately after they are created.
This request is enabled for Pagination, Result Filtering, and Field Filtering.
Sample
A sample GET request to get calls matching the criteria in the request URL:
curl -X GET \
"https://api.carrierx.com/flexml/v1/calls" \
-u 'flexml_user_123:qwerty123'
Response
200
status code with a list of Call objects:
{
"count": 1,
"has_more": false,
"items": [
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"attributes": {},
"call_sid": "9dc690bb-a627-4af6-95be-0e259250d8df",
"called_did": "15162065317",
"calling_did": "15162065319",
"date_created": "2018-10-16T21:56:49.000Z",
"delay": 9993,
"method": "POST",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
],
"limit": 10,
"offset": 0,
"pagination": {},
"total": 1
}