Create Account Call | Coperniq API

const url = 'https://api.coperniq.io/v1/accounts/1/calls';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"fromNumber":"string","toNumber":"string","isInbound":false,"startTime":"2024-01-15T09:30:00Z","endTime":"2024-01-15T09:30:00Z","reason":"Service","disposition":"Info provided"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "fromNumber": "string",
  "toNumber": "string",
  "isInbound": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "outcome": "ANSWERED",
  "startTime": "2024-01-15T09:30:00Z",
  "endTime": "2024-01-15T09:30:00Z",
  "reason": "Service",
  "disposition": "Info provided",
  "note": "string",
  "summary": "string",
  "transcriptText": "string",
  "recordingUrl": "string",
  "transcriptUrl": "string",
  "missedCount": 1,
  "classificationNote": "string",
  "resolution": "RESOLVED"
}

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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

account_idintegerRequired

Account identifier

Request

This endpoint expects an object.

fromNumberstringRequired

Phone number that initiated the call

toNumberstringRequired

Phone number that received the call

isInboundbooleanRequiredDefaults to false

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

startTimestringRequiredformat: "date-time"

When the call started

endTimestringRequiredformat: "date-time"

When the call ended

reasonstringRequired1-255 characters

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.

dispositionstringRequired1-255 characters

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.

outcomeenumOptional

Call outcome

Allowed values:

notestringOptional

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

recordingUrlstringOptional

URL to the call recording

transcriptUrlstringOptional

URL to an externally hosted call transcript

missedCountintegerOptional

Number of times the call was missed

Response

Call record created successfully

idinteger

Call identifier

fromNumberstring

Phone number that initiated the call

toNumberstring

Phone number that received the call

isInboundboolean

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

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

outcomeenum or nullOptional

Call outcome

Allowed values:

startTimestring or nullOptionalformat: "date-time"

When the call started

endTimestring or nullOptionalformat: "date-time"

When the call ended

reasonstring or nullOptional<=255 characters

dispositionstring or nullOptional<=255 characters

notestring or nullOptional

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

summarystring or nullOptional

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

transcriptTextstring or nullOptional

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

recordingUrlstring or nullOptional

URL to the call recording

transcriptUrlstring or nullOptional

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

missedCountinteger or nullOptional

Number of times the call was missed

classificationNotestring or nullOptional

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

resolutionenum or nullOptional

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

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error