TeXML REST Commands

Fetch multiple call resources

Changed on

Returns multiple call resouces for an account. This endpoint is eventually consistent.

get/texml/Accounts/{account_sid}/Calls

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Calls
  • Auth: HTTP bearer

Path parameters

account_sidstring required
Example:f5586561-8ff0-4291-a51b-c7dfe4139ff9

The UUID of the Telnyx account that owns the resource, for example f5586561-8ff0-4291-a51b-c7dfe4139ff9. The account_sid path segment is kept for Twilio API compatibility, but the value is a Telnyx account UUID, not a Twilio AC... SID. It must match the account that owns the API key used to authenticate the request, otherwise the endpoint returns 404. The same value is sent as AccountSid in TeXML webhooks.

Query parameters

Pageinteger

The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken.

PageSizeinteger

The number of records to be displayed on a page

PageTokenstring

Used to request the next page of results.

Tostring

Filters calls by the to number.

Fromstring

Filters calls by the from number.

Status'canceled' | 'completed' | 'failed' | 'busy' | 'no-answer'

Filters calls by status.

StartTimestring

Filters calls by their start date. Expected format is YYYY-MM-DD.

StartTime>string

Filters calls by their start date (after). Expected format is YYYY-MM-DD

StartTime<string

Filters calls by their start date (before). Expected format is YYYY-MM-DD

EndTimestring

Filters calls by their end date. Expected format is YYYY-MM-DD

EndTime>string

Filters calls by their end date (after). Expected format is YYYY-MM-DD

EndTime<string

Filters calls by their end date (before). Expected format is YYYY-MM-DD

Response

Multiple call resources.

endinteger

The number of the last element on the page, zero-indexed.

first_page_uristring

/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1

next_page_uristring

/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ

pageinteger

Current page number, zero-indexed.

page_sizeinteger

The number of items on the page

startinteger

The number of the first element on the page, zero-indexed.

uristring

The URI of the current page.

Example response

{
  "calls": [],
  "end": 0,
  "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1",
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ",
  "page": 0,
  "page_size": 1,
  "start": 0,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1"
}

Changes

  • eaa5a559addfRevision changes
    • warning

      deleted the query request parameter EndTime_gt

    • warning

      deleted the query request parameter EndTime_lt

    • warning

      deleted the query request parameter StartTime_gt

    • warning

      deleted the query request parameter StartTime_lt

    • info

      added the new optional query request parameter EndTime<

    • info

      added the new optional query request parameter EndTime>

    • info

      added the new optional query request parameter StartTime<

    • info

      added the new optional query request parameter StartTime>