SIsinch
Events

Send an event

Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queue so a successful response only indicates that the event has been queued.

post/v1/projects/{project_id}/events:send

Request

  • Base URL
    https://us.conversation.api.sinch.com
  • URL
    https://us.conversation.api.sinch.com/v1/projects/{project_id}/events:send
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Request body

app_idstring required

The ID of the app sending the event.

callback_urlstring

Overwrites the default callback url for delivery receipts for this message The REST URL should be of the form: http://host[:port]/path

channel_priority_orderConversationChannel[]

Optional. A single element array that dictates on what channel should the Conversation API try to send the event. It overrides any default set on the contact. Providing more than one option has no effect.

event_metadatastring

Optional. Eventual metadata that should be associated to the event.

queue'NORMAL_PRIORITY' | 'HIGH_PRIORITY'

Select the priority type for the message

Example request

{
  "channel_priority_order": [
    "WHATSAPP"
  ],
  "queue": "NORMAL_PRIORITY",
  "recipient": {
    "identified_by": {
      "channel_identities": [
        {
          "channel": "WHATSAPP"
        }
      ]
    }
  }
}

Response

A successful response.

accepted_timestring date-time

Accepted timestamp.

event_idstring

Event id.

Changes

No recorded changes to this operation across all 3 revisions of this API.