Retrieve an RCS agent

GET 
/rcs_agents/:id

Retrieve an RCS agent

Path Parameters

id stringrequired

RCS agent ID

200: Successful response with the RCS agent

application/json

• Schema
• Example (from schema)

Schema

data

object

agent_id string

RCS Agent ID

user_id string

User ID associated with the RCS Agent

profile_id uuidnullable

Messaging profile ID associated with the RCS Agent

webhook_url urlnullable

URL to receive RCS events

webhook_failover_url urlnullable

Failover URL to receive RCS events

agent_name string

Human readable agent name

enabled boolean

Specifies whether the agent is enabled

created_at date-time

Date and time when the resource was created

updated_at date-time

Date and time when the resource was updated

{
  "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"
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/rcs_agents/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "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"
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}