Create Project Call | Coperniq API

const url = 'https://api.coperniq.io/v1/projects/project_id/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":"PRODUCT","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": "PRODUCT",
  "disposition": "INFO_PROVIDED",
  "note": "string",
  "recordingUrl": "string",
  "transcriptUrl": "string",
  "missedCount": 1
}

Create a new phone call record associated with a project

Authentication

x-api-keystring

API Key authentication via header

Path parameters

project_idstringRequired

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

reasonenumRequired

Reason for the call

dispositionenumRequired

Call disposition

outcomeenumOptional

Call outcome

notestringOptional

Notes about the call

recordingUrlstringOptional

URL to the call recording

transcriptUrlstringOptional

URL to the call transcript

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

startTimestring or nullOptionalformat: "date-time"

When the call started

endTimestring or nullOptionalformat: "date-time"

When the call ended

reasonenum or nullOptional

Reason for the call

dispositionenum or nullOptional

Call disposition

notestring or nullOptional

Notes about the call

recordingUrlstring or nullOptional

URL to the call recording

transcriptUrlstring or nullOptional

URL to the call transcript

missedCountinteger or nullOptional

Number of times the call was missed

Errors

400

Bad Request Error

401

Unauthorized Error