API Reference

Send an RCS event

post
https://rbm.us.vibes.com/connectCustomers//agentEvents/

Sends an event from a Vibes customer RBM agent to a user.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your unique customer key.

string
required

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

Query Params
string
required

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

string

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.

Body Params

Agent event to send.

string
enum
required

Indicates the category of agent event being sent.

Allowed:
string

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

Responses

Updated 6 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago