TEteam-telnyx
RCS

Generate RCS deeplink

Changed on

Generate a deeplink URL that can be used to start an RCS conversation with a specific agent.

get/messages/rcs/deeplinks/{agent_id}

Request

Path parameters

agent_idstring required

RCS agent ID

Query parameters

phone_numberstring

Phone number in E164 format (URL encoded)

bodystring

Pre-filled message body (URL encoded)

Response

Successful response with deeplink URL

Example response

{
  "data": {
    "url": "sms:+18445550001?service_id=my_agent_id%40rbm.goog&body=hello%20world"
  }
}

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