Calls

The features in this section allows to query and manage active calls.

Call Details

Returning details of a specific call along with it’s call legs, price and a list of events that happened during the call.

Request

GET https://api.telzio.com/calls/details/{CallUUID}

Path Parameters

Parameter Type Description
CallUUID string The CallUUID of the call you wish to retrieve details for.

Response

{
  "CallUUID": string,
  "Status": string,
  "Direction": string,
  "From": string,
  "FromCnam": string,
  "To": string,
  "HangupCause": string,
  "SpamScore": string,
  "SpamAction": string,
  "BlacklistRejected": boolean,
  "Started": string,
  "Duration": string,
  "BilledDuration": string,
  "TotalPrice": number,
  "TotalFreeMinutes": string,
  "Tags": [
    string
  ],
  "Legs": [
    {
      "CallUUID": string,
      "Status": string,
      "To": string,
      "Started": string,
      "Duration": string,
      "BilledDuration": string,
      "HangupCause": string,
      "Price": number,
      "Rate": number,
      "FreeMinutes": string
    }
  ],
  "Events": [
    {
      "Time": string,
      "Text": string
    }
  ]
}

Call Log

Returning a list of calls from your call log. You can filter these to only show a specific phone number. Newest calls are presented first. A maximum of 20 calls are returned, but paging can be utilized with the Offset parameter.

Request

GET https://api.telzio.com/calls/log

Path Parameters

Parameter Type Description
FromDate date Filters all calls from this date. Example: 2023-11-01
ToDate date Filters all calls up to this date. Example: 2017-05-01
Direction string Can be either inbound or outbound.
Number int[] Filters the list based on a specific phone numbers in your account. Must be written with the country code but without “+”. Example: 18889989080. This parameter can be specified several times to filter on multiple numbers
Offset int Requests the list starting from the offset value.
MaxResults int Sets the max number of results to return per page. Defaults to 20.
WasMissed boolean Only show missed calls
Tag string Filter search to calls with any of these tags. This parameter can be specified multiple

Live Calls

Returning a list of live calls on your account. All with CallUUIDs which can be used to query more details about the specific call.

Request

GET https://api.telzio.com/calls/live

Response

{
  "LiveCalls": [
    {
      "CallUUID": string,
      "Status": string,
      "Direction": string,
      "From": string,
      "To": string,
      "Started": string,
      "Duration": string
    }
  ]
}

Hang Up Call

This request hangs up a specific call.

Request

POST https://api.telzio.com/calls/{CallUUID}/hangup

Path Parameters

Parameter Type Description
CallUUID string The CallUUID of the call you want to hang up.

Transfer Call

Transfer an existing call to another user/extension or external phone number

Request

POST https://api.telzio.com/calls/{CallUUID}/transfer

Path Parameters

Parameter Type Description
CallUUID string The Call ID of the call you want to transfer

Body Parameters

Parameter Type Description
Destination string The extension or E164 number you want to transfer the call to.