Sign in

v1

latestOpenAPI 3.1.02026-07-2693628.3 KB
RCS Business Messaging

Send an RCS event

Sends an event from a Vibes customer RBM agent to a user. <br><br> Agent events include read receipts or "typing" notifications. If Vibes RBM can't reach the user, the Vibes RBM platform returns 404 NOT_FOUND. Unlike agent messages, agent events cannot be revoked after sending.

post/{connect_customer_key}/agentEvents/{msisdn}

Path parameters

connect_customer_keystring required

Your unique customer key.

msisdnstring required

Target device's phone number in E.164 format.

Query parameters

agentIdstring required

Alphanumeric string identifying your agent. To get your agentId, speak to your Vibes business rep.

eventIdstring

An alphanumeric string identifying the event. You can set this to whatever you like, but if it is left blank, it will be filled in by the system.

Request body

namestring

Do not set this field. It will be populated by the API when the operation returns.

eventType'TYPE_UNSPECIFIED' | 'IS_TYPING' | 'READ' required
messageIdstring

If you are sending a read receipt event, the alphanumeric identifier of the message the read receipt is associated with.

sendTimestring

Do not set this field. It will be populated by the API when the operation returns.

Response

The request has succeeded.

namestring

Do not set this field. It will be populated by the API when the operation returns.

eventType'TYPE_UNSPECIFIED' | 'IS_TYPING' | 'READ' required
messageIdstring

If you are sending a read receipt event, the alphanumeric identifier of the message the read receipt is associated with.

sendTimestring

Do not set this field. It will be populated by the API when the operation returns.