Sign in

v1

latestOpenAPI 3.0.02026-07-244771176.5 KB
RCS

Send RCS message

This endpoint is in beta and may change in future versions. Sends an RCS message to a single recipient.

post/v2/rcs/messages

Request body

senderstring required

The RCS agent ID assigned to your registered agent.

Unlike SMS, WhatsApp, and MMS, RCS messages do not come from a phone number. They are always sent through an agent.

  • Must be a registered RCS agent identifier.
  • Example: DemoSender
  • Can be alphanumeric or numeric.
recipientstring phone required

The destination number for delivery. Can be either in local format or in international format. For international format, it should follow the E.164 standard.

Examples of conversions to E.164 format:

  • Australia: 0438 333 061 → 61438333061
  • UK: 07123 456 789 → 447123456789
content_type'text' required

Type of the message content (currently only text supported).

message_refstring

A reference supplied by your system. Maximum length of 500 characters.

This reference is included in webhook events so you can relate events with the original message.

For example, being able to relate a Link Hit event to a specific sent message.

Example request

{
  "sender": "DemoSender",
  "recipient": "447903749662",
  "content_type": "text",
  "content": {
    "text": {
      "message": "Hi Michael,\nJust a quick reminder. You are amazing!!\nReply STOP to opt out."
    }
  },
  "message_ref": "order-12345"
}

Response

OK

requestobject

Optional metadata (e.g. requestId, traceId)

metaobject

Optional pagination, feature flags, etc.

Example response

{
  "data": {
    "id": "6fdae71c-dad7-4c36-9734-a69693ecf3b4",
    "message_ref": "order-12345",
    "sender": "DemoSender",
    "recipient": "447903749662",
    "content_type": "text",
    "content": {
      "text": {
        "message": "Hi Michael,\nJust a quick reminder. You are amazing!!\nReply STOP to opt out."
      }
    },
    "created_at": "2021-01-01T00:00:00Z"
  }
}