curl --request POST \
--url https://example.com/api/v1/project/{projectSlug}/{env}/outbound-calls/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"destination": {
"type": "phone",
"number": "+14155550123"
}
}
'{
"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>"
}
}Search outbound calls
Search outbound calls by destination.
curl --request POST \
--url https://example.com/api/v1/project/{projectSlug}/{env}/outbound-calls/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"destination": {
"type": "phone",
"number": "+14155550123"
}
}
'{
"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>"
}
}destination is optional — omit it to combine the other filters (phase, outcome, clientReferenceId, channelConnectionId, time window) as a general filtered search.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.
1Body
Destination for the call — a phone number or a SIP URI.
- Option 1
- Option 2
Show child attributes
Show child attributes
1Lifecycle 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 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 11 <= x <= 1001Was this page helpful?