Loading
Cart Total
$0.00
-
Your shopping cart is empty
Loading
Hello! Log in Your Account
New customer? Start here
Phone Calls & CDR Data
Storefronts
Customer Management
VoIP Bundle (Subscriptions)
SIP Account Management
Audio Management
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
eFax Management
Voicemails & Mailboxes
Caller ID
SIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
Call Queueing
Phone Books
VoIP Phone Speed Dial
Text (SMS) Messaging
Commands to get the history of calls made on an account
Become a ResellerFilter:
* You will be charged every time this command is run.
Gets a paged history of calls made on an account
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
start
Date
True
The start of the date range to search on, e.g. 2015-01-31T9:00:00
end
Date
True
The end of the date range to search on, e.g. 2015-01-3T17:00:00
call_type
String
False
Filter on the call type ('inbound', 'outbound', or 'internal')
answered
Boolean
False
Filter on whether or not the call was answered
recording
Boolean
False
Filter on whether or not the call has a recording
limit
String
False
How many results to return per page: default 10
page
String
False
Which page of results to return: default 1
include_cdr
String
False
Indicates if the call records should be returned with the response, valid values are 'yes' and 'no',' default is 'yes'
include_count
String
False
Indicates if the total number of calls should be returned, valid values are 'yes' and 'no', default is 'yes'
include_legs
String
False
Should the call history include a breakdown of each leg of a call (e.g. when they are transferred between users), valid values are 'yes' and 'no', default is 'no'
200 Response
{
"result" : [
{
"answered" : true,
"call_duration" : 152,
"call_start_time" : 1448457130,
"call_type" : "OUTBOUND",
"child_uuid" : "360f1ead-3264-4f03-8c7a-1079aab59568",
"cost" : 0.02,
"created_on" : "2023-02-07",
"has_recording" : true,
"next_leg" : {},
"parent_uuid" : "eedf0ea9-94f2-4370-9712-f9c4d0f7035c",
"status" : "COMPLETE",
"uuid" : "40c6614b-8c5d-48a0-ab6d-cdc4d47f914d"
}
],
"status_code" : 200,
"status_message" : "OK"
}
Gets a paged history of calls made on an account
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
start
Date
True
The start of the date range to search on, e.g. 2015-01-31T09:00:00
end
Date
True
The end of the date range to search on, e.g. 2015-01-3T17:00:00
call_type
String
False
Filter on the call type ('inbound', 'outbound', or 'internal')
answered
Boolean
False
Filter on whether or not the call was answered
recording
Boolean
False
Filter on whether or not the call has a recording
limit
String
False
How many results to return per page: default 10
page
String
False
Which page of results to return: default 1
include_cdr
String
False
Indicates if the call records should be returned with the response, valid values are 'yes' and 'no', default 'yes'
include_count
String
False
Indicates if the total number of calls should be returned, valid values are 'yes' and 'no', default 'yes'
include_legs
String
False
Should the call history include a breakdown of calls when they are transferred between users, valid values are 'yes' and 'no', default 'no'
200 Response
{
"result" : [
{
"answered" : true,
"call_duration" : 152,
"call_start_time" : 1448457130,
"call_type" : "OUTBOUND",
"child_uuid" : "360f1ead-3264-4f03-8c7a-1079aab59568",
"cost" : 0.02,
"created_on" : "2023-02-07",
"has_recording" : true,
"next_leg" : {},
"parent_uuid" : "eedf0ea9-94f2-4370-9712-f9c4d0f7035c",
"status" : "COMPLETE",
"uuid" : "40c6614b-8c5d-48a0-ab6d-cdc4d47f914d"
}
],
"status_code" : 200,
"status_message" : "OK"
}
Gets a paged history of calls made on an account
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
start
Date
True
The start of the date range to search on, e.g. 2015-01-31T09:00:00
end
Date
True
The end of the date range to search on, e.g. 2015-01-3T17:00:00
call_type
String
False
Filter on the call type ('inbound', 'outbound', or 'internal')
call_from
String
False
A comma-separated list to filter the caller on
call_to
String
False
A comma-separated list to filter the callee on
answered
Boolean
False
Filter on whether or not the call was answered
recording
Boolean
False
Filter on whether or not the call has a recording
limit
String
False
How many results to return per page: default 10
page
String
False
Which page of results to return: default 1
include_cdr
String
False
Indicates if the call records should be returned with the response, valid values are 'yes' and 'no', default 'yes'
include_count
String
False
Indicates if the total number of calls should be returned, valid values are 'yes' and 'no', default 'yes'
include_legs
String
False
Should the call history include a breakdown of calls when they are transferred between users, valid values are 'yes' and 'no', default 'no'
200 Response
{
"result" : [
{
"answered" : true,
"call_duration" : 152,
"call_start_time" : 1448457130,
"call_type" : "OUTBOUND",
"child_uuid" : "360f1ead-3264-4f03-8c7a-1079aab59568",
"cost" : 0.02,
"created_on" : "2023-02-07",
"has_recording" : true,
"next_leg" : {},
"parent_uuid" : "eedf0ea9-94f2-4370-9712-f9c4d0f7035c",
"status" : "COMPLETE",
"uuid" : "40c6614b-8c5d-48a0-ab6d-cdc4d47f914d"
}
],
"status_code" : 200,
"status_message" : "OK"
}
400 Response
{
"result" : {},
"status_code" : 400,
"status_message" : "Bad Request"
}
Gets the details of a specific call
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Call to be queried
200 Response
{
"result" : {
"answered" : true,
"call_duration" : 152,
"call_start_time" : 1448457130,
"call_type" : "OUTBOUND",
"child_uuid" : "360f1ead-3264-4f03-8c7a-1079aab59568",
"cost" : 0.02,
"created_on" : "2023-02-07",
"has_recording" : true,
"next_leg" : {},
"parent_uuid" : "eedf0ea9-94f2-4370-9712-f9c4d0f7035c",
"status" : "COMPLETE",
"uuid" : "40c6614b-8c5d-48a0-ab6d-cdc4d47f914d"
},
"status_code" : 200,
"status_message" : "OK"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}
Generates a temporary URL to the call recording audio
Back to top
Request Details
Response Details
URL and Query String Parameters
Name
Type
Required
uuid
String
True
The UUID of the Call to get the recording URL for
200 Response
{
"result" : {
"recording" : "http://recordings.yay.com/40c6614b-8c5d-48a0-ab6d-cdc4d47f914d"
},
"status_code" : 200,
"status_message" : "OK"
}
404 Response
{
"result" : {},
"status_code" : 404,
"status_message" : "Not Found"
}