Asterisk REST Data Models¶
AsteriskInfo¶
Model¶
Properties¶
- build: [BuildInfo|#BuildInfo] (optional) - Info about how Asterisk was built
- config: [ConfigInfo|#ConfigInfo] (optional) - Info about Asterisk configuration
- status: [StatusInfo|#StatusInfo] (optional) - Info about Asterisk status
- system: [SystemInfo|#SystemInfo] (optional) - Info about the system running Asterisk
AsteriskPing¶
Model¶
Properties¶
- asterisk_id: string - Asterisk id info
- ping: string - Always string value is pong
- timestamp: string - The timestamp string of request received time
BuildInfo¶
Model¶
Properties¶
- 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¶
Model¶
Properties¶
- 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|#SetId] - Effective user/group id for running Asterisk.
ConfigTuple¶
Model¶
Properties¶
- attribute: string - A configuration object attribute.
- value: string - The value for the attribute.
LogChannel¶
Model¶
Properties¶
- 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¶
Model¶
Properties¶
- 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¶
Model¶
SetId | |
---|---|
Properties¶
- group: string - Effective group id.
- user: string - Effective user id.
StatusInfo¶
Model¶
Properties¶
- last_reload_time: Date - Time when Asterisk was last reloaded.
- startup_time: Date - Time when Asterisk was started.
SystemInfo¶
Model¶
SystemInfo | |
---|---|
Properties¶
- entity_id: string
- version: string - Asterisk version.
Variable¶
Model¶
Variable | |
---|---|
Properties¶
- value: string - The value of the variable requested
Endpoint¶
Model¶
Properties¶
- 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¶
Model¶
Properties¶
- body: string - The text of the message.
- from: string - A technology specific URI specifying the source of the message. For pjsip technology, 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 pjsip, and xmp. The destination of a message should be an endpoint.
- variables: [object|#object] (optional) - Technology specific key/value pairs (JSON object) associated with the message.
CallerID¶
Model¶
CallerID | |
---|---|
Properties¶
- name: string
- number: string
Channel¶
Model¶
Properties¶
- accountcode: string
- caller: [CallerID|#CallerID]
- caller_rdnis: string (optional) - The Caller ID RDNIS
- channelvars: [object|#object] (optional) - Channel variables
- connected: [CallerID|#CallerID]
- creationtime: Date - Timestamp when channel was created
- dialplan: [DialplanCEP|#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) * protocol_id: string - Protocol id from underlying channel driver (i.e. Call-ID for chan_pjsip; will be empty if not applicable or not implemented by driver). * state: string * tenantid: string (optional) - The Tenant ID for the channel
Dialed¶
Model¶
Properties¶
DialplanCEP¶
Model¶
Properties¶
- 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¶
Model¶
RTPstat | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
|
Properties¶
- 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¶
Model¶
Properties¶
- 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', 'sfu', 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¶
Model¶
Properties¶
- 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¶
Model¶
StoredRecording | |
---|---|
Properties¶
- format: string
- name: string
FormatLangPair¶
Model¶
FormatLangPair | |
---|---|
Properties¶
- format: string
- language: string
Sound¶
Model¶
Properties¶
- formats: [List[FormatLangPair]|#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¶
Model¶
Properties¶
- 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¶
Model¶
Properties¶
- name: string - Name of the device.
- state: string - Device's state
Mailbox¶
Model¶
Properties¶
- 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
Model¶
Properties¶
- 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|#Channel]
- destination: string
ApplicationReplaced¶
Base type: Event
Model¶
Properties¶
- 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
Model¶
Properties¶
- 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|#Channel] (optional) - First leg of a link transfer result
- destination_link_second_leg: [Channel|#Channel] (optional) - Second leg of a link transfer result
- destination_threeway_bridge: [Bridge|#Bridge] (optional) - Bridge that survived the threeway result
- destination_threeway_channel: [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|#Channel] (optional) - The channel that is replacing transferer_first_leg in the swap
- result: string - The result of the transfer attempt
- transfer_target: [Channel|#Channel] (optional) - The channel that is being transferred to
- transferee: [Channel|#Channel] (optional) - The channel that is being transferred
- transferer_first_leg: [Channel|#Channel] - First leg of the transferer
- transferer_first_leg_bridge: [Bridge|#Bridge] (optional) - Bridge the transferer first leg is in
- transferer_second_leg: [Channel|#Channel] - Second leg of the transferer
- transferer_second_leg_bridge: [Bridge|#Bridge] (optional) - Bridge the transferer second leg is in
BridgeBlindTransfer¶
Base type: Event
Model¶
Properties¶
- 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] (optional) - The bridge being transferred
- channel: [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|#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|#Channel] (optional) - The channel that is being transferred
BridgeCreated¶
Base type: Event
Model¶
BridgeCreated | |
---|---|
Properties¶
- 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]
BridgeDestroyed¶
Base type: Event
Model¶
BridgeDestroyed | |
---|---|
Properties¶
- 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]
BridgeMerged¶
Base type: Event
Model¶
BridgeMerged | |
---|---|
Properties¶
- 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]
- bridge_from: [Bridge|#Bridge]
BridgeVideoSourceChanged¶
Base type: Event
Model¶
BridgeVideoSourceChanged | |
---|---|
Properties¶
- 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]
- old_video_source_id: string (optional)
ChannelCallerId¶
Base type: Event
Model¶
Properties¶
- 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|#Channel] - The channel that changed Caller ID.
ChannelConnectedLine¶
Base type: Event
Model¶
ChannelConnectedLine | |
---|---|
Properties¶
- 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|#Channel] - The channel whose connected line has changed.
ChannelCreated¶
Base type: Event
Model¶
ChannelCreated | |
---|---|
Properties¶
- 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|#Channel]
ChannelDestroyed¶
Base type: Event
Model¶
Properties¶
- 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|#Channel]
ChannelDialplan¶
Base type: Event
Model¶
Properties¶
- 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|#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
Model¶
Properties¶
- 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|#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
Model¶
ChannelEnteredBridge | |
---|---|
Properties¶
- 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]
- channel: [Channel|#Channel] (optional)
ChannelHangupRequest¶
Base type: Event
Model¶
Properties¶
- 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|#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
Model¶
Properties¶
- 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|#Channel] - The channel that initiated the hold event.
- musicclass: string (optional) - The music on hold class that the initiator requested.
ChannelLeftBridge¶
Base type: Event
Model¶
ChannelLeftBridge | |
---|---|
Properties¶
- 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]
- channel: [Channel|#Channel]
ChannelStateChange¶
Base type: Event
Model¶
ChannelStateChange | |
---|---|
Properties¶
- 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|#Channel]
ChannelTalkingFinished¶
Base type: Event
Model¶
Properties¶
- 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|#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
Model¶
ChannelTalkingStarted | |
---|---|
Properties¶
- 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|#Channel] - The channel on which talking started.
ChannelToneDetected¶
Base type: Event
Model¶
ChannelToneDetected | |
---|---|
Properties¶
- 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|#Channel] - The channel the tone was detected on.
ChannelUnhold¶
Base type: Event
Model¶
ChannelUnhold | |
---|---|
Properties¶
- 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|#Channel] - The channel that initiated the unhold event.
ChannelUserevent¶
Base type: Event
Model¶
Properties¶
- 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] (optional) - A bridge that is signaled with the user event.
- channel: [Channel|#Channel] (optional) - A channel that is signaled with the user event.
- endpoint: [Endpoint|#Endpoint] (optional) - A endpoint that is signaled with the user event.
- eventname: string - The name of the user event.
- userevent: [object|#object] - Custom Userevent data
ChannelVarset¶
Base type: Event
Model¶
Properties¶
- 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|#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.
ContactInfo¶
Model¶
Properties¶
- 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.
ContactStatusChange¶
Base type: Event
Model¶
ContactStatusChange | |
---|---|
Properties¶
- 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|#ContactInfo]
- endpoint: [Endpoint|#Endpoint]
DeviceStateChanged¶
Base type: Event
Model¶
DeviceStateChanged | |
---|---|
Properties¶
- 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|#DeviceState] - Device state object
Dial¶
Base type: Event
Model¶
Properties¶
- 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|#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|#Channel] (optional) - Channel that the caller has been forwarded to.
- peer: [Channel|#Channel] - The dialed channel.
EndpointStateChange¶
Base type: Event
Model¶
EndpointStateChange | |
---|---|
Properties¶
- 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|#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 ChannelToneDetected ChannelUnhold ChannelUserevent ChannelVarset ContactStatusChange DeviceStateChanged Dial EndpointStateChange PeerStatusChange PlaybackContinuing PlaybackFinished PlaybackStarted RecordingFailed RecordingFinished RecordingStarted StasisEnd StasisStart TextMessageReceived
Model¶
Properties¶
- 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 ChannelToneDetected ChannelUnhold ChannelUserevent ChannelVarset ContactStatusChange DeviceStateChanged Dial EndpointStateChange Event MissingParams PeerStatusChange PlaybackContinuing PlaybackFinished PlaybackStarted RecordingFailed RecordingFinished RecordingStarted StasisEnd StasisStart TextMessageReceived
Model¶
Properties¶
- 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
Model¶
MissingParams | |
---|---|
Properties¶
- 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¶
Model¶
Properties¶
- 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
Model¶
PeerStatusChange | |
---|---|
Properties¶
- 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|#Endpoint]
- peer: [Peer|#Peer]
PlaybackContinuing¶
Base type: Event
Model¶
PlaybackContinuing | |
---|---|
Properties¶
- 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] - Playback control object
PlaybackFinished¶
Base type: Event
Model¶
PlaybackFinished | |
---|---|
Properties¶
- 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] - Playback control object
PlaybackStarted¶
Base type: Event
Model¶
PlaybackStarted | |
---|---|
Properties¶
- 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] - Playback control object
RecordingFailed¶
Base type: Event
Model¶
RecordingFailed | |
---|---|
Properties¶
- 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|#LiveRecording] - Recording control object
RecordingFinished¶
Base type: Event
Model¶
RecordingFinished | |
---|---|
Properties¶
- 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|#LiveRecording] - Recording control object
RecordingStarted¶
Base type: Event
Model¶
RecordingStarted | |
---|---|
Properties¶
- 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|#LiveRecording] - Recording control object
StasisEnd¶
Base type: Event
Model¶
StasisEnd | |
---|---|
Properties¶
- 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|#Channel]
StasisStart¶
Base type: Event
Model¶
Properties¶
- 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|#Channel]
- replace_channel: [Channel|#Channel] (optional)
TextMessageReceived¶
Base type: Event
Model¶
TextMessageReceived | |
---|---|
Properties¶
- 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|#Endpoint] (optional)
- message: [TextMessage|#TextMessage]
Application¶
Model¶
Properties¶
- 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]|#object] - Event types sent to the application.
- events_disallowed: [List[object]|#object] - Event types not sent to the application.
- name: string - Name of this application