Download OpenAPI specification:Download

Event

The Events endpoint enables the Agent to emulate real human behavior by sending read notifications and composing events to the end user.

Send an Event

Send events to a user from the gent.

This enables the agent to emulate human behavior by sending read notifications and composing events.

Request
Security:
BearerAuth
path Parameters
sender-id
required
string (SenderId)

The Sender ID.

Example: AbcdEFGhijKlmnoP
Request Body schema: application/json

Event to be sent to user

event_id
required
string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89...

Globally unique event ID

required
AgentComposingEvent (object) or AgentReadEvent (object)
to
string <MSISDN> [ 9 .. 17 ] characters ^(?:00|\+|)[1-9][0-9]{8,16}$

Phone number of the recipient

Responses
200

Event sent successfully

502

Failed to send event, please retry

post/{sender-id}/events
Request samples
application/json
{
  • "to": "46732001122",
  • "event_id": "9cd91120-5e54-4d42-af22-1a042as22ad97",
  • "event": {
    • "type": "agent_composing"
    }
}