SIsinch
Events

Get an event

Get event from ID

get/v1/projects/{project_id}/events/{event_id}

Request

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

Response

A successful response.

conversation_idstring

Optional. The ID of the event's conversation. Will not be present for apps in Dispatch Mode.

contact_idstring

Optional. The ID of the contact. Will not be present for apps in Dispatch Mode.

accept_timestring date-time

The processed time of the message in UTC timezone. Must be less than current_time and greater than (current_time - 30 days).

processing_mode'CONVERSATION' | 'DISPATCH' required

Whether or not Conversation API should store contacts and conversations for the app. For more information, see Processing Modes.

direction'TO_APP' | 'TO_CONTACT'

The direction of the message flow, indicating whether the message was sent to or from the Conversation API app.

idstring required

The ID of the event.

Example response

{
  "channel_identity": {
    "channel": "WHATSAPP"
  }
}

Changes

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