List RCS capabilities of a given batch of phone numbers

POST 
/messaging/rcs/bulk_capabilities

List RCS capabilities of a given batch of phone numbers

application/json

Body

agent_id stringrequired

RCS Agent ID

phone_numbers string[]required

List of phone numbers to check

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type string

Possible values: [rcs.capabilities]

Identifies the type of the resource

phone_number string

Phone number

agent_id string

RCS agent ID

agent_name string

RCS agent name

features string[]

List of RCS capabilities

]

{
  "data": [
    {
      "record_type": "rcs.capabilities",
      "phone_number": "+13125551234",
      "agent_id": "TestAgent",
      "agent_name": "Testing agent",
      "features": [
        "string"
      ]
    }
  ]
}

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/messaging/rcs/bulk_capabilities' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "agent_id": "TestAgent",
  "phone_numbers": [
    "+13125551234"
  ]
}'

Response samples

• 200
• default

---

{
  "data": [
    {
      "record_type": "rcs.capabilities",
      "phone_number": "+13125551234",
      "agent_id": "TestAgent",
      "agent_name": "Testing agent",
      "features": [
        "string"
      ]
    }
  ]
}

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