Skip to navigation

List calls

List the calls of an outbound campaign, newest first: first contacts, retries, callbacks and redirects, whether queued, under way or done.

Path parameters

campaign_idstringRequired

Headers

xi-api-keystringOptional

Query parameters

page_sizeintegerOptional1-500Defaults to 100
How many items to return at most.
lead_idstringOptional
Only this lead's calls.
statusenumOptional
Only calls in this status.
Allowed values:
call_resultenumOptional
Only calls that ended in one of these results.
Allowed values:
stageenumOptional
Only messages at this delivery stage. Message campaigns only.
cursorstringOptional
Used for fetching next page. Cursor is returned in the response.

Response

Successful Response
callslist of objects
has_moreboolean
next_cursorstringOptional

Errors

422
Calls List Request Unprocessable Entity Error