v1

latestOpenAPI 3.1.02026-07-1414757122.7 KB

call events

Create call event

Creates a new call event. Used by telephony integrations to log calls in CRM. If task_id is not provided, a task for missed incoming calls is created automatically. If dynamic binding fields (deal_id, lead_id, etc.) are provided, automatic binding is skipped.

post/crm/v1/events/call

Request body

integration_codestring required

It could be integration_code or unique code of source where data are imported from

external_idinteger

It should be unique for one particular integration_code or null if adding call event directly (e.g. import)

tmp_idinteger

It should be unique for one particular integration_code or null if adding call event directly (e.g. import)

task_idinteger

If task_id is provided the task's creation for missed incoming call is passing away

contact_idinteger

If one of dynamic binding fields (deal_id, lead_id, contact_id, company_id) is provided the automatic binding with existing crm entities is passing away

company_idinteger

If one of dynamic binding fields (deal_id, lead_id, contact_id, company_id) is provided the automatic binding with existing crm entities is passing away

lead_idinteger

If one of dynamic binding fields (deal_id, lead_id, contact_id, company_id) is provided the automatic binding with existing crm entities is passing away

deal_idinteger

If one of dynamic binding fields (deal_id, lead_id, contact_id, company_id) is provided the automatic binding with existing crm entities is passing away

entity_table'empty' | 'leads,' | 'deals' | 'contacts' | 'companies'

The base entity the call event connected to could be provided or could be omitted in a case if just have usual call. In this the "empty" value will be automatically filled and the call event will be shown just in call logs history

subjectstring

Could be omitted. In such case the default value will be "Call"

call_type'outgoing' | 'incoming' required

ended_call_statusstring

fromstring required

tostring

Could be null cause on new event call from telephony we don't have "to" value for sure

begin_timeinteger

end_timeinteger

durationinteger

call_record_linkstring

It could be call link that telephony provides or link issued by import flow (via files-backend)

notestring

Example request

{
  "integration_code": "unitalk_integration",
  "external_id": 1,
  "tmp_id": 1,
  "employees": [
    1,
    2,
    3
  ],
  "contacts": [
    1,
    2,
    3
  ],
  "companies": [
    1,
    2,
    3
  ],
  "subject": "First call",
  "begin_time": 1681893335,
  "end_time": 1681893685,
  "duration": 350,
  "note": "Fixed agenda"
}

Response

Created