Generate RCS deeplink

GET 
/messages/rcs/deeplinks/:agent_id

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

Path Parameters

agent_id stringrequired

RCS agent ID

Query Parameters

phone_number string
Phone number in E164 format (URL encoded)
Example: %2B18445550001
body string
Pre-filled message body (URL encoded)
Example: hello%20world

200: Successful response with deeplink URL

application/json

• Schema
• Example (from schema)

Schema

data

object

required

url stringrequired

The generated deeplink URL

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

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/messages/rcs/deeplinks/:agent_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

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

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