Versions Compared

Key

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

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • destination_application: string (optional) - Application that has been transferred into
  • destination_bridge: string (optional) - Bridge that survived the merge result
  • destination_link_first_leg: Channel (optional) - First leg of a link transfer result
  • destination_link_second_leg: Channel (optional) - Second leg of a link transfer result
  • destination_threeway_bridge: Bridge (optional) - Bridge that survived the threeway result
  • destination_threeway_channel: Channel (optional) - Transferer channel that survived the threeway result
  • destination_type: string - How the transfer was accomplished
  • is_external: boolean - Whether the transfer was externally initiated or not
  • replace_channel: Channel (optional) - The channel that is replacing transferer_first_leg in the swap
  • result: string - The result of the transfer attempt
  • transfer_target: Channel (optional) - The channel that is being transferred to
  • transferee: Channel (optional) - The channel that is being transferred
  • transferer_first_leg: Channel - First leg of the transferer
  • transferer_first_leg_bridge: Bridge (optional) - Bridge the transferer first leg is in
  • transferer_second_leg: Channel - Second leg of the transferer
  • transferer_second_leg_bridge: Bridge (optional) - Bridge the transferer second leg is in

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • bridge: Bridge (optional) - The bridge being transferred
  • channel: Channel - The channel performing the blind transfer
  • context: string - The context transferred to
  • exten: string - The extension transferred to
  • is_external: boolean - Whether the transfer was externally initiated or not
  • replace_channel: Channel (optional) - The channel that is replacing transferer when the transferee(s) can not be transferred directly
  • result: string - The result of the transfer attempt
  • transferee: Channel (optional) - The channel that is being transferred

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • bridge: Bridge

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • bridge: Bridge

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • bridge: Bridge
  • bridge_from: Bridge

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • caller_presentation: int - The integer representation of the Caller Presentation value.
  • caller_presentation_txt: string - The text representation of the Caller Presentation value.
  • channel: Channel - The channel that changed Caller ID.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel - The channel whose connected line has changed.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • cause: int - Integer representation of the cause of the hangup
  • cause_txt: string - Text representation of the cause of the hangup
  • channel: Channel

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel - The channel that changed dialplan location.
  • dialplan_app: string - The application about to be executed.
  • dialplan_app_data: string - The data to be passed to the application.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel - The channel on which DTMF was received
  • digit: string - DTMF digit received (0-9, A-E, # or *)
  • duration_ms: int - Number of milliseconds DTMF was received

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • bridge: Bridge
  • channel: Channel (optional)

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • cause: int (optional) - Integer representation of the cause of the hangup.
  • channel: Channel - The channel on which the hangup was requested.
  • soft: boolean (optional) - Whether the hangup request was a soft hangup request.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel - The channel that initiated the hold event.
  • musicclass: string (optional) - The music on hold class that the initiator requested.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • bridge: Bridge
  • channel: Channel

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel - The channel on which talking completed.
  • duration: int - The length of time, in milliseconds, that talking was detected on the channel

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel - The channel on which talking started.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel - The channel that initiated the unhold event.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • bridge: Bridge (optional) - A bridge that is signaled with the user event.
  • channel: Channel (optional) - A channel that is signaled with the user event.
  • endpoint: Endpoint (optional) - A endpoint that is signaled with the user event.
  • eventname: string - The name of the user event.
  • userevent: object - Custom Userevent data

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel (optional) - The channel on which the variable was set.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • contact_info: ContactInfo
  • endpoint: Endpoint

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • device_state: DeviceState - Device state object

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • caller: Channel (optional) - The calling channel.
  • dialstatus: string - Current status of the dialing attempt to the peer.
  • dialstring: string (optional) - The dial string for calling the peer channel.
  • forward: string (optional) - Forwarding target requested by the original dialed channel.
  • forwarded: Channel (optional) - Channel that the caller has been forwarded to.
  • peer: Channel - The dialed channel.

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • endpoint: Endpoint

...

Code Block
languagejavascript
collapsetrue
{
  "subTypes": [
    "DeviceStateChanged",
    "PlaybackStarted",
    "PlaybackFinished",
    "RecordingStarted",
    "RecordingFinished",
    "RecordingFailed",
    "ApplicationReplaced",
    "BridgeCreated",
    "BridgeDestroyed",
    "BridgeMerged",
    "BridgeBlindTransfer",
    "BridgeAttendedTransfer",
    "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": false,
      "type": "Date",
      "description": "Time at which this event was created."
    }
  },
  "id": "Event",
  "description": "Base type for asynchronous events from Asterisk."
}
  • asterisk_id: string (optional) - The unique ID for the Asterisk instance that raised this event.
  • type: string - Indicates the type of this message.
  • application: string - Name of the application receiving the event.
  • timestamp: Date (optional) - Time at which this event was created.

...

Code Block
languagejavascript
collapsetrue
{
  "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.

...

Code Block
languagejavascript
collapsetrue
{
  "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

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • endpoint: Endpoint
  • peer: Peer

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • playback: Playback - Playback control object

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • playback: Playback - Playback control object

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • recording: LiveRecording - Recording control object

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • recording: LiveRecording - Recording control object

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • recording: LiveRecording - Recording control object

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • channel: Channel

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • args: List[string] - Arguments to the application
  • channel: Channel
  • replace_channel: Channel (optional)

...

Code Block
languagejavascript
collapsetrue
{
  "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 (optional) - Time at which this event was created.
  • endpoint: Endpoint (optional)
  • message: TextMessage

...