Calls

This endpoint is used to retrieve call records from CallScaler. It supports the GET method to fetch all records associated with a specific call. To obtain the user call record, include your CallScaler email in the request. By using this endpoint, you can access comprehensive call data, enabling effective tracking and analysis of call interactions.

The calls model

The calling model encompasses comprehensive data on the calls and attachments you send to your contacts and groups. This includes information on how your contacts have interacted with these calls, such as reactions and responses.

Properties

  • Name
    uuid
    Type
    string
    Description

    Unique identifier for the call.

  • Name
    call_to_number
    Type
    number
    Description

    The CallScaler number.

  • Name
    call_from_number
    Type
    number
    Description

    The number which we do call from.

  • Name
    call_transcription_text
    Type
    string
    Description

    The transcription of call recording.

  • Name
    call_direction
    Type
    string
    Description

    The direction of the call.

  • Name
    call_recording_url
    Type
    link
    Description

    The recording link of the recorded call.

  • Name
    call_created_at
    Type
    timestamp
    Description

    Timestamp of when the message was created.


GET/v2/calls

List all calls

This API endpoint facilitates retrieving a paginated list of your calls. By default, the endpoint displays up to twenty five calls per page, allowing you to efficiently manage and retrieve call data as needed.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Limit the number of calls returned.

Request

GET
/v2/calls
curl --location 'https://v2.callscaler.com/api/all/calls'
--header 'Authorization: Bearer {bearer_token}'

Response

{
   "calls": [
       {
          "uuid": 1,
          "call_to_number": "+12345678910",
          "call_from_number": "+12345678910",
          "call_recording_url": "/user-2/recordings/ivr-0/xyz123-asd3-468d-93f7-1xyz123.wav",
          "call_direction": "inbound",
          "call_transcription_text": "",
          "call_created_at": "2024-07-31 12:59:31"
       },
       {
           "uuid": 2,
           "call_to_number": "+12345678910",
           "call_from_number": "+12345678910",
           "call_recording_url": "/user-2/recordings/outbound-call-value/xyz123-asd3-468d-93f7-1xyz123.wav",
           "call_direction": "outbound",
           "call_transcription_text": "",
           "call_created_at": "2024-07-31 12:59:25"
       },
   ]
}

Was this page helpful?