Created by Wiki Bot, last modified on Oct 22, 2019
AsteriskInfo
Asterisk system information
{
"properties": {
"status": {
"required": false,
"type": "StatusInfo",
"description": "Info about Asterisk status"
},
"config": {
"required": false,
"type": "ConfigInfo",
"description": "Info about Asterisk configuration"
},
"build": {
"required": false,
"type": "BuildInfo",
"description": "Info about how Asterisk was built"
},
"system": {
"required": false,
"type": "SystemInfo",
"description": "Info about the system running Asterisk"
}
},
"id": "AsteriskInfo",
"description": "Asterisk system information"
}
- 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
{
"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
{
"properties": {
"kernel": {
"required": true,
"type": "string",
"description": "Kernel version Asterisk was built on."
},
"machine": {
"required": true,
"type": "string",
"description": "Machine architecture (x86_64, i686, ppc, etc.)"
},
"user": {
"required": true,
"type": "string",
"description": "Username that build Asterisk"
},
"date": {
"required": true,
"type": "string",
"description": "Date and time when Asterisk was built."
},
"os": {
"required": true,
"type": "string",
"description": "OS Asterisk was built on."
},
"options": {
"required": true,
"type": "string",
"description": "Compile time options, or empty string if default."
}
},
"id": "BuildInfo",
"description": "Info about how Asterisk was built"
}
- date: string - Date and time when Asterisk was built.
- kernel: string - Kernel version Asterisk was built on.
- machine: string - Machine architecture (x86_64, i686, ppc, etc.)
- options: string - Compile time options, or empty string if default.
- os: string - OS Asterisk was built on.
- user: string - Username that build Asterisk
ConfigInfo
Info about Asterisk configuration
{
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Asterisk system name."
},
"default_language": {
"required": true,
"type": "string",
"description": "Default language for media playback."
},
"max_load": {
"required": false,
"type": "double",
"description": "Maximum load avg on system."
},
"setid": {
"required": true,
"type": "SetId",
"description": "Effective user/group id for running Asterisk."
},
"max_open_files": {
"required": false,
"type": "int",
"description": "Maximum number of open file handles (files, sockets)."
},
"max_channels": {
"required": false,
"type": "int",
"description": "Maximum number of simultaneous channels."
}
},
"id": "ConfigInfo",
"description": "Info about Asterisk configuration"
}
- default_language: string - Default language for media playback.
- max_channels: int (optional) - Maximum number of simultaneous channels.
- max_load: double (optional) - Maximum load avg on system.
- max_open_files: int (optional) - Maximum number of open file handles (files, sockets).
- name: string - Asterisk system name.
- setid: SetId - Effective user/group id for running Asterisk.
ConfigTuple
A key/value pair that makes up part of a configuration object.
{
"properties": {
"attribute": {
"required": true,
"type": "string",
"description": "A configuration object attribute."
},
"value": {
"required": true,
"type": "string",
"description": "The value for the attribute."
}
},
"id": "ConfigTuple",
"description": "A key/value pair that makes up part of a configuration object."
}
- attribute: string - A configuration object attribute.
- value: string - The value for the attribute.
LogChannel
Details of an Asterisk log channel
{
"properties": {
"status": {
"required": true,
"type": "string",
"description": "Whether or not a log type is enabled"
},
"configuration": {
"required": true,
"type": "string",
"description": "The various log levels"
},
"type": {
"required": true,
"type": "string",
"description": "Types of logs for the log channel"
},
"channel": {
"required": true,
"type": "string",
"description": "The log channel path"
}
},
"id": "LogChannel",
"description": "Details of an Asterisk log channel"
}
- channel: string - The log channel path
- configuration: string - The various log levels
- status: string - Whether or not a log type is enabled
- type: string - Types of logs for the log channel
Module
Details of an Asterisk module
{
"properties": {
"use_count": {
"required": true,
"type": "int",
"description": "The number of times this module is being used"
},
"status": {
"required": true,
"type": "string",
"description": "The running status of this module"
},
"support_level": {
"required": true,
"type": "string",
"description": "The support state of this module"
},
"name": {
"required": true,
"type": "string",
"description": "The name of this module"
},
"description": {
"required": true,
"type": "string",
"description": "The description of this module"
}
},
"id": "Module",
"description": "Details of an Asterisk module"
}
- description: string - The description of this module
- name: string - The name of this module
- status: string - The running status of this module
- support_level: string - The support state of this module
- use_count: int - The number of times this module is being used
SetId
Effective user/group id
{
"properties": {
"group": {
"required": true,
"type": "string",
"description": "Effective group id."
},
"user": {
"required": true,
"type": "string",
"description": "Effective user id."
}
},
"id": "SetId",
"description": "Effective user/group id"
}
- group: string - Effective group id.
- user: string - Effective user id.
StatusInfo
Info about Asterisk status
{
"properties": {
"last_reload_time": {
"required": true,
"type": "Date",
"description": "Time when Asterisk was last reloaded."
},
"startup_time": {
"required": true,
"type": "Date",
"description": "Time when Asterisk was started."
}
},
"id": "StatusInfo",
"description": "Info about Asterisk status"
}
- last_reload_time: Date - Time when Asterisk was last reloaded.
- startup_time: Date - Time when Asterisk was started.
SystemInfo
Info about Asterisk
{
"properties": {
"entity_id": {
"required": true,
"type": "string",
"description": ""
},
"version": {
"required": true,
"type": "string",
"description": "Asterisk version."
}
},
"id": "SystemInfo",
"description": "Info about Asterisk"
}
- entity_id: string
- version: string - Asterisk version.
Variable
The value of a channel variable
{
"properties": {
"value": {
"required": true,
"type": "string",
"description": "The value of the variable requested"
}
},
"id": "Variable",
"description": "The value of a channel variable"
}
- value: string - The value of the variable requested
Endpoint
An external device that may offer/accept calls to/from Asterisk.
Unlike most resources, which have a single unique identifier, an endpoint is uniquely identified by the technology/resource pair.
{
"properties": {
"resource": {
"required": true,
"type": "string",
"description": "Identifier of the endpoint, specific to the given technology."
},
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"unknown",
"offline",
"online"
]
},
"required": false,
"type": "string",
"description": "Endpoint's state"
},
"technology": {
"required": true,
"type": "string",
"description": "Technology of the endpoint"
},
"channel_ids": {
"required": true,
"type": "List[string]",
"description": "Id's of channels associated with this endpoint"
}
},
"id": "Endpoint",
"description": "An external device that may offer/accept calls to/from Asterisk.\n\nUnlike most resources, which have a single unique identifier, an endpoint is uniquely identified by the technology/resource pair."
}
- channel_ids: List[string] - Id's of channels associated with this endpoint
- resource: string - Identifier of the endpoint, specific to the given technology.
- state: string (optional) - Endpoint's state
- technology: string - Technology of the endpoint
TextMessage
A text message.
{
"properties": {
"body": {
"required": true,
"type": "string",
"description": "The text of the message."
},
"to": {
"required": true,
"type": "string",
"description": "A technology specific URI specifying the destination of the message. Valid technologies include sip, pjsip, and xmp. The destination of a message should be an endpoint."
},
"variables": {
"required": false,
"type": "List[TextMessageVariable]",
"description": "Technology specific key/value pairs associated with the message."
},
"from": {
"required": true,
"type": "string",
"description": "A technology specific URI specifying the source of the message. For sip and pjsip technologies, any SIP URI can be specified. For xmpp, the URI must correspond to the client connection being used to send the message."
}
},
"id": "TextMessage",
"description": "A text message."
}
- body: string - The text of the message.
- from: string - A technology specific URI specifying the source of the message. For sip and pjsip technologies, any SIP URI can be specified. For xmpp, the URI must correspond to the client connection being used to send the message.
- to: string - A technology specific URI specifying the destination of the message. Valid technologies include sip, pjsip, and xmp. The destination of a message should be an endpoint.
- variables: List[TextMessageVariable] (optional) - Technology specific key/value pairs associated with the message.
TextMessageVariable
A key/value pair variable in a text message.
{
"properties": {
"value": {
"required": true,
"type": "string",
"description": "The value of the variable."
},
"key": {
"required": true,
"type": "string",
"description": "A unique key identifying the variable."
}
},
"id": "TextMessageVariable",
"description": "A key/value pair variable in a text message."
}
- key: string - A unique key identifying the variable.
- value: string - The value of the variable.
CallerID
Caller identification
{
"properties": {
"name": {
"required": true,
"type": "string"
},
"number": {
"required": true,
"type": "string"
}
},
"id": "CallerID",
"description": "Caller identification"
}
- name: string
- number: string
Channel
A specific communication connection between Asterisk and an Endpoint.
{
"properties": {
"accountcode": {
"required": true,
"type": "string"
},
"name": {
"required": true,
"type": "string",
"description": "Name of the channel (i.e. SIP/foo-0000a7e3)"
},
"language": {
"required": true,
"type": "string",
"description": "The default spoken language"
},
"channelvars": {
"required": false,
"type": "object",
"description": "Channel variables"
},
"caller": {
"required": true,
"type": "CallerID"
},
"creationtime": {
"required": true,
"type": "Date",
"description": "Timestamp when channel was created"
},
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"Down",
"Rsrved",
"OffHook",
"Dialing",
"Ring",
"Ringing",
"Up",
"Busy",
"Dialing Offhook",
"Pre-ring",
"Unknown"
]
},
"required": true,
"type": "string"
},
"connected": {
"required": true,
"type": "CallerID"
},
"dialplan": {
"required": true,
"type": "DialplanCEP",
"description": "Current location in the dialplan"
},
"id": {
"required": true,
"type": "string",
"description": "Unique identifier of the channel.\n\nThis is the same as the Uniqueid field in AMI."
}
},
"id": "Channel",
"description": "A specific communication connection between Asterisk and an Endpoint."
}
- accountcode: string
- caller: CallerID
- channelvars: object (optional) - Channel variables
- connected: CallerID
- creationtime: Date - Timestamp when channel was created
- dialplan: DialplanCEP - Current location in the dialplan
- id: string - Unique identifier of the channel.
This is the same as the Uniqueid field in AMI.
- language: string - The default spoken language
- name: string - Name of the channel (i.e. SIP/foo-0000a7e3)
- state: string
Dialed
Dialed channel information.
{
"properties": {},
"id": "Dialed",
"description": "Dialed channel information."
}
DialplanCEP
Dialplan location (context/extension/priority)
{
"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.
{
"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.
Everyone on the bridge receives the same audio.
{
"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
{
"properties": {
"talking_duration": {
"required": false,
"type": "int",
"description": "Duration of talking, in seconds, detected in the recording. This is only available if the recording was initiated with a non-zero maxSilenceSeconds."
},
"name": {
"required": true,
"type": "string",
"description": "Base name for the recording"
},
"target_uri": {
"required": true,
"type": "string",
"description": "URI for the channel or bridge being recorded"
},
"format": {
"required": true,
"type": "string",
"description": "Recording format (wav, gsm, etc.)"
},
"cause": {
"required": false,
"type": "string",
"description": "Cause for recording failure if failed"
},
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"queued",
"recording",
"paused",
"done",
"failed",
"canceled"
]
},
"required": true,
"type": "string"
},
"duration": {
"required": false,
"type": "int",
"description": "Duration in seconds of the recording"
},
"silence_duration": {
"required": false,
"type": "int",
"description": "Duration of silence, in seconds, detected in the recording. This is only available if the recording was initiated with a non-zero maxSilenceSeconds."
}
},
"id": "LiveRecording",
"description": "A recording that is in progress"
}
- cause: string (optional) - Cause for recording failure if failed
- duration: int (optional) - Duration in seconds of the recording
- format: string - Recording format (wav, gsm, etc.)
- name: string - Base name for the recording
- silence_duration: int (optional) - Duration of silence, in seconds, detected in the recording. This is only available if the recording was initiated with a non-zero maxSilenceSeconds.
- state: string
- talking_duration: int (optional) - Duration of talking, in seconds, detected in the recording. This is only available if the recording was initiated with a non-zero maxSilenceSeconds.
- target_uri: string - URI for the channel or bridge being recorded
StoredRecording
A past recording that may be played back.
{
"properties": {
"name": {
"required": true,
"type": "string"
},
"format": {
"required": true,
"type": "string"
}
},
"id": "StoredRecording",
"description": "A past recording that may be played back."
}
- format: string
- name: string
Identifies the format and language of a sound file
{
"properties": {
"language": {
"required": true,
"type": "string"
},
"format": {
"required": true,
"type": "string"
}
},
"id": "FormatLangPair",
"description": "Identifies the format and language of a sound file"
}
- format: string
- language: string
Sound
A media file that may be played back.
{
"properties": {
"text": {
"required": false,
"type": "string",
"description": "Text description of the sound, usually the words spoken."
},
"id": {
"required": true,
"type": "string",
"description": "Sound's identifier."
},
"formats": {
"required": true,
"type": "List[FormatLangPair]",
"description": "The formats and languages in which this sound is available."
}
},
"id": "Sound",
"description": "A media file that may be played back."
}
- formats: List[FormatLangPair] - The formats and languages in which this sound is available.
- id: string - Sound's identifier.
- text: string (optional) - Text description of the sound, usually the words spoken.
Playback
Object representing the playback of media to a channel
{
"properties": {
"next_media_uri": {
"required": false,
"type": "string",
"description": "If a list of URIs is being played, the next media URI to be played back."
},
"target_uri": {
"required": true,
"type": "string",
"description": "URI for the channel or bridge to play the media on"
},
"language": {
"type": "string",
"description": "For media types that support multiple languages, the language requested for playback."
},
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"queued",
"playing",
"continuing",
"done"
]
},
"required": true,
"type": "string",
"description": "Current state of the playback operation."
},
"media_uri": {
"required": true,
"type": "string",
"description": "The URI for the media currently being played back."
},
"id": {
"required": true,
"type": "string",
"description": "ID for this playback operation"
}
},
"id": "Playback",
"description": "Object representing the playback of media to a channel"
}
- id: string - ID for this playback operation
- language: string (optional) - For media types that support multiple languages, the language requested for playback.
- media_uri: string - The URI for the media currently being played back.
- next_media_uri: string (optional) - If a list of URIs is being played, the next media URI to be played back.
- state: string - Current state of the playback operation.
- target_uri: string - URI for the channel or bridge to play the media on
DeviceState
Represents the state of a device.
{
"properties": {
"state": {
"allowableValues": {
"valueType": "LIST",
"values": [
"UNKNOWN",
"NOT_INUSE",
"INUSE",
"BUSY",
"INVALID",
"UNAVAILABLE",
"RINGING",
"RINGINUSE",
"ONHOLD"
]
},
"required": true,
"type": "string",
"description": "Device's state"
},
"name": {
"required": true,
"type": "string",
"description": "Name of the device."
}
},
"id": "DeviceState",
"description": "Represents the state of a device."
}
- name: string - Name of the device.
- state: string - Device's state
Mailbox
Represents the state of a mailbox.
{
"properties": {
"old_messages": {
"required": true,
"type": "int",
"description": "Count of old messages in the mailbox."
},
"name": {
"required": true,
"type": "string",
"description": "Name of the mailbox."
},
"new_messages": {
"required": true,
"type": "int",
"description": "Count of new messages in the mailbox."
}
},
"id": "Mailbox",
"description": "Represents the state of a mailbox."
}
- 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.
{
"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
Notification that another WebSocket has taken over for an application.
An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.
{
"properties": {},
"id": "ApplicationReplaced",
"description": "Notification that another WebSocket has taken over for an application.\n\nAn application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this 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 - Time at which this event was created.
BridgeAttendedTransfer
Base type: Event
Notification that an attended transfer has occurred.
{
"properties": {
"replace_channel": {
"required": false,
"type": "Channel",
"description": "The channel that is replacing transferer_first_leg in the swap"
},
"is_external": {
"required": true,
"type": "boolean",
"description": "Whether the transfer was externally initiated or not"
},
"transferer_second_leg_bridge": {
"type": "Bridge",
"description": "Bridge the transferer second leg is in"
},
"destination_bridge": {
"type": "string",
"description": "Bridge that survived the merge result"
},
"transferer_second_leg": {
"required": true,
"type": "Channel",
"description": "Second leg of the transferer"
},
"destination_link_second_leg": {
"type": "Channel",
"description": "Second leg of a link transfer result"
},
"destination_threeway_channel": {
"type": "Channel",
"description": "Transferer channel that survived the threeway result"
},
"transfer_target": {
"required": false,
"type": "Channel",
"description": "The channel that is being transferred to"
},
"result": {
"required": true,
"type": "string",
"description": "The result of the transfer attempt"
},
"destination_type": {
"required": true,
"type": "string",
"description": "How the transfer was accomplished"
},
"destination_application": {
"type": "string",
"description": "Application that has been transferred into"
},
"destination_threeway_bridge": {
"type": "Bridge",
"description": "Bridge that survived the threeway result"
},
"destination_link_first_leg": {
"type": "Channel",
"description": "First leg of a link transfer result"
},
"transferee": {
"required": false,
"type": "Channel",
"description": "The channel that is being transferred"
},
"transferer_first_leg": {
"required": true,
"type": "Channel",
"description": "First leg of the transferer"
},
"transferer_first_leg_bridge": {
"type": "Bridge",
"description": "Bridge the transferer first leg is in"
}
},
"id": "BridgeAttendedTransfer",
"description": "Notification that an attended transfer has occurred."
}
- 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.
- 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
BridgeBlindTransfer
Base type: Event
Notification that a blind transfer has occurred.
{
"properties": {
"bridge": {
"type": "Bridge",
"description": "The bridge being transferred"
},
"replace_channel": {
"required": false,
"type": "Channel",
"description": "The channel that is replacing transferer when the transferee(s) can not be transferred directly"
},
"is_external": {
"required": true,
"type": "boolean",
"description": "Whether the transfer was externally initiated or not"
},
"exten": {
"required": true,
"type": "string",
"description": "The extension transferred to"
},
"result": {
"required": true,
"type": "string",
"description": "The result of the transfer attempt"
},
"context": {
"required": true,
"type": "string",
"description": "The context transferred to"
},
"transferee": {
"required": false,
"type": "Channel",
"description": "The channel that is being transferred"
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel performing the blind transfer"
}
},
"id": "BridgeBlindTransfer",
"description": "Notification that a blind transfer has occurred."
}
- 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 (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
BridgeCreated
Base type: Event
Notification that a bridge has been created.
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
}
},
"id": "BridgeCreated",
"description": "Notification that a bridge has been 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 - Time at which this event was created.
- bridge: Bridge
BridgeDestroyed
Base type: Event
Notification that a bridge has been destroyed.
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
}
},
"id": "BridgeDestroyed",
"description": "Notification that a bridge has been destroyed."
}
- 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
BridgeMerged
Base type: Event
Notification that one bridge has merged into another.
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"bridge_from": {
"required": true,
"type": "Bridge"
}
},
"id": "BridgeMerged",
"description": "Notification that one bridge has merged into another."
}
- 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
- bridge_from: Bridge
BridgeVideoSourceChanged
Base type: Event
Notification that the source of video in a bridge has changed.
{
"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
Channel changed Caller ID.
{
"properties": {
"caller_presentation_txt": {
"required": true,
"type": "string",
"description": "The text representation of the Caller Presentation value."
},
"caller_presentation": {
"required": true,
"type": "int",
"description": "The integer representation of the Caller Presentation value."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that changed Caller ID."
}
},
"id": "ChannelCallerId",
"description": "Channel 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 - 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.
ChannelConnectedLine
Base type: Event
Channel changed Connected Line.
{
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel whose connected line has changed."
}
},
"id": "ChannelConnectedLine",
"description": "Channel changed Connected Line."
}
- 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.
- channel: Channel - The channel whose connected line has changed.
ChannelCreated
Base type: Event
Notification that a channel has been created.
{
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "ChannelCreated",
"description": "Notification that a channel has been 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 - Time at which this event was created.
- channel: Channel
ChannelDestroyed
Base type: Event
Notification that a channel has been destroyed.
{
"properties": {
"cause": {
"required": true,
"type": "int",
"description": "Integer representation of the cause of the hangup"
},
"cause_txt": {
"required": true,
"type": "string",
"description": "Text representation of the cause of the hangup"
},
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "ChannelDestroyed",
"description": "Notification that a channel has been destroyed."
}
- 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.
- cause: int - Integer representation of the cause of the hangup
- cause_txt: string - Text representation of the cause of the hangup
- channel: Channel
ChannelDialplan
Base type: Event
Channel changed location in the dialplan.
{
"properties": {
"dialplan_app_data": {
"required": true,
"type": "string",
"description": "The data to be passed to the application."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that changed dialplan location."
},
"dialplan_app": {
"required": true,
"type": "string",
"description": "The application about to be executed."
}
},
"id": "ChannelDialplan",
"description": "Channel changed location in the dialplan."
}
- 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.
- 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.
ChannelDtmfReceived
Base type: Event
DTMF received on a channel.
This event is sent when the DTMF ends. There is no notification about the start of DTMF
{
"properties": {
"duration_ms": {
"required": true,
"type": "int",
"description": "Number of milliseconds DTMF was received"
},
"digit": {
"required": true,
"type": "string",
"description": "DTMF digit received (0-9, A-E, # or *)"
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which DTMF was received"
}
},
"id": "ChannelDtmfReceived",
"description": "DTMF received on a channel.\n\nThis event is sent when the DTMF ends. There is no notification about the start of DTMF"
}
- 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.
- 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
ChannelEnteredBridge
Base type: Event
Notification that a channel has entered a bridge.
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"channel": {
"type": "Channel"
}
},
"id": "ChannelEnteredBridge",
"description": "Notification that a channel has entered a 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 - Time at which this event was created.
- bridge: Bridge
- channel: Channel (optional)
ChannelHangupRequest
Base type: Event
A hangup was requested on the channel.
{
"properties": {
"soft": {
"type": "boolean",
"description": "Whether the hangup request was a soft hangup request."
},
"cause": {
"type": "int",
"description": "Integer representation of the cause of the hangup."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which the hangup was requested."
}
},
"id": "ChannelHangupRequest",
"description": "A hangup was requested 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 - 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.
ChannelHold
Base type: Event
A channel initiated a media hold.
{
"properties": {
"musicclass": {
"required": false,
"type": "string",
"description": "The music on hold class that the initiator requested."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that initiated the hold event."
}
},
"id": "ChannelHold",
"description": "A channel initiated a media hold."
}
- 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.
- channel: Channel - The channel that initiated the hold event.
- musicclass: string (optional) - The music on hold class that the initiator requested.
ChannelLeftBridge
Base type: Event
Notification that a channel has left a bridge.
{
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "ChannelLeftBridge",
"description": "Notification that a channel has left a 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 - Time at which this event was created.
- bridge: Bridge
- channel: Channel
ChannelStateChange
Base type: Event
Notification of a channel's state change.
{
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "ChannelStateChange",
"description": "Notification of a channel's state change."
}
- 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.
- channel: Channel
ChannelTalkingFinished
Base type: Event
Talking is no longer detected on the channel.
{
"properties": {
"duration": {
"required": true,
"type": "int",
"description": "The length of time, in milliseconds, that talking was detected on the channel"
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which talking completed."
}
},
"id": "ChannelTalkingFinished",
"description": "Talking is no longer 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 - 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
ChannelTalkingStarted
Base type: Event
Talking was detected on the channel.
{
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which talking started."
}
},
"id": "ChannelTalkingStarted",
"description": "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 - Time at which this event was created.
- channel: Channel - The channel on which talking started.
ChannelUnhold
Base type: Event
A channel initiated a media unhold.
{
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that initiated the unhold event."
}
},
"id": "ChannelUnhold",
"description": "A channel initiated a media unhold."
}
- 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.
- channel: Channel - The channel that initiated the unhold event.
ChannelUserevent
Base type: Event
User-generated event with additional user-defined fields in the object.
{
"properties": {
"eventname": {
"required": true,
"type": "string",
"description": "The name of the user event."
},
"bridge": {
"required": false,
"type": "Bridge",
"description": "A bridge that is signaled with the user event."
},
"userevent": {
"required": true,
"type": "object",
"description": "Custom Userevent data"
},
"endpoint": {
"required": false,
"type": "Endpoint",
"description": "A endpoint that is signaled with the user event."
},
"channel": {
"required": false,
"type": "Channel",
"description": "A channel that is signaled with the user event."
}
},
"id": "ChannelUserevent",
"description": "User-generated event with additional user-defined fields in the 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 - 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
ChannelVarset
Base type: Event
Channel variable changed.
{
"properties": {
"variable": {
"required": true,
"type": "string",
"description": "The variable that changed."
},
"channel": {
"required": false,
"type": "Channel",
"description": "The channel on which the variable was set.\n\nIf missing, the variable is a global variable."
},
"value": {
"required": true,
"type": "string",
"description": "The new value of the variable."
}
},
"id": "ChannelVarset",
"description": "Channel variable 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.
- channel: Channel (optional) - The channel on which the variable was set.
If missing, the variable is a global variable.
- value: string - The new value of the variable.
- variable: string - The variable that changed.
Detailed information about a contact on an endpoint.
{
"properties": {
"aor": {
"required": true,
"type": "string",
"description": "The Address of Record this contact belongs to."
},
"uri": {
"required": true,
"type": "string",
"description": "The location of the contact."
},
"roundtrip_usec": {
"required": false,
"type": "string",
"description": "Current round trip time, in microseconds, for the contact."
},
"contact_status": {
"allowableValues": {
"valueType": "LIST",
"values": [
"Unreachable",
"Reachable",
"Unknown",
"NonQualified",
"Removed"
]
},
"required": true,
"type": "string",
"description": "The current status of the contact."
}
},
"id": "ContactInfo",
"description": "Detailed information about a contact on an endpoint."
}
- aor: string - The Address of Record this contact belongs to.
- contact_status: string - The current status of the contact.
- roundtrip_usec: string (optional) - Current round trip time, in microseconds, for the contact.
- uri: string - The location of the contact.
Base type: Event
The state of a contact on an endpoint has changed.
{
"properties": {
"endpoint": {
"required": true,
"type": "Endpoint"
},
"contact_info": {
"required": true,
"type": "ContactInfo"
}
},
"id": "ContactStatusChange",
"description": "The state of a contact on an endpoint 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.
- contact_info: ContactInfo
- endpoint: Endpoint
DeviceStateChanged
Base type: Event
Notification that a device state has changed.
{
"properties": {
"device_state": {
"required": true,
"type": "DeviceState",
"description": "Device state object"
}
},
"id": "DeviceStateChanged",
"description": "Notification that a device state 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.
- device_state: DeviceState - Device state object
Dial
Base type: Event
Dialing state has changed.
{
"properties": {
"forwarded": {
"required": false,
"type": "Channel",
"description": "Channel that the caller has been forwarded to."
},
"caller": {
"required": false,
"type": "Channel",
"description": "The calling channel."
},
"dialstatus": {
"required": true,
"type": "string",
"description": "Current status of the dialing attempt to the peer."
},
"forward": {
"required": false,
"type": "string",
"description": "Forwarding target requested by the original dialed channel."
},
"dialstring": {
"required": false,
"type": "string",
"description": "The dial string for calling the peer channel."
},
"peer": {
"required": true,
"type": "Channel",
"description": "The dialed channel."
}
},
"id": "Dial",
"description": "Dialing state 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.
- 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.
EndpointStateChange
Base type: Event
Endpoint state changed.
{
"properties": {
"endpoint": {
"required": true,
"type": "Endpoint"
}
},
"id": "EndpointStateChange",
"description": "Endpoint state 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.
- endpoint: Endpoint
Event
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 PlaybackContinuing PlaybackFinished PlaybackStarted RecordingFailed RecordingFinished RecordingStarted StasisEnd StasisStart TextMessageReceived
Base type for asynchronous events from Asterisk.
{
"subTypes": [
"DeviceStateChanged",
"PlaybackStarted",
"PlaybackContinuing",
"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": true,
"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 - 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 PlaybackContinuing PlaybackFinished PlaybackStarted RecordingFailed RecordingFinished RecordingStarted StasisEnd StasisStart TextMessageReceived
Base type for errors and events
{
"discriminator": "type",
"properties": {
"type": {
"required": true,
"type": "string",
"description": "Indicates the type of this message."
},
"asterisk_id": {
"required": false,
"type": "string",
"description": "The unique ID for the Asterisk instance that raised this event."
}
},
"subTypes": [
"MissingParams",
"Event"
],
"id": "Message",
"description": "Base type for errors and events"
}
- asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
- type: string - Indicates the type of this message.
MissingParams
Base type: Message
Error event sent when required params are missing.
{
"properties": {
"params": {
"required": true,
"type": "List[string]",
"description": "A list of the missing parameters"
}
},
"id": "MissingParams",
"description": "Error event sent when required params are missing."
}
- asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
- type: string - Indicates the type of this message.
- params: List[string] - A list of the missing parameters
Peer
Detailed information about a remote peer that communicates with Asterisk.
{
"properties": {
"peer_status": {
"required": true,
"type": "string",
"description": "The current state of the peer. Note that the values of the status are dependent on the underlying peer technology."
},
"time": {
"required": false,
"type": "string",
"description": "The last known time the peer was contacted."
},
"cause": {
"required": false,
"type": "string",
"description": "An optional reason associated with the change in peer_status."
},
"port": {
"required": false,
"type": "string",
"description": "The port of the peer."
},
"address": {
"required": false,
"type": "string",
"description": "The IP address of the peer."
}
},
"id": "Peer",
"description": "Detailed information about a remote peer that communicates with Asterisk."
}
- address: string (optional) - The IP address of the peer.
- cause: string (optional) - An optional reason associated with the change in peer_status.
- peer_status: string - The current state of the peer. Note that the values of the status are dependent on the underlying peer technology.
- port: string (optional) - The port of the peer.
- time: string (optional) - The last known time the peer was contacted.
PeerStatusChange
Base type: Event
The state of a peer associated with an endpoint has changed.
{
"properties": {
"peer": {
"required": true,
"type": "Peer"
},
"endpoint": {
"required": true,
"type": "Endpoint"
}
},
"id": "PeerStatusChange",
"description": "The state of a peer associated with an endpoint 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.
- endpoint: Endpoint
- peer: Peer
PlaybackContinuing
Base type: Event
Event showing the continuation of a media playback operation from one media URI to the next in the list.
{
"properties": {
"playback": {
"required": true,
"type": "Playback",
"description": "Playback control object"
}
},
"id": "PlaybackContinuing",
"description": "Event showing the continuation of a media playback operation from one media URI to the next in the list."
}
- 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.
- playback: Playback - Playback control object
PlaybackFinished
Base type: Event
Event showing the completion of a media playback operation.
{
"properties": {
"playback": {
"required": true,
"type": "Playback",
"description": "Playback control object"
}
},
"id": "PlaybackFinished",
"description": "Event showing the completion of a media playback operation."
}
- 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.
- playback: Playback - Playback control object
PlaybackStarted
Base type: Event
Event showing the start of a media playback operation.
{
"properties": {
"playback": {
"required": true,
"type": "Playback",
"description": "Playback control object"
}
},
"id": "PlaybackStarted",
"description": "Event showing the start of a media playback operation."
}
- 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.
- playback: Playback - Playback control object
RecordingFailed
Base type: Event
Event showing failure of a recording operation.
{
"properties": {
"recording": {
"required": true,
"type": "LiveRecording",
"description": "Recording control object"
}
},
"id": "RecordingFailed",
"description": "Event showing failure of a recording operation."
}
- 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.
- recording: LiveRecording - Recording control object
RecordingFinished
Base type: Event
Event showing the completion of a recording operation.
{
"properties": {
"recording": {
"required": true,
"type": "LiveRecording",
"description": "Recording control object"
}
},
"id": "RecordingFinished",
"description": "Event showing the completion of a recording operation."
}
- 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.
- recording: LiveRecording - Recording control object
RecordingStarted
Base type: Event
Event showing the start of a recording operation.
{
"properties": {
"recording": {
"required": true,
"type": "LiveRecording",
"description": "Recording control object"
}
},
"id": "RecordingStarted",
"description": "Event showing the start of a recording operation."
}
- 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.
- recording: LiveRecording - Recording control object
StasisEnd
Base type: Event
Notification that a channel has left a Stasis application.
{
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "StasisEnd",
"description": "Notification that a channel has left a Stasis 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 - Time at which this event was created.
- channel: Channel
StasisStart
Base type: Event
Notification that a channel has entered a Stasis application.
{
"properties": {
"args": {
"required": true,
"type": "List[string]",
"description": "Arguments to the application"
},
"replace_channel": {
"required": false,
"type": "Channel"
},
"channel": {
"required": true,
"type": "Channel"
}
},
"id": "StasisStart",
"description": "Notification that a channel has entered a Stasis 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 - Time at which this event was created.
- args: List[string] - Arguments to the application
- channel: Channel
- replace_channel: Channel (optional)
TextMessageReceived
Base type: Event
A text message was received from an endpoint.
{
"properties": {
"message": {
"required": true,
"type": "TextMessage"
},
"endpoint": {
"required": false,
"type": "Endpoint"
}
},
"id": "TextMessageReceived",
"description": "A text message was received from an 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 - Time at which this event was created.
- endpoint: Endpoint (optional)
- message: TextMessage
Application
Details of a Stasis application
{
"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."
},
"device_names": {
"required": true,
"type": "List[string]",
"description": "Names of the devices subscribed to."
},
"events_disallowed": {
"required": true,
"type": "List[object]",
"description": "Event types not sent to the application."
},
"bridge_ids": {
"required": true,
"type": "List[string]",
"description": "Id's for bridges subscribed to."
},
"events_allowed": {
"required": true,
"type": "List[object]",
"description": "Event types sent 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