Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update to GIT-13-6531f8b

...

  • build: BuildInfo (optional) - Info about how Asterisk was built
  • config: ConfigInfo (optional) - Info about Asterisk configuration
  • status: StatusInfo (optional) - Info about Asterisk status
  • system: SystemInfo (optional) - Info about the system running Asterisk

AsteriskPing

Asterisk ping information

Code Block
languagejavascript
collapsetrue

{
  "properties": {
    "timestamp": {
      "required": true,
      "type": "string",
      "description": "The timestamp string of request received time"
    },
    "ping": {
      "required": true,
      "type": "string",
      "description": "Always string value is pong"
    },
    "asterisk_id": {
      "required": true,
      "type": "string",
      "description": "Asterisk id info"
    }
  },
  "id": "AsteriskPing",
  "description": "Asterisk ping information"
}
  • asterisk_id: string - Asterisk id info
  • ping: string - Always string value is pong
  • timestamp: string - The timestamp string of request received time

BuildInfo

Info about how Asterisk was built

...

Code Block
languagejavascript
collapsetrue
{
  "properties": {
    "priority": {
      "required": true,
      "type": "long",
      "description": "Priority in the dialplan"
    },
    "exten": {
      "required": true,
      "type": "string",
      "description": "Extension in the dialplan"
    },
    "app_data": {
      "required": true,
      "type": "string",
      "description": "Parameter of current dialplan application"
    },
    "app_name": {
      "required": true,
      "type": "string",
      "description": "Name of current dialplan application"
    },
    "context": {
      "required": true,
      "type": "string",
      "description": "Context in the dialplan"
    }
  },
  "id": "DialplanCEP",
  "description": "Dialplan location (context/extension/priority)"
}
  • app_data: string - Parameter of current dialplan application
  • app_name: string - Name of current dialplan application
  • context: string - Context in the dialplan
  • exten: string - Extension in the dialplan
  • priority: long - Priority in the dialplan

RTPstat

A statistics of a RTP.

Code Block
languagejavascript
collapsetrue

{
  "properties": {
    "txjitter": {
      "required": false,
      "type": "double",
      "description": "Jitter on transmitted packets."
    },
    "local_stdevjitter": {
      "required": false,
      "type": "double",
      "description": "Standard deviation jitter on local side."
    },
    "local_minjitter": {
      "required": false,
      "type": "double",
      "description": "Minimum jitter on local side."
    },
    "rxjitter": {
      "required": false,
      "type": "double",
      "description": "Jitter on received packets."
    },
    "rtt": {
      "required": false,
      "type": "double",
      "description": "Total round trip time."
    },
    "stdevrtt": {
      "required": false,
      "type": "double",
      "description": "Standard deviation round trip time."
    },
    "local_maxjitter": {
      "required": false,
      "type": "double",
      "description": "Maximum jitter on local side."
    },
    "maxrtt": {
      "required": false,
      "type": "double",
      "description": "Maximum round trip time."
    },
    "local_normdevrxploss": {
      "required": false,
      "type": "double",
      "description": "Average number of packets lost on local side."
    },
    "remote_minrxploss": {
      "required": false,
      "type": "double",
      "description": "Minimum number of packets lost on remote side."
    },
    "txoctetcount": {
      "required": true,
      "type": "int",
      "description": "Number of octets transmitted."
    },
    "rxoctetcount": {
      "required": true,
      "type": "int",
      "description": "Number of octets received."
    },
    "local_maxrxploss": {
      "required": false,
      "type": "double",
      "description": "Maximum number of packets lost on local side."
    },
    "remote_normdevrxploss": {
      "required": false,
      "type": "double",
      "description": "Average number of packets lost on remote side."
    },
    "local_stdevrxploss": {
      "required": false,
      "type": "double",
      "description": "Standard deviation packets lost on local side."
    },
    "remote_stdevjitter": {
      "required": false,
      "type": "double",
      "description": "Standard deviation jitter on remote side."
    },
    "local_normdevjitter": {
      "required": false,
      "type": "double",
      "description": "Average jitter on local side."
    },
    "txploss": {
      "required": true,
      "type": "int",
      "description": "Number of transmitted packets lost."
    },
    "remote_stdevrxploss": {
      "required": false,
      "type": "double",
      "description": "Standard deviation packets lost on remote side."
    },
    "remote_maxrxploss": {
      "required": false,
      "type": "double",
      "description": "Maximum number of packets lost on remote side."
    },
    "txcount": {
      "required": true,
      "type": "int",
      "description": "Number of packets transmitted."
    },
    "remote_minjitter": {
      "required": false,
      "type": "double",
      "description": "Minimum jitter on remote side."
    },
    "remote_maxjitter": {
      "required": false,
      "type": "double",
      "description": "Maximum jitter on remote side."
    },
    "remote_ssrc": {
      "required": true,
      "type": "int",
      "description": "Their SSRC."
    },
    "channel_uniqueid": {
      "required": true,
      "type": "string",
      "description": "The Asterisk channel's unique ID that owns this instance."
    },
    "rxcount": {
      "required": true,
      "type": "int",
      "description": "Number of packets received."
    },
    "rxploss": {
      "required": true,
      "type": "int",
      "description": "Number of received packets lost."
    },
    "remote_normdevjitter": {
      "required": false,
      "type": "double",
      "description": "Average jitter on remote side."
    },
    "local_ssrc": {
      "required": true,
      "type": "int",
      "description": "Our SSRC."
    },
    "minrtt": {
      "required": false,
      "type": "double",
      "description": "Minimum round trip time."
    },
    "local_minrxploss": {
      "required": false,
      "type": "double",
      "description": "Minimum number of packets lost on local side."
    },
    "normdevrtt": {
      "required": false,
      "type": "double",
      "description": "Average round trip time."
    }
  },
  "id": "RTPstat",
  "description": "A statistics of a RTP."
}
  • channel_uniqueid: string - The Asterisk channel's unique ID that owns this instance.
  • local_maxjitter: double (optional) - Maximum jitter on local side.
  • local_maxrxploss: double (optional) - Maximum number of packets lost on local side.
  • local_minjitter: double (optional) - Minimum jitter on local side.
  • local_minrxploss: double (optional) - Minimum number of packets lost on local side.
  • local_normdevjitter: double (optional) - Average jitter on local side.
  • local_normdevrxploss: double (optional) - Average number of packets lost on local side.
  • local_ssrc: int - Our SSRC.
  • local_stdevjitter: double (optional) - Standard deviation jitter on local side.
  • local_stdevrxploss: double (optional) - Standard deviation packets lost on local side.
  • maxrtt: double (optional) - Maximum round trip time.
  • minrtt: double (optional) - Minimum round trip time.
  • normdevrtt: double (optional) - Average round trip time.
  • remote_maxjitter: double (optional) - Maximum jitter on remote side.
  • remote_maxrxploss: double (optional) - Maximum number of packets lost on remote side.
  • remote_minjitter: double (optional) - Minimum jitter on remote side.
  • remote_minrxploss: double (optional) - Minimum number of packets lost on remote side.
  • remote_normdevjitter: double (optional) - Average jitter on remote side.
  • remote_normdevrxploss: double (optional) - Average number of packets lost on remote side.
  • remote_ssrc: int - Their SSRC.
  • remote_stdevjitter: double (optional) - Standard deviation jitter on remote side.
  • remote_stdevrxploss: double (optional) - Standard deviation packets lost on remote side.
  • rtt: double (optional) - Total round trip time.
  • rxcount: int - Number of packets received.
  • rxjitter: double (optional) - Jitter on received packets.
  • rxoctetcount: int - Number of octets received.
  • rxploss: int - Number of received packets lost.
  • stdevrtt: double (optional) - Standard deviation round trip time.
  • txcount: int - Number of packets transmitted.
  • txjitter: double (optional) - Jitter on transmitted packets.
  • txoctetcount: int - Number of octets transmitted.
  • txploss: int - Number of transmitted packets lost.

Bridge

The merging of media from one or more channels.

...

Code Block
languagejavascript
collapsetrue
{
  "properties": {
    "bridge_type": {
      "allowableValues": {
        "valueType": "LIST",
        "values": [
          "mixing",
          "holding"
        ]
      },
      "required": true,
      "type": "string",
      "description": "Type of bridge technology"
    },
    "name": {
      "required": true,
      "type": "string",
      "description": "Name the creator gave the bridge"
    },
    "creator": {
      "required": true,
      "type": "string",
      "description": "Entity that created the bridge"
    },
    "video_mode": {
      "required": false,
      "type": "string",
      "description": "The video mode the bridge is using. One of 'none', 'talker', or 'single'."
    },
    "creationtime": {
      "required": true,
      "type": "Date",
      "description": "Timestamp when bridge was created"
    },
    "channels": {
      "required": true,
      "type": "List[string]",
      "description": "Ids of channels participating in this bridge"
    },
    "video_source_id": {
      "required": false,
      "type": "string",
      "description": "The ID of the channel that is the source of video in this bridge, if one exists."
    },
    "bridge_class": {
      "required": true,
      "type": "string",
      "description": "Bridging class"
    },
    "technology": {
      "required": true,
      "type": "string",
      "description": "Name of the current bridging technology"
    },
    "id": {
      "required": true,
      "type": "string",
      "description": "Unique identifier for this bridge"
    }
  },
  "id": "Bridge",
  "description": "The merging of media from one or more channels.\n\nEveryone on the bridge receives the same audio."
}
  • bridge_class: string - Bridging class
  • bridge_type: string - Type of bridge technology
  • channels: List[string] - Ids of channels participating in this bridge
  • creationtime: Date - Timestamp when bridge was created
  • creator: string - Entity that created the bridge
  • id: string - Unique identifier for this bridge
  • name: string - Name the creator gave the bridge
  • technology: string - Name of the current bridging technology
  • video_mode: string (optional) - The video mode the bridge is using. One of 'none', 'talker', or 'single'.
  • video_source_id: string (optional) - The ID of the channel that is the source of video in this bridge, if one exists.

LiveRecording

A recording that is in progress

...

  • name: string - Name of the mailbox.
  • new_messages: int - Count of new messages in the mailbox.
  • old_messages: int - Count of old messages in the mailbox.

ApplicationMoveFailed

Base type: Event

Notification that trying to move a channel to another Stasis application failed.

Code Block
languagejavascript
collapsetrue

{
  "properties": {
    "args": {
      "required": true,
      "type": "List[string]",
      "description": "Arguments to the application"
    },
    "destination": {
      "required": true,
      "type": "string"
    },
    "channel": {
      "required": true,
      "type": "Channel"
    }
  },
  "id": "ApplicationMoveFailed",
  "description": "Notification that trying to move a channel to another Stasis application failed."
}
  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date - Time at which this event was created.
  • args: List[string] - Arguments to the application
  • channel: Channel
  • destination: string

ApplicationReplaced

Base type: Event

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • destination_application: string (optional) - Application that has been transferred into
  • destination_bridge: string (optional) - Bridge that survived the merge result
  • destination_link_first_leg: Channel (optional) - First leg of a link transfer result
  • destination_link_second_leg: Channel (optional) - Second leg of a link transfer result
  • destination_threeway_bridge: Bridge (optional) - Bridge that survived the threeway result
  • destination_threeway_channel: Channel (optional) - Transferer channel that survived the threeway result
  • destination_type: string - How the transfer was accomplished
  • is_external: boolean - Whether the transfer was externally initiated or not
  • replace_channel: Channel (optional) - The channel that is replacing transferer_first_leg in the swap
  • result: string - The result of the transfer attempt
  • transfer_target: Channel (optional) - The channel that is being transferred to
  • transferee: Channel (optional) - The channel that is being transferred
  • transferer_first_leg: Channel - First leg of the transferer
  • transferer_first_leg_bridge: Bridge (optional) - Bridge the transferer first leg is in
  • transferer_second_leg: Channel - Second leg of the transferer
  • transferer_second_leg_bridge: Bridge (optional) - Bridge the transferer second leg is in

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • bridge: Bridge (optional) - The bridge being transferred
  • channel: Channel - The channel performing the blind transfer
  • context: string - The context transferred to
  • exten: string - The extension transferred to
  • is_external: boolean - Whether the transfer was externally initiated or not
  • replace_channel: Channel (optional) - The channel that is replacing transferer when the transferee(s) can not be transferred directly
  • result: string - The result of the transfer attempt
  • transferee: Channel (optional) - The channel that is being transferred

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • bridge: Bridge

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • bridge: Bridge

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • bridge: Bridge
  • bridge_from: Bridge

BridgeVideoSourceChanged

Base type: Event

Notification that the source of video in a bridge has changed.

Code Block
languagejavascript
collapsetrue

{
  "properties": {
    "old_video_source_id": {
      "required": false,
      "type": "string"
    },
    "bridge": {
      "required": true,
      "type": "Bridge"
    }
  },
  "id": "BridgeVideoSourceChanged",
  "description": "Notification that the source of video in a bridge has changed."
}
  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date - Time at which this event was created.
  • bridge: Bridge
  • old_video_source_id: string (optional)

ChannelCallerId

Base type: Event

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • caller_presentation: int - The integer representation of the Caller Presentation value.
  • caller_presentation_txt: string - The text representation of the Caller Presentation value.
  • channel: Channel - The channel that changed Caller ID.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel - The channel whose connected line has changed.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • cause: int - Integer representation of the cause of the hangup
  • cause_txt: string - Text representation of the cause of the hangup
  • channel: Channel

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel - The channel that changed dialplan location.
  • dialplan_app: string - The application about to be executed.
  • dialplan_app_data: string - The data to be passed to the application.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel - The channel on which DTMF was received
  • digit: string - DTMF digit received (0-9, A-E, # or *)
  • duration_ms: int - Number of milliseconds DTMF was received

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • bridge: Bridge
  • channel: Channel (optional)

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • cause: int (optional) - Integer representation of the cause of the hangup.
  • channel: Channel - The channel on which the hangup was requested.
  • soft: boolean (optional) - Whether the hangup request was a soft hangup request.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel - The channel that initiated the hold event.
  • musicclass: string (optional) - The music on hold class that the initiator requested.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • bridge: Bridge
  • channel: Channel

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel - The channel on which talking completed.
  • duration: int - The length of time, in milliseconds, that talking was detected on the channel

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel - The channel on which talking started.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel - The channel that initiated the unhold event.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • bridge: Bridge (optional) - A bridge that is signaled with the user event.
  • channel: Channel (optional) - A channel that is signaled with the user event.
  • endpoint: Endpoint (optional) - A endpoint that is signaled with the user event.
  • eventname: string - The name of the user event.
  • userevent: object - Custom Userevent data

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel (optional) - The channel on which the variable was set.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • contact_info: ContactInfo
  • endpoint: Endpoint

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • device_state: DeviceState - Device state object

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • caller: Channel (optional) - The calling channel.
  • dialstatus: string - Current status of the dialing attempt to the peer.
  • dialstring: string (optional) - The dial string for calling the peer channel.
  • forward: string (optional) - Forwarding target requested by the original dialed channel.
  • forwarded: Channel (optional) - Channel that the caller has been forwarded to.
  • peer: Channel - The dialed channel.

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • endpoint: Endpoint

...

Base type: Message
Subtypes: ApplicationMoveFailed ApplicationReplaced BridgeAttendedTransfer BridgeBlindTransfer BridgeCreated BridgeDestroyed BridgeMerged BridgeVideoSourceChanged ChannelCallerId ChannelConnectedLine ChannelCreated ChannelDestroyed ChannelDialplan ChannelDtmfReceived ChannelEnteredBridge ChannelHangupRequest ChannelHold ChannelLeftBridge ChannelStateChange ChannelTalkingFinished ChannelTalkingStarted ChannelUnhold ChannelUserevent ChannelVarset ContactStatusChange DeviceStateChanged Dial EndpointStateChange PeerStatusChange PlaybackFinished PlaybackStarted RecordingFailed RecordingFinished RecordingStarted StasisEnd StasisStart TextMessageReceived

...

Code Block
languagejavascript
collapsetrue
{
  "subTypes": [
    "DeviceStateChanged",
    "PlaybackStarted",
    "PlaybackFinished",
    "RecordingStarted",
    "RecordingFinished",
    "RecordingFailed",
    "ApplicationMoveFailed",
    "ApplicationReplaced",
    "BridgeCreated",
    "BridgeDestroyed",
    "BridgeMerged",
    "BridgeBlindTransfer",
    "BridgeAttendedTransfer",
    "BridgeVideoSourceChanged",
    "ChannelCreated",
    "ChannelDestroyed",
    "ChannelEnteredBridge",
    "ChannelLeftBridge",
    "ChannelStateChange",
    "ChannelDtmfReceived",
    "ChannelDialplan",
    "ChannelCallerId",
    "ChannelUserevent",
    "ChannelHangupRequest",
    "ChannelVarset",
    "ChannelTalkingStarted",
    "ChannelTalkingFinished",
    "ChannelHold",
    "ChannelUnhold",
    "ContactStatusChange",
    "EndpointStateChange",
    "Dial",
    "StasisEnd",
    "StasisStart",
    "TextMessageReceived",
    "ChannelConnectedLine",
    "PeerStatusChange"
  ],
  "properties": {
    "application": {
      "required": true,
      "type": "string",
      "description": "Name of the application receiving the event."
    },
    "timestamp": {
      "required": falsetrue,
      "type": "Date",
      "description": "Time at which this event was created."
    }
  },
  "id": "Event",
  "description": "Base type for asynchronous events from Asterisk."
}
  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.

Message

Subtypes: ApplicationMoveFailed ApplicationReplaced BridgeAttendedTransfer BridgeBlindTransfer BridgeCreated BridgeDestroyed BridgeMerged BridgeVideoSourceChanged ChannelCallerId ChannelConnectedLine ChannelCreated ChannelDestroyed ChannelDialplan ChannelDtmfReceived ChannelEnteredBridge ChannelHangupRequest ChannelHold ChannelLeftBridge ChannelStateChange ChannelTalkingFinished ChannelTalkingStarted ChannelUnhold ChannelUserevent ChannelVarset ContactStatusChange DeviceStateChanged Dial EndpointStateChange Event MissingParams PeerStatusChange PlaybackFinished PlaybackStarted RecordingFailed RecordingFinished RecordingStarted StasisEnd StasisStart TextMessageReceived

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • endpoint: Endpoint
  • peer: Peer

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • playback: Playback - Playback control object

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • playback: Playback - Playback control object

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • recording: LiveRecording - Recording control object

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • recording: LiveRecording - Recording control object

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • recording: LiveRecording - Recording control object

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • channel: Channel

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • args: List[string] - Arguments to the application
  • channel: Channel
  • replace_channel: Channel (optional)

...

  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.
  • endpoint: Endpoint (optional)
  • message: TextMessage

...

Code Block
languagejavascript
collapsetrue
{
  "properties": {
    "name": {
      "required": true,
      "type": "string",
      "description": "Name of this application"
    },
    "endpoint_ids": {
      "required": true,
      "type": "List[string]",
      "description": "{tech}/{resource} for endpoints subscribed to."
    },
    "channel_ids": {
      "required": true,
      "type": "List[string]",
      "description": "Id's for channels subscribed to."
    },
    "bridgedevice_idsnames": {
      "required": true,
      "type": "List[string]",
      "description": "Id'sNames forof bridgesthe devices subscribed to."
    },
    "deviceevents_namesdisallowed": {
      "required": true,
      "type": "List[stringobject]",
      "description": "NamesEvent of types not sent to the devices application."
    },
    "bridge_ids": {
      "required": true,
      "type": "List[string]",
      "description": "Id's for bridges subscribed to."
    },
    "nameevents_allowed": {
      "required": true,
      "type": "stringList[object]",
      "description": "NameEvent oftypes thissent to the application."
    }
  },
  "id": "Application",
  "description": "Details of a Stasis application"
}
  • bridge_ids: List[string] - Id's for bridges subscribed to.
  • channel_ids: List[string] - Id's for channels subscribed to.
  • device_names: List[string] - Names of the devices subscribed to.
  • endpoint_ids: List[string] - {tech}/{resource} for endpoints subscribed to.
  • events_allowed: List[object] - Event types sent to the application.
  • events_disallowed: List[object] - Event types not sent to the application.
  • name: string - Name of this application