COcoevera
Call

Calls.create

Creates a Call record.

post/entities/Calls

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

account_idstring uuid

Id of the linked account.

caller_idstring uuid required

Id of the calling user.

client_idstring uuid

Id of the user the call was made with.

contact_idstring uuid

Id of the linked contact.

lead_oppty_idstring uuid

Id of the linked lead or opportunity, or empty when not linked.

oppty_product_relation_idstring uuid

Id of the linked opportunity product line-item.

phone_numberstring

External phone number called or received, in E.164 format.

product_idstring uuid

Id of the linked product.

transcription_idstring

External transcription identifier from the calling provider.

transcription_languagestring

Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").

transcription_summarystring

AI-generated summary of the call transcription.

twilio_call_log_idstring uuid required

Id of the call-log record from the calling provider that this call is associated with.

audio_status'NoRecording' | 'TranscriptionCompleted' | 'TranscriptionEmpty' | 'TranscriptionError' | 'TranscriptionInProgress' | 'UploadError' | 'Uploaded' | 'Uploading' required

Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "caller_id": "01234567-abcd-dcba-ffff-000000000000",
  "client_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "oppty_product_relation_id": "01234567-abcd-dcba-ffff-000000000000",
  "phone_number": "string",
  "product_id": "01234567-abcd-dcba-ffff-000000000000",
  "transcription_id": "string",
  "transcription_language": "string",
  "transcription_summary": "string",
  "twilio_call_log_id": "01234567-abcd-dcba-ffff-000000000000",
  "audio_status": "NoRecording"
}

Response

The created Call record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "caller_id": "01234567-abcd-dcba-ffff-000000000000",
    "client_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_product_relation_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone_number": "string",
    "product_id": "01234567-abcd-dcba-ffff-000000000000",
    "transcription_id": "string",
    "transcription_language": "string",
    "transcription_summary": "string",
    "twilio_call_log_id": "01234567-abcd-dcba-ffff-000000000000",
    "transcription_file_id": "01234567-abcd-dcba-ffff-000000000000",
    "audio_id": "01234567-abcd-dcba-ffff-000000000000",
    "twilio_call_sid": "string",
    "audio_status": "NoRecording"
  }
}

Changes

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