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_idstring or nullOptional
Only this lead's calls.
statusenum or nullOptional
Only calls in this status.
Allowed values:
call_resultlist of enums or nullOptional
Only calls that ended in one of these results.
Allowed values:
stageenum or nullOptional
Only messages at this delivery stage. Message campaigns only.
cursorstring or nullOptional
Used for fetching next page. Cursor is returned in the response.

Response

Successful Response
callslist of objects
next_cursorstring or null
has_moreboolean

Errors

422
Unprocessable Entity Error