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 outbound calls.
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>"
}
}Authorizations
Project-bound Platform API key (abl_...). The key must carry outbound_calls.initiate
for write operations (initiate, terminate) or outbound_calls.read for read operations
(lookup, list, summary, search, event stream).
Path Parameters
The project's slug.
1Deployment environment segment the call runs under, e.g. production, staging, dev.
1Query Parameters
Filter to calls placed through one channel connection.
1Filter 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 Filter to calls initiated with this caller-supplied reference.
1Inclusive ISO 8601 lower bound on call creation time.
Exclusive ISO 8601 upper bound on call creation time.
Page size.
1 <= x <= 100Pass the previous response's nextCursor to get the next page.
1Was this page helpful?