Message Format

Overview

This page will show you the current message formats in use by the go-ari-proxy. These message formats are not yet versioned, and are likely to be modified, extended, retracted, or additional messages added in the future. The format is not yet standardized.

The message formats are used for starting new dialogs, sending events, sending commands, and then sending the response to the command across the wire. These standard messages encapsulate all the ARI messages, commands and command responses. By doing it this way, neither the proxy or the client need to directly understand the messages being sent across the wire, until they decide to drill down and extract the data.

Messages are formatted in JSON.

Event

Event struct contains the events we pull off the websocket connection.

{
  "server_id": string
  "timestamp": Time.time,
  "type": string,
  "ari_body": string
}

AppStart

AppStart struct contains the initial information for the start of a new application instance. It is used to instantiate a new dialog.

{
  "application": string,
  "dialog_id": string,
  "server_id": string
}

Command

Command struct contains the command we're passing back to ARI.

{
  "unique_id": string,
  "url": string,
  "method": string,
  "body": string
}

CommandResponse

CommandResponse struct contains the response to a Command

{
  "unique_id": string,
  "status_code": integer,
  "response_body": string
}