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.
project_id required | string The unique ID of the project. You can find this on the Sinch Dashboard. |
The event to be sent.
app_id required | string The ID of the app sending the event. |
required | contact_id (object) or identified_by (object) The recipient of the event. Requires either |
required | composing_event (object) or composing_end_event (object) or comment_reply_event (object) or agent_joined_event (object) or agent_left_event (object) or generic_event (object) (AppEvent) |
callback_url | string Overwrites the default callback url for delivery receipts for this message
The REST URL should be of the form: |
channel_priority_order | Array of strings (Channel Identifier) 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_metadata | string Optional. Eventual metadata that should be associated to the event. |
queue | string (MessageQueue) Select the priority type for the message |
A successful response.
Malformed request
Incorrect credentials
Correct credentials but you don't have access to the requested resource
Correct credentials but you don't have access to the requested resource
Something went wrong on our end, try again with exponential back-off
{- "app_id": "string",
- "event": { },
- "recipient": {
- "contact_id": "{CONTACT_ID}"
}
}
{- "accepted_time": "2019-08-24T14:15:22Z",
- "event_id": "string"
}