RCS

List all RCS agents

Changed on

Returns RCS agents available to the authenticated account.

get/messaging/rcs/agents

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/messaging/rcs/agents
  • Auth: HTTP bearer

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

Successful reponse with the list of RCS agents

Example response

{
  "data": [
    {
      "agent_id": "TestAgent",
      "user_id": "2ecf295b-36c6-4d43-ad05-71eb1e560518",
      "profile_id": "4001932a-b8a3-42fc-9389-021be6388909",
      "webhook_url": "http://example.com",
      "webhook_failover_url": "http://example.com",
      "agent_name": "Test Agent",
      "enabled": true,
      "created_at": "2024-01-01T12:00:00.000Z",
      "updated_at": "2024-01-01T12:00:00.000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 1571b0380bd7Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

  • 8f5f4e537994Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status