Skip to content
Get started

Call

Get call by ID
client.call.retrieve(stringid, RequestOptionsoptions?): CallRetrieveResponse { call }
GET/call/{id}
Place a call
client.call.create(CallCreateParams { phone_number, assistant, assistant_id, 6 more } body, RequestOptionsoptions?): CallCreateResponse { call }
POST/call
Get calls
client.call.search(CallSearchParams { assignee_ids, assistant_ids, campaign_ids, 12 more } body, RequestOptionsoptions?): CallSearchResponse { calls, total_count }
POST/call/search
Export calls history
client.call.export(CallExportParams { filters, include_metadata, include_structured_output_fields } body, RequestOptionsoptions?): CallExportResponse { csv, filename }
POST/call/export
Pause a call
client.call.pause(stringid, RequestOptionsoptions?): CallPauseResponse { success }
POST/call/{id}/pause
Resume a paused call
client.call.resume(stringid, RequestOptionsoptions?): CallResumeResponse { success }
POST/call/{id}/resume
Cancel a call
client.call.cancel(stringid, RequestOptionsoptions?): CallCancelResponse { success }
POST/call/{id}/cancel
Get phone number history across the organization
client.call.phoneHistory(RequestOptionsoptions?): CallPhoneHistoryResponse { phone_history }
GET/calls/phone-history