calls

Create Account Call

Create a new phone call record associated with an account

Note: The /clients path is an alias for /accounts and will continue to work until users are individually notified and migrated.

post/accounts/{account_id}/calls

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/accounts/{account_id}/calls
  • Auth: API key in header x-api-key

Path parameters

account_idinteger required

Account identifier

Request body

fromNumberstring required

Phone number that initiated the call

toNumberstring required

Phone number that received the call

isInboundboolean required

Whether the call was inbound (true) or outbound (false)

outcome'ANSWERED' | 'MISSED' | 'VOICEMAIL'

Call outcome

startTimestring date-time required

When the call started

endTimestring date-time required

When the call ended

reasonstring required

Why the call happened. Company-defined: the value is the name of one of the company's call reasons (see GET /calls/classification-options?type=REASON), so it can be any string up to 255 characters. Default reasons are Product, Process, Service, Accounting, Revenue opportunity, Feedback and Other. Calls logged before custom reasons existed hold the legacy uppercase value (e.g. SERVICE). Any string is accepted; use a name from the company's list so the call groups with others in Coperniq.

dispositionstring required

How the call ended up. Company-defined: the value is the name of one of the company's call dispositions (see GET /calls/classification-options?type=DISPOSITION), so it can be any string up to 255 characters. Default dispositions are Info provided, Visit scheduled, Issue resolved, Follow up, Escalation, No action, Unresponsive and Other. Calls logged before custom dispositions existed hold the legacy uppercase value (e.g. INFO_PROVIDED). Any string is accepted; use a name from the company's list so the call groups with others in Coperniq.

notestring

Human-editable note about the call. May contain HTML.

recordingUrlstring

URL to the call recording

transcriptUrlstring

URL to an externally hosted call transcript

missedCountinteger

Number of times the call was missed

Response

Call record created successfully

idinteger required

Call identifier

fromNumberstring required

Phone number that initiated the call

toNumberstring required

Phone number that received the call

isInboundboolean required

Whether the call was inbound (true) or outbound (false)

outcome'ANSWERED' | 'MISSED' | 'VOICEMAIL'

Call outcome

startTimestring date-time nullable

When the call started

endTimestring date-time nullable

When the call ended

reasonstring nullable

Why the call happened. Company-defined: the value is the name of one of the company's call reasons (see GET /calls/classification-options?type=REASON), so it can be any string up to 255 characters. Default reasons are Product, Process, Service, Accounting, Revenue opportunity, Feedback and Other. Calls logged before custom reasons existed hold the legacy uppercase value (e.g. SERVICE).

dispositionstring nullable

How the call ended up. Company-defined: the value is the name of one of the company's call dispositions (see GET /calls/classification-options?type=DISPOSITION), so it can be any string up to 255 characters. Default dispositions are Info provided, Visit scheduled, Issue resolved, Follow up, Escalation, No action, Unresponsive and Other. Calls logged before custom dispositions existed hold the legacy uppercase value (e.g. INFO_PROVIDED).

notestring nullable

Human-editable note about the call. May contain HTML.

summarystring nullable

AI-generated summary of the call. null when the call has no AI transcript.

transcriptTextstring nullable

AI transcript of the call as plain text, one sentence per line in spoken order. null when the call has no AI transcript.

recordingUrlstring nullable

URL to the call recording

transcriptUrlstring nullable

URL to an externally hosted call transcript, if one was provided when the call was logged. For Coperniq phone calls use transcriptText.

missedCountinteger nullable

Number of times the call was missed

classificationNotestring nullable

For calls classified by Coperniq AI, the AI's explanation of why it chose the reason and disposition.

resolution'RESOLVED' | 'ESCALATED' | 'UNRESOLVED'

For calls handled by a Coperniq AI agent, whether the caller's issue was resolved.

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.