RCS

Add RCS test number

Changed on

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

put/messaging/rcs/test_number_invite/{id}/{phone_number}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/messaging/rcs/test_number_invite/{id}/{phone_number}
  • Auth: HTTP bearer

Path parameters

idstring required

RCS agent ID

phone_numberstring required

Phone number in E164 format to invite for testing

Response

Test number successfully invited to RCS agent

Example response

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

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