Agents Platform

List Outbound Campaign Calls

Changed on

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

get/v1/convai/outbound-campaigns/campaigns/{campaign_id}/calls

Request

Path parameters

campaign_idstring required

Query parameters

page_sizeinteger

How many items to return at most.

lead_idstring nullable

Only this lead's calls.

status'queued' | 'submitted' | 'completed' | 'cancelled' | 'attention'

Only calls in this status.

call_resultCallResult[] nullable

Only calls that ended in one of these results.

stage'queued' | 'sent' | 'delivered' | 'read' | 'replied' | 'failed' nullable

Only messages at this delivery stage. Message campaigns only.

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

next_cursorstring nullable required
has_moreboolean required

Changes