Skip to main content

Create a call

POST 
/v2/activities/calls

Creates a call. The parameters of this endpoint can be used to create an action and ensure that the CRM Task is mapped correctly.

Request​

Body

required
    person_id integer

    The ID of the person whom this call will be logged for

    to string

    The phone number that was called

    duration integer

    The length of the call, in seconds

    disposition string

    The disposition of the call. Can be required on a per-team basis. Must be present in the disposition list.

    sentiment string

    The sentiment of the call. Can be required on a per-team basis. Must be present in the sentiment list.

    notes string

    Notes to log for the call. This is similar to the notes endpoint, but ensures that the notes get synced to the user's CRM

    user_guid string

    Guid of the user whom this call should be logged for. Defaults to the authenticated user. Only team admins can pass another user's guid

    action_id integer

    Action that this call is being logged for. This will validate that the action is still valid before completing it. The same action can never be successfully passed twice to this endpoint. The action must have a type of 'phone'.

    task_id integer

    Task that this call is being logged for. This will validate that the task is still valid before completing it. The same task can never be successfully passed twice to this endpoint. The task must have a type of 'call.' Can not be present if action_id was also provided.

    crm_params object

    CRM specific parameters. Some parameters are required on a per-team basis. Consume the CrmActivityFields endpoint to receive a list of valid parameters. The "field" property is passed as the key of this object, and the value of this object is the value that you would like to set.

    If CrmActivityField has a non-null value, then that value must be submitted, or excluded from API calls, as these values are automatically applied.

    linked_call_data_record_ids integer[]

    CallDataRecord associations that will become linked to the created call. It is possible to pass multiple CallDataRecord ids in this field; this can be used to represent multiple phone calls that made up a single call.

    Any call data record that is used must not already be linked to a call. It is not possible to link a call data record to multiple calls, and it is not possible to re-assign a call data record to a different call.

    crm_activity_metadata object

    Sets the CRM activity metadata on the call log

Responses​

Success

Schema
    id integer

    ID of Call

    to string

    Phone number that received the call

    duration integer

    Length of the call in seconds

    sentiment string

    Outcome of the conversation

    disposition string

    Result of the call

    created_at date-time

    Datetime of when the call was created

    updated_at date-time

    Datetime of when the call was last updated

    recordings object[]

    The recordings for this this call and their status

  • Array [
    • url string

    The url of the recording

    status string

    The status of the call that produced this recording. Possible values are (but not limited to):

    no-answer: The call was not answered

    failed: The call was not able to be placed

    busy: The call was busy

    ringing: The call is ringing

    in-progress: The call is ongoing

    completed: The call is finished

    recording_status string

    The processing status of the recording. Possible values are (but not limited to):

    not_recorded: there is no recording available, and there will not be one becoming available

    pending: the recording is currently being processed by the system

    processing: the recording is currently being processed by the system

    completed: the recording processing has been completed

  • ]
    • user object

    User that made the call

    id integer
    _href string
    action object

    Action associated to the call

    id integer
    task object

    Task that this call was loged from, or null if not sent through a cadence

    id integer
    called_person object

    The person called

    id integer
    _href string
    crm_activity object

    CRM Activity associated with the call

    id integer
    _href string
    note object

    Note for this call

    id integer
    _href string
    cadence object

    Cadence the call was made on

    id integer
    _href string
    step object

    Step the call was made on

    id integer
    _href string
Loading...