Invite a test number to an RCS agent

PUT 
/messaging/rcs/test_number_invite/:id/:phone_number

Adds a test phone number to an RCS agent for testing purposes.

Path Parameters

id stringrequired

RCS agent ID

phone_number stringrequired

Phone number in E164 format to invite for testing

200: Test number successfully invited to RCS agent

application/json

• Schema
• Example (from schema)

Schema

data

object

required

record_type string

Possible values: [rcs.test_number_invite]

Identifies the type of the resource

agent_id string

RCS agent ID

phone_number string

Phone number that was invited for testing

status string

Status of the test number invitation

{
  "data": {
    "record_type": "rcs.test_number_invite",
    "agent_id": "TestAgent",
    "phone_number": "+13125551234",
    "status": "PENDING"
  }
}

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 -X PUT 'https://api.telnyx.com/v2/messaging/rcs/test_number_invite/:id/:phone_number' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": {
    "record_type": "rcs.test_number_invite",
    "agent_id": "TestAgent",
    "phone_number": "+13125551234",
    "status": "PENDING"
  }
}

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