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>"
}
}Search outbound calls
Search outbound calls by the real destination number or SIP URI without exposing it in a URL, and combine it with other filters.
POST
/
api
/
v1
/
project
/
{projectSlug}
/
{env}
/
outbound-calls
/
search
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. The request also accepts limit (1 to 100) and cursor, and returns the same page format as List outbound calls. The request needs the outbound_calls.read scope.Authorizations
Path Parameters
Body
application/json
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.
Available options:
completed, busy, rejected, no_answer, machine, failed, canceled, expired Was this page helpful?