SEsentdm
Voice

List calls

Changed on

Retrieves a paginated list of your calls, most recent first. Filter by direction, status, the owning number, the mode (inapp, or agent for calls your voice agents answered), the agent that answered, and the time the call started (from and to are inclusive). Each call carries the phone number it was connected to, the caller id it showed, and the billed legs with what each cost. Use the call webhooks for real-time updates; this list is for looking calls up afterwards.

get/v3/voice/calls

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/voice/calls
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

pageinteger required

Page number (1-indexed)

page_sizeinteger required

Number of items per page

directionstring nullable

Optional direction filter: outbound for calls placed from your app, inbound for calls to one of your numbers

statusstring nullable

Optional status filter: initiated, ringing, answered, completed, failed, no_answer or rejected

numberstring nullable

Optional filter on the number that owns the call, one of your voice-enabled numbers in E.164 format

modestring nullable

Optional mode filter: inapp for calls routed by your number's callback URL, agent for calls one of your voice agents answered

agent_idstring nullable

Optional filter on the voice agent that answered the call, such as agent_9f2ab000-0000-4000-8000-000000000001

fromstring date-time nullable

Only calls started at or after this time (ISO 8601)

tostring date-time nullable

Only calls started at or before this time (ISO 8601)

Headers

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Response

Calls retrieved successfully

successboolean

Indicates whether the request was successful

Changes

  • 41acb2ceb84dRevision changes
    • info

      added the new optional query request parameter agent_id

    • info

      added the new optional query request parameter mode

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

  • 1a451bbb5736Revision changes
    • info

      endpoint added