Skip to main content
GET
Get Click-to-Dial History
Retrieve the click-to-dial call history for your workspace, ordered by most recent first. Each entry includes a link to the call recording once the call has completed and the recording has been processed.

API Endpoint

GET /api/v1/global/click-to-dial/history Content-Type: application/json Authentication: Required (Token header: token or api_access_token)

Query Parameters

ParameterTypeRequiredDescription
app_idintegerNoReturn only calls triggered with this app_id
pageintegerNoPage number, starting at 1. Defaults to 1
limitintegerNoNumber of records per page. Defaults to 20

Success Response

Status Code: 200 OK

Response Fields

Call History Entry

FieldTypeDescription
call_idstringUnique identifier of the call, matching the call_id returned by the trigger endpoint
created_datestringTimestamp when the call was triggered (YYYY-MM-DD HH:mm:ss)
recordingstring | nullURL of the call recording, or null if not yet available
caller_numberstringThe agent’s own phone number (user_number at trigger time)
callee_numberstringThe customer number that was dialled (client_number at trigger time)
display_numberstringThe DID shown to the customer as the caller ID (did_number at trigger time)

Pagination

FieldTypeDescription
pageintegerCurrent page number
limitintegerRecords per page
totalintegerTotal number of call records
total_pagesintegerTotal number of pages

Error Responses

All errors are returned in a common envelope. Always check the error field of the response body.

401 Unauthorized

Example Requests

Get call history (paginated)

Filter by app

Important Notes

Call Recordings

  • The recording field is null while a call is still in progress or if no recording was captured
  • Poll this endpoint after the call ends to fetch the recording URL

Pagination

  • Results are ordered by most recent first
  • Use page and limit to page through results; pagination.total_pages tells you how many pages are available

Headers

token
string
required

API token for authentication

Query Parameters

app_id
integer

Return only calls triggered with this app_id

page
integer
default:1

Page number, starting at 1

limit
integer
default:20

Number of records per page

Response

Call history retrieved successfully

data
object[]
pagination
object