TeXML REST Commands

Fetch a queue resource

Returns a single queue resource for the account by its QueueSid.

get/texml/Accounts/{account_sid}/Queues/{queue_sid}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Queues/{queue_sid}
  • 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.

queue_sidstring required

The QueueSid that identifies the call queue.

Response

Queue resource.

account_sidstring

The id of the account the resource belongs to.

average_wait_timeinteger

The average wait time in seconds for members in the queue.

current_sizeinteger

The current number of members in the queue.

date_createdstring

The timestamp of when the resource was created.

date_updatedstring

The timestamp of when the resource was last updated.

max_sizeinteger

The maximum size of the queue.

sidstring

The unique identifier of the queue.

uristring

The relative URI for this queue.

subresource_urisobject

A list of related resources identified by their relative URIs.

Example response

{
  "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
  "average_wait_time": 30,
  "current_size": 3,
  "date_created": "Fri, 27 Oct 2023 07:41:58 +0000",
  "date_updated": "Fri, 27 Oct 2023 07:41:58 +0000",
  "max_size": 10,
  "sid": "my-queue",
  "uri": "/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Queues/my-queue.json",
  "subresource_uris": {
    "members": "/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Queues/my-queue/Members.json"
  }
}

Changes

No operation changes recorded.