Skip to main content
GET
/
messaging
/
rcs
/
agents
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const agents = await client.messaging.rcs.agents.list();

console.log(agents.data);
{
  "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": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
object

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

Response

Successful reponse with the list of RCS agents

data
object[]
meta
object