Create call event

post

https://{domain}.uspacy.ua/crm/v1/events/call

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

integration_code

string

required

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

external_id

integer

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

tmp_id

integer

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

task_id

integer

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

contact_id

integer

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_id

integer

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_id

integer

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_id

integer

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

string

enum

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

Allowed:

employees

array

Employees that have been dialed during the call. Could be omitted if don't have such information

employees

contacts

array

The contacts that have connection with particulat call event. Could be omitted if don't have such information

contacts

companies

array

The companies that have connection with particulat call event. Could be omitted if don't have such information

companies

subject

string

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

call_type

string

enum

required

Allowed:

ended_call_status

string

enum

Allowed:

from

string

required

string

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

begin_time

integer

end_time

integer

duration

integer

call_record_link

string

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

note

string

Responses

201

Created

401

Access token is missing or invalid

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

422Validation error response