curl --request GET \
--url https://example.com/api/v1/project/{projectSlug}/{env}/outbound-calls \
--header 'x-api-key: <api-key>'{
"success": true,
"data": [
{
"outboundCallId": "<string>",
"channelConnectionId": "<string>",
"environment": "<string>",
"destinationType": "phone",
"destination": "<string>",
"initiationState": "created",
"phase": "accepted",
"outcome": "completed",
"failureReason": "<string>",
"amdMode": "off",
"providerCallSid": "<string>",
"sessionId": "<string>",
"statusHistory": [
{
"phase": "accepted",
"outcome": "completed",
"providerEventAt": "2023-11-07T05:31:56Z",
"ingestedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"clientReferenceId": "<string>"
}
],
"nextCursor": "<string>"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}List outbound calls
List a project’s outbound calls with filters and cursor pagination.
curl --request GET \
--url https://example.com/api/v1/project/{projectSlug}/{env}/outbound-calls \
--header 'x-api-key: <api-key>'{
"success": true,
"data": [
{
"outboundCallId": "<string>",
"channelConnectionId": "<string>",
"environment": "<string>",
"destinationType": "phone",
"destination": "<string>",
"initiationState": "created",
"phase": "accepted",
"outcome": "completed",
"failureReason": "<string>",
"amdMode": "off",
"providerCallSid": "<string>",
"sessionId": "<string>",
"statusHistory": [
{
"phase": "accepted",
"outcome": "completed",
"providerEventAt": "2023-11-07T05:31:56Z",
"ingestedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"clientReferenceId": "<string>"
}
],
"nextCursor": "<string>"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}outbound_calls.read scope.
Filter by channelConnectionId, phase, outcome, clientReferenceId, and a creation time window with from (inclusive) and to (exclusive). Page with limit (1 to 100, default 50) and cursor. Pass the nextCursor from the response as cursor to get the next page. It is null on the last page. To find calls by destination number, use Search outbound calls.Authorizations
Path Parameters
Query Parameters
Filter by current lifecycle phase.
Lifecycle phase, in order: accepted=submitted, not yet dialing; dialing=submitted to
the carrier; ringing=destination is ringing; in_progress=answered, call is live;
terminal=call has ended (see outcome).
accepted, dialing, ringing, in_progress, terminal Filter by terminal outcome. Only calls that have reached phase=terminal have one.
How a terminal call ended. completed=ended normally after connecting;
busy=destination was busy; rejected=destination actively declined/rejected the call;
no_answer=rang without being picked up; machine=answering machine detected (only
possible with amdMode other than off); failed=a hard failure prevented completion;
canceled=terminated by a .../terminate call before it connected; expired=the call was
abandoned before reaching a provider-reported outcome.
completed, busy, rejected, no_answer, machine, failed, canceled, expired Was this page helpful?