Send a Plain Text Message with URL

The Send a Plain Text Message with URL API request allows you to send a plain-text message that includes a clickable URL. It is useful for sharing links to websites, documents, or resources directly within the message body. The message is delivered as simple text, but the URL is rendered as an actionable hyperlink in supported channels.

• You must have an approved AgentID or a specific number to be used as AgentID.

API request to send a Plain Text Message with URL

To send a plain text message with a URL, use the https://rcs-api.<pod>.kaleyra.ai/v1/<sid>/rcs/messages endpoint with the following request method:

The following is the request format to send a plain text message with a URL:

curl --location --request POST 'https://<api_domain>/v1/<sid>/rcs/messages'\
--header 'Content-Type:<Content-Type>' \
--header 'api-key: <api-key>' \
--data  {
  "from": "<from>",           
  "to": ["to"],           
  "text": "<text>"           
  } 

The following is the sample request format to send a plain text message with a URL:

curl --location --request POST 'https://rcs-api.na.kaleyra.ai/v1/xxxxx6913850xxxx/rcs/messages'\
--header 'Content-Type: application/json' \ 
--header 'api-key: xxxxx3b8497f58a94e84b671aca43xxxx' \ 
--data { 
  	"from":"rcs-test", 
   "to":["9191588XXXXX"], 
   "text": "Check out our latest offers: https://example.com/deals"
  }

Following is the list of attributes to be used in the payload to send the messages:

{
  "recipientDetails": [
    {
      "to": "9191588XXXXX",
      "messageId": "dc4cxxxx-xxxx-xxxx-xxxx-xxxx349a5e3d "
    }
  ]
}

{
    "status": "ERROR",
    "errorText": "Error Message"
}