Manuais
Documentação do Asterisk 22
Documentação do Asterisk 21
Documentação do Asterisk 20
Documentação do Asterisk 18
Documentação do Asterisk 17
Documentação do Asterisk 16
Documentação do Asterisk 15
Documentação do Asterisk 14
Documentação do Asterisk 13
Documentação do Asterisk 12
Documentação do Asterisk 11
Interface REST do Asterisk 18
Comando:
Asterisk REST Data Models
Sinopse:
Este é o mesmo campo Uniqueid do AMI. * language: string - O idioma falado padrão * name: string - Nome do canal (por exemplo, SIP/foo-0000a7e3)
Descrição:
Este é o mesmo campo Uniqueid do AMI. * language: string - O idioma falado padrão * name: string - Nome do canal (por exemplo, SIP/foo-0000a7e3) * protocol_id: string - ID do protocolo do driver de canal subjacente (por exemplo, Call-ID para chan_sip/chan_pjsip; será vazio se não for aplicável ou não for implementado pelo driver). * state: string * tenantid: string (opcional) - O ID do Tenant para o canal. Tipo base: Event
Este é o mesmo campo Uniqueid do AMI. * language: string - O idioma falado padrão * name: string - Nome do canal (por exemplo, SIP/foo-0000a7e3) * protocol_id: string - ID do protocolo do driver de canal subjacente (por exemplo, Call-ID para chan_sip/chan_pjsip; será vazio se não for aplicável ou não for implementado pelo driver). * state: string * tenantid: string (opcional) - O ID do Tenant para o canal. Tipo base: Event
Sintaxe:
{
"id": "AsteriskInfo",
"description": "Asterisk system information",
"properties": {
"build": {
"required": false,
"type": "BuildInfo",
"description": "Info about how Asterisk was built"
},
"system": {
"required": false,
"type": "SystemInfo",
"description": "Info about the system running Asterisk"
},
"config": {
"required": false,
"type": "ConfigInfo",
"description": "Info about Asterisk configuration"
},
"status": {
"required": false,
"type": "StatusInfo",
"description": "Info about Asterisk status"
}
}
}
{
"id": "AsteriskPing",
"description": "Asterisk ping information",
"properties": {
"asterisk_id": {
"required": true,
"type": "string",
"description": "Asterisk id info"
},
"ping": {
"required": true,
"type": "string",
"description": "Always string value is pong"
},
"timestamp": {
"required": true,
"type": "string",
"description": "The timestamp string of request received time"
}
}
}
{
"id": "BuildInfo",
"description": "Info about how Asterisk was built",
"properties": {
"os": {
"required": true,
"type": "string",
"description": "OS Asterisk was built on."
},
"kernel": {
"required": true,
"type": "string",
"description": "Kernel version Asterisk was built on."
},
"options": {
"required": true,
"type": "string",
"description": "Compile time options, or empty string if default."
},
"machine": {
"required": true,
"type": "string",
"description": "Machine architecture (x86_64, i686, ppc, etc.)"
},
"date": {
"required": true,
"type": "string",
"description": "Date and time when Asterisk was built."
},
"user": {
"required": true,
"type": "string",
"description": "Username that build Asterisk"
}
}
}
{
"id": "ConfigInfo",
"description": "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_channels": {
"required": false,
"type": "int",
"description": "Maximum number of simultaneous channels."
},
"max_open_files": {
"required": false,
"type": "int",
"description": "Maximum number of open file handles (files, sockets)."
},
"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."
}
}
}
{
"id": "ConfigTuple",
"description": "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": "LogChannel",
"description": "Details of an Asterisk log channel",
"properties": {
"channel": {
"type": "string",
"description": "The log channel path",
"required": true
},
"type": {
"type": "string",
"description": "Types of logs for the log channel",
"required": true
},
"status": {
"type": "string",
"description": "Whether or not a log type is enabled",
"required": true
},
"configuration": {
"type": "string",
"description": "The various log levels",
"required": true
}
}
}
{
"id": "Module",
"description": "Details of an Asterisk module",
"properties": {
"name": {
"type": "string",
"description": "The name of this module",
"required": true
},
"description": {
"type": "string",
"description": "The description of this module",
"required": true
},
"use_count": {
"type": "int",
"description": "The number of times this module is being used",
"required": true
},
"status": {
"type": "string",
"description": "The running status of this module",
"required": true
},
"support_level": {
"type": "string",
"description": "The support state of this module",
"required": true
}
}
}
{
"id": "SetId",
"description": "Effective user/group id",
"properties": {
"user": {
"required": true,
"type": "string",
"description": "Effective user id."
},
"group": {
"required": true,
"type": "string",
"description": "Effective group id."
}
}
}
{
"id": "StatusInfo",
"description": "Info about Asterisk status",
"properties": {
"startup_time": {
"required": true,
"type": "Date",
"description": "Time when Asterisk was started."
},
"last_reload_time": {
"required": true,
"type": "Date",
"description": "Time when Asterisk was last reloaded."
}
}
}
{
"id": "SystemInfo",
"description": "Info about Asterisk",
"properties": {
"version": {
"required": true,
"type": "string",
"description": "Asterisk version."
},
"entity_id": {
"required": true,
"type": "string",
"description": ""
}
}
}
{
"id": "Variable",
"description": "The value of a channel variable",
"properties": {
"value": {
"required": true,
"type": "string",
"description": "The value of the variable requested"
}
}
}
{
"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.",
"properties": {
"technology": {
"type": "string",
"description": "Technology of the endpoint",
"required": true
},
"resource": {
"type": "string",
"description": "Identifier of the endpoint, specific to the given technology.",
"required": true
},
"state": {
"type": "string",
"description": "Endpoint's state",
"required": false,
"allowableValues": {
"valueType": "LIST",
"values": [
"unknown",
"offline",
"online"
]
}
},
"channel_ids": {
"type": "List[string]",
"description": "Id's of channels associated with this endpoint",
"required": true
}
}
}
{
"id": "TextMessage",
"description": "A text message.",
"properties": {
"from": {
"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.",
"required": true
},
"to": {
"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.",
"required": true
},
"body": {
"type": "string",
"description": "The text of the message.",
"required": true
},
"variables": {
"type": "object",
"description": "Technology specific key/value pairs (JSON object) associated with the message.",
"required": false
}
}
}
{
"id": "CallerID",
"description": "Caller identification",
"properties": {
"name": {
"required": true,
"type": "string"
},
"number": {
"required": true,
"type": "string"
}
}
}
{
"id": "Channel",
"description": "A specific communication connection between Asterisk and an Endpoint.",
"properties": {
"id": {
"required": true,
"type": "string",
"description": "Unique identifier of the channel.\n\nThis is the same as the Uniqueid field in AMI."
},
"protocol_id": {
"required": true,
"type": "string",
"description": "Protocol id from underlying channel driver (i.e. Call-ID for chan_sip/chan_pjsip; will be empty if not applicable or not implemented by driver)."
},
"name": {
"required": true,
"type": "string",
"description": "Name of the channel (i.e. SIP/foo-0000a7e3)"
},
"state": {
"required": true,
"type": "string",
"allowableValues": {
"valueType": "LIST",
"values": [
"Down",
"Rsrved",
"OffHook",
"Dialing",
"Ring",
"Ringing",
"Up",
"Busy",
"Dialing Offhook",
"Pre-ring",
"Unknown"
]
}
},
"caller": {
"required": true,
"type": "CallerID"
},
"connected": {
"required": true,
"type": "CallerID"
},
"accountcode": {
"required": true,
"type": "string"
},
"dialplan": {
"required": true,
"type": "DialplanCEP",
"description": "Current location in the dialplan"
},
"creationtime": {
"required": true,
"type": "Date",
"description": "Timestamp when channel was created"
},
"language": {
"required": true,
"type": "string",
"description": "The default spoken language"
},
"channelvars": {
"required": false,
"type": "object",
"description": "Channel variables"
},
"caller_rdnis": {
"type": "string",
"description": "The Caller ID RDNIS"
},
"tenantid": {
"required": false,
"type": "string",
"description": "The Tenant ID for the channel"
}
}
}
{
"id": "Dialed",
"description": "Dialed channel information.",
"properties": {}
}
{
"id": "DialplanCEP",
"description": "Dialplan location (context/extension/priority)",
"properties": {
"context": {
"required": true,
"type": "string",
"description": "Context in the dialplan"
},
"exten": {
"required": true,
"type": "string",
"description": "Extension in the dialplan"
},
"priority": {
"required": true,
"type": "long",
"description": "Priority in the dialplan"
},
"app_name": {
"required": true,
"type": "string",
"description": "Name of current dialplan application"
},
"app_data": {
"required": true,
"type": "string",
"description": "Parameter of current dialplan application"
}
}
}
{
"id": "RTPstat",
"description": "A statistics of a RTP.",
"properties": {
"txcount": {
"required": true,
"type": "int",
"description": "Number of packets transmitted."
},
"rxcount": {
"required": true,
"type": "int",
"description": "Number of packets received."
},
"txjitter": {
"required": false,
"type": "double",
"description": "Jitter on transmitted packets."
},
"rxjitter": {
"required": false,
"type": "double",
"description": "Jitter on received packets."
},
"remote_maxjitter": {
"required": false,
"type": "double",
"description": "Maximum jitter on remote side."
},
"remote_minjitter": {
"required": false,
"type": "double",
"description": "Minimum jitter on remote side."
},
"remote_normdevjitter": {
"required": false,
"type": "double",
"description": "Average jitter on remote side."
},
"remote_stdevjitter": {
"required": false,
"type": "double",
"description": "Standard deviation jitter on remote side."
},
"local_maxjitter": {
"required": false,
"type": "double",
"description": "Maximum jitter on local side."
},
"local_minjitter": {
"required": false,
"type": "double",
"description": "Minimum jitter on local side."
},
"local_normdevjitter": {
"required": false,
"type": "double",
"description": "Average jitter on local side."
},
"local_stdevjitter": {
"required": false,
"type": "double",
"description": "Standard deviation jitter on local side."
},
"txploss": {
"required": true,
"type": "int",
"description": "Number of transmitted packets lost."
},
"rxploss": {
"required": true,
"type": "int",
"description": "Number of received packets lost."
},
"remote_maxrxploss": {
"required": false,
"type": "double",
"description": "Maximum number of packets lost on remote side."
},
"remote_minrxploss": {
"required": false,
"type": "double",
"description": "Minimum number of packets lost on remote side."
},
"remote_normdevrxploss": {
"required": false,
"type": "double",
"description": "Average number of packets lost on remote side."
},
"remote_stdevrxploss": {
"required": false,
"type": "double",
"description": "Standard deviation packets lost on remote side."
},
"local_maxrxploss": {
"required": false,
"type": "double",
"description": "Maximum number of packets lost on local side."
},
"local_minrxploss": {
"required": false,
"type": "double",
"description": "Minimum number of packets lost on local side."
},
"local_normdevrxploss": {
"required": false,
"type": "double",
"description": "Average number of packets lost on local side."
},
"local_stdevrxploss": {
"required": false,
"type": "double",
"description": "Standard deviation packets lost on local side."
},
"rtt": {
"required": false,
"type": "double",
"description": "Total round trip time."
},
"maxrtt": {
"required": false,
"type": "double",
"description": "Maximum round trip time."
},
"minrtt": {
"required": false,
"type": "double",
"description": "Minimum round trip time."
},
"normdevrtt": {
"required": false,
"type": "double",
"description": "Average round trip time."
},
"stdevrtt": {
"required": false,
"type": "double",
"description": "Standard deviation round trip time."
},
"local_ssrc": {
"required": true,
"type": "int",
"description": "Our SSRC."
},
"remote_ssrc": {
"required": true,
"type": "int",
"description": "Their SSRC."
},
"txoctetcount": {
"required": true,
"type": "int",
"description": "Number of octets transmitted."
},
"rxoctetcount": {
"required": true,
"type": "int",
"description": "Number of octets received."
},
"channel_uniqueid": {
"required": true,
"type": "string",
"description": "The Asterisk channel's unique ID that owns this instance."
}
}
}
{
"id": "Bridge",
"description": "The merging of media from one or more channels.\n\nEveryone on the bridge receives the same audio.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for this bridge",
"required": true
},
"technology": {
"type": "string",
"description": "Name of the current bridging technology",
"required": true
},
"bridge_type": {
"type": "string",
"description": "Type of bridge technology",
"required": true,
"allowableValues": {
"valueType": "LIST",
"values": [
"mixing",
"holding"
]
}
},
"bridge_class": {
"type": "string",
"description": "Bridging class",
"required": true
},
"creator": {
"type": "string",
"description": "Entity that created the bridge",
"required": true
},
"name": {
"type": "string",
"description": "Name the creator gave the bridge",
"required": true
},
"channels": {
"type": "List[string]",
"description": "Ids of channels participating in this bridge",
"required": true
},
"video_mode": {
"type": "string",
"description": "The video mode the bridge is using. One of 'none', 'talker', 'sfu', or 'single'.",
"required": false
},
"video_source_id": {
"type": "string",
"description": "The ID of the channel that is the source of video in this bridge, if one exists.",
"required": false
},
"creationtime": {
"required": true,
"type": "Date",
"description": "Timestamp when bridge was created"
}
}
}
{
"id": "LiveRecording",
"description": "A recording that is in progress",
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Base name for the recording"
},
"format": {
"required": true,
"type": "string",
"description": "Recording format (wav, gsm, etc.)"
},
"target_uri": {
"required": true,
"type": "string",
"description": "URI for the channel or bridge being recorded"
},
"state": {
"required": true,
"type": "string",
"allowableValues": {
"valueType": "LIST",
"values": [
"queued",
"recording",
"paused",
"done",
"failed",
"canceled"
]
}
},
"duration": {
"required": false,
"type": "int",
"description": "Duration in seconds of the recording"
},
"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."
},
"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."
},
"cause": {
"required": false,
"type": "string",
"description": "Cause for recording failure if failed"
}
}
}
{
"id": "StoredRecording",
"description": "A past recording that may be played back.",
"properties": {
"name": {
"required": true,
"type": "string"
},
"format": {
"required": true,
"type": "string"
}
}
}
{
"id": "FormatLangPair",
"description": "Identifies the format and language of a sound file",
"properties": {
"language": {
"required": true,
"type": "string"
},
"format": {
"required": true,
"type": "string"
}
}
}
{
"id": "Sound",
"description": "A media file that may be played back.",
"properties": {
"id": {
"required": true,
"description": "Sound's identifier.",
"type": "string"
},
"text": {
"required": false,
"description": "Text description of the sound, usually the words spoken.",
"type": "string"
},
"formats": {
"required": true,
"description": "The formats and languages in which this sound is available.",
"type": "List[FormatLangPair]"
}
}
}
{
"id": "Playback",
"description": "Object representing the playback of media to a channel",
"properties": {
"id": {
"type": "string",
"description": "ID for this playback operation",
"required": true
},
"media_uri": {
"type": "string",
"description": "The URI for the media currently being played back.",
"required": true
},
"next_media_uri": {
"type": "string",
"description": "If a list of URIs is being played, the next media URI to be played back.",
"required": false
},
"target_uri": {
"type": "string",
"description": "URI for the channel or bridge to play the media on",
"required": true
},
"language": {
"type": "string",
"description": "For media types that support multiple languages, the language requested for playback."
},
"state": {
"type": "string",
"description": "Current state of the playback operation.",
"required": true,
"allowableValues": {
"valueType": "LIST",
"values": [
"queued",
"playing",
"continuing",
"done",
"failed"
]
}
}
}
}
{
"id": "DeviceState",
"description": "Represents the state of a device.",
"properties": {
"name": {
"type": "string",
"description": "Name of the device.",
"required": true
},
"state": {
"type": "string",
"description": "Device's state",
"required": true,
"allowableValues": {
"valueType": "LIST",
"values": [
"UNKNOWN",
"NOT_INUSE",
"INUSE",
"BUSY",
"INVALID",
"UNAVAILABLE",
"RINGING",
"RINGINUSE",
"ONHOLD"
]
}
}
}
}
{
"id": "Mailbox",
"description": "Represents the state of a mailbox.",
"properties": {
"name": {
"type": "string",
"description": "Name of the mailbox.",
"required": true
},
"old_messages": {
"type": "int",
"description": "Count of old messages in the mailbox.",
"required": true
},
"new_messages": {
"type": "int",
"description": "Count of new messages in the mailbox.",
"required": true
}
}
}
{
"id": "ApplicationMoveFailed",
"description": "Notification that trying to move a channel to another Stasis application failed.",
"properties": {
"channel": {
"required": true,
"type": "Channel"
},
"destination": {
"required": true,
"type": "string"
},
"args": {
"required": true,
"type": "List[string]",
"description": "Arguments to the application"
}
}
}
{
"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.",
"properties": {}
}
{
"id": "BridgeAttendedTransfer",
"description": "Notification that an attended transfer has occurred.",
"properties": {
"transferer_first_leg": {
"description": "First leg of the transferer",
"required": true,
"type": "Channel"
},
"transferer_second_leg": {
"description": "Second leg of the transferer",
"required": true,
"type": "Channel"
},
"replace_channel": {
"description": "The channel that is replacing transferer_first_leg in the swap",
"required": false,
"type": "Channel"
},
"transferee": {
"description": "The channel that is being transferred",
"required": false,
"type": "Channel"
},
"transfer_target": {
"description": "The channel that is being transferred to",
"required": false,
"type": "Channel"
},
"result": {
"description": "The result of the transfer attempt",
"required": true,
"type": "string"
},
"is_external": {
"description": "Whether the transfer was externally initiated or not",
"required": true,
"type": "boolean"
},
"transferer_first_leg_bridge": {
"description": "Bridge the transferer first leg is in",
"type": "Bridge"
},
"transferer_second_leg_bridge": {
"description": "Bridge the transferer second leg is in",
"type": "Bridge"
},
"destination_type": {
"description": "How the transfer was accomplished",
"required": true,
"type": "string"
},
"destination_bridge": {
"description": "Bridge that survived the merge result",
"type": "string"
},
"destination_application": {
"description": "Application that has been transferred into",
"type": "string"
},
"destination_link_first_leg": {
"description": "First leg of a link transfer result",
"type": "Channel"
},
"destination_link_second_leg": {
"description": "Second leg of a link transfer result",
"type": "Channel"
},
"destination_threeway_channel": {
"description": "Transferer channel that survived the threeway result",
"type": "Channel"
},
"destination_threeway_bridge": {
"description": "Bridge that survived the threeway result",
"type": "Bridge"
}
}
}
{
"id": "BridgeBlindTransfer",
"description": "Notification that a blind transfer has occurred.",
"properties": {
"channel": {
"description": "The channel performing the blind transfer",
"required": true,
"type": "Channel"
},
"replace_channel": {
"description": "The channel that is replacing transferer when the transferee(s) can not be transferred directly",
"required": false,
"type": "Channel"
},
"transferee": {
"description": "The channel that is being transferred",
"required": false,
"type": "Channel"
},
"exten": {
"description": "The extension transferred to",
"required": true,
"type": "string"
},
"context": {
"description": "The context transferred to",
"required": true,
"type": "string"
},
"result": {
"description": "The result of the transfer attempt",
"required": true,
"type": "string"
},
"is_external": {
"description": "Whether the transfer was externally initiated or not",
"required": true,
"type": "boolean"
},
"bridge": {
"description": "The bridge being transferred",
"type": "Bridge"
}
}
}
{
"id": "BridgeCreated",
"description": "Notification that a bridge has been created.",
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
}
}
}
{
"id": "BridgeDestroyed",
"description": "Notification that a bridge has been destroyed.",
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
}
}
}
{
"id": "BridgeMerged",
"description": "Notification that one bridge has merged into another.",
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"bridge_from": {
"required": true,
"type": "Bridge"
}
}
}
{
"id": "BridgeVideoSourceChanged",
"description": "Notification that the source of video in a bridge has changed.",
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"old_video_source_id": {
"required": false,
"type": "string"
}
}
}
{
"id": "ChannelCallerId",
"description": "Channel changed Caller ID.",
"properties": {
"caller_presentation": {
"required": true,
"type": "int",
"description": "The integer representation of the Caller Presentation value."
},
"caller_presentation_txt": {
"required": true,
"type": "string",
"description": "The text representation of the Caller Presentation value."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that changed Caller ID."
}
}
}
{
"id": "ChannelConnectedLine",
"description": "Channel changed Connected Line.",
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel whose connected line has changed."
}
}
}
{
"id": "ChannelCreated",
"description": "Notification that a channel has been created.",
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
}
}
{
"id": "ChannelDestroyed",
"description": "Notification that a channel has been destroyed.",
"properties": {
"cause": {
"required": true,
"description": "Integer representation of the cause of the hangup",
"type": "int"
},
"cause_txt": {
"required": true,
"description": "Text representation of the cause of the hangup",
"type": "string"
},
"channel": {
"required": true,
"type": "Channel"
}
}
}
{
"id": "ChannelDialplan",
"description": "Channel changed location in the dialplan.",
"properties": {
"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."
},
"dialplan_app_data": {
"required": true,
"type": "string",
"description": "The data to be passed to the application."
}
}
}
{
"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",
"properties": {
"digit": {
"required": true,
"type": "string",
"description": "DTMF digit received (0-9, A-E, # or *)"
},
"duration_ms": {
"required": true,
"type": "int",
"description": "Number of milliseconds DTMF was received"
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which DTMF was received"
}
}
}
{
"id": "ChannelEnteredBridge",
"description": "Notification that a channel has entered a bridge.",
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"channel": {
"type": "Channel"
}
}
}
{
"id": "ChannelHangupRequest",
"description": "A hangup was requested on the channel.",
"properties": {
"cause": {
"type": "int",
"description": "Integer representation of the cause of the hangup."
},
"soft": {
"type": "boolean",
"description": "Whether the hangup request was a soft hangup request."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which the hangup was requested."
}
}
}
{
"id": "ChannelHold",
"description": "A channel initiated a media hold.",
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that initiated the hold event."
},
"musicclass": {
"required": false,
"type": "string",
"description": "The music on hold class that the initiator requested."
}
}
}
{
"id": "ChannelLeftBridge",
"description": "Notification that a channel has left a bridge.",
"properties": {
"bridge": {
"required": true,
"type": "Bridge"
},
"channel": {
"required": true,
"type": "Channel"
}
}
}
{
"id": "ChannelStateChange",
"description": "Notification of a channel's state change.",
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
}
}
{
"id": "ChannelTalkingFinished",
"description": "Talking is no longer detected on the channel.",
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which talking completed."
},
"duration": {
"required": true,
"type": "int",
"description": "The length of time, in milliseconds, that talking was detected on the channel"
}
}
}
{
"id": "ChannelTalkingStarted",
"description": "Talking was detected on the channel.",
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which talking started."
}
}
}
{
"id": "ChannelUnhold",
"description": "A channel initiated a media unhold.",
"properties": {
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that initiated the unhold event."
}
}
}
{
"id": "ChannelUserevent",
"description": "User-generated event with additional user-defined fields in the object.",
"properties": {
"eventname": {
"required": true,
"type": "string",
"description": "The name of the user event."
},
"channel": {
"required": false,
"type": "Channel",
"description": "A channel that is signaled with the user event."
},
"bridge": {
"required": false,
"type": "Bridge",
"description": "A bridge that is signaled with the user event."
},
"endpoint": {
"required": false,
"type": "Endpoint",
"description": "A endpoint that is signaled with the user event."
},
"userevent": {
"required": true,
"type": "object",
"description": "Custom Userevent data"
}
}
}
{
"id": "ChannelVarset",
"description": "Channel variable changed.",
"properties": {
"variable": {
"required": true,
"type": "string",
"description": "The variable that changed."
},
"value": {
"required": true,
"type": "string",
"description": "The new value of the variable."
},
"channel": {
"required": false,
"type": "Channel",
"description": "The channel on which the variable was set.\n\nIf missing, the variable is a global variable."
}
}
}
{
"id": "ContactInfo",
"description": "Detailed information about a contact on an endpoint.",
"properties": {
"uri": {
"type": "string",
"description": "The location of the contact.",
"required": true
},
"contact_status": {
"type": "string",
"description": "The current status of the contact.",
"required": true,
"allowableValues": {
"valueType": "LIST",
"values": [
"Unreachable",
"Reachable",
"Unknown",
"NonQualified",
"Removed"
]
}
},
"aor": {
"type": "string",
"description": "The Address of Record this contact belongs to.",
"required": true
},
"roundtrip_usec": {
"type": "string",
"description": "Current round trip time, in microseconds, for the contact.",
"required": false
}
}
}
{
"id": "ContactStatusChange",
"description": "The state of a contact on an endpoint has changed.",
"properties": {
"endpoint": {
"required": true,
"type": "Endpoint"
},
"contact_info": {
"required": true,
"type": "ContactInfo"
}
}
}
{
"id": "DeviceStateChanged",
"description": "Notification that a device state has changed.",
"properties": {
"device_state": {
"type": "DeviceState",
"description": "Device state object",
"required": true
}
}
}
{
"id": "Dial",
"description": "Dialing state has changed.",
"properties": {
"caller": {
"required": false,
"type": "Channel",
"description": "The calling channel."
},
"peer": {
"required": true,
"type": "Channel",
"description": "The dialed channel."
},
"forward": {
"required": false,
"type": "string",
"description": "Forwarding target requested by the original dialed channel."
},
"forwarded": {
"required": false,
"type": "Channel",
"description": "Channel that the caller has been forwarded to."
},
"dialstring": {
"required": false,
"type": "string",
"description": "The dial string for calling the peer channel."
},
"dialstatus": {
"required": true,
"type": "string",
"description": "Current status of the dialing attempt to the peer."
}
}
}
{
"id": "EndpointStateChange",
"description": "Endpoint state changed.",
"properties": {
"endpoint": {
"required": true,
"type": "Endpoint"
}
}
}
{
"id": "Event",
"description": "Base type for asynchronous events from Asterisk.",
"properties": {
"application": {
"type": "string",
"description": "Name of the application receiving the event.",
"required": true
},
"timestamp": {
"type": "Date",
"description": "Time at which this event was created.",
"required": true
}
},
"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"
]
}
{
"id": "Message",
"description": "Base type for errors and events",
"discriminator": "type",
"properties": {
"type": {
"type": "string",
"required": true,
"description": "Indicates the type of this message."
},
"asterisk_id": {
"type": "string",
"required": false,
"description": "The unique ID for the Asterisk instance that raised this event."
}
},
"subTypes": [
"MissingParams",
"Event"
]
}
{
"id": "MissingParams",
"description": "Error event sent when required params are missing.",
"properties": {
"params": {
"required": true,
"type": "List[string]",
"description": "A list of the missing parameters"
}
}
}
{
"id": "Peer",
"description": "Detailed information about a remote peer that communicates with Asterisk.",
"properties": {
"peer_status": {
"type": "string",
"description": "The current state of the peer. Note that the values of the status are dependent on the underlying peer technology.",
"required": true
},
"cause": {
"type": "string",
"description": "An optional reason associated with the change in peer_status.",
"required": false
},
"address": {
"type": "string",
"description": "The IP address of the peer.",
"required": false
},
"port": {
"type": "string",
"description": "The port of the peer.",
"required": false
},
"time": {
"type": "string",
"description": "The last known time the peer was contacted.",
"required": false
}
}
}
{
"id": "PeerStatusChange",
"description": "The state of a peer associated with an endpoint has changed.",
"properties": {
"endpoint": {
"required": true,
"type": "Endpoint"
},
"peer": {
"required": true,
"type": "Peer"
}
}
}
{
"id": "PlaybackContinuing",
"description": "Event showing the continuation of a media playback operation from one media URI to the next in the list.",
"properties": {
"playback": {
"type": "Playback",
"description": "Playback control object",
"required": true
}
}
}
{
"id": "PlaybackFinished",
"description": "Event showing the completion of a media playback operation.",
"properties": {
"playback": {
"type": "Playback",
"description": "Playback control object",
"required": true
}
}
}
{
"id": "PlaybackStarted",
"description": "Event showing the start of a media playback operation.",
"properties": {
"playback": {
"type": "Playback",
"description": "Playback control object",
"required": true
}
}
}
{
"id": "RecordingFailed",
"description": "Event showing failure of a recording operation.",
"properties": {
"recording": {
"type": "LiveRecording",
"description": "Recording control object",
"required": true
}
}
}
{
"id": "RecordingFinished",
"description": "Event showing the completion of a recording operation.",
"properties": {
"recording": {
"type": "LiveRecording",
"description": "Recording control object",
"required": true
}
}
}
{
"id": "RecordingStarted",
"description": "Event showing the start of a recording operation.",
"properties": {
"recording": {
"type": "LiveRecording",
"description": "Recording control object",
"required": true
}
}
}
{
"id": "StasisEnd",
"description": "Notification that a channel has left a Stasis application.",
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
}
}
{
"id": "StasisStart",
"description": "Notification that a channel has entered a Stasis application.",
"properties": {
"args": {
"required": true,
"type": "List[string]",
"description": "Arguments to the application"
},
"channel": {
"required": true,
"type": "Channel"
},
"replace_channel": {
"required": false,
"type": "Channel"
}
}
}
{
"id": "TextMessageReceived",
"description": "A text message was received from an endpoint.",
"properties": {
"message": {
"required": true,
"type": "TextMessage"
},
"endpoint": {
"required": false,
"type": "Endpoint"
}
}
}
{
"id": "Application",
"description": "Details of a Stasis application",
"properties": {
"name": {
"type": "string",
"description": "Name of this application",
"required": true
},
"channel_ids": {
"type": "List[string]",
"description": "Id's for channels subscribed to.",
"required": true
},
"bridge_ids": {
"type": "List[string]",
"description": "Id's for bridges subscribed to.",
"required": true
},
"endpoint_ids": {
"type": "List[string]",
"description": "{tech}/{resource} for endpoints subscribed to.",
"required": true
},
"device_names": {
"type": "List[string]",
"description": "Names of the devices subscribed to.",
"required": true
},
"events_allowed": {
"type": "List[object]",
"description": "Event types sent to the application.",
"required": true
},
"events_disallowed": {
"type": "List[object]",
"description": "Event types not sent to the application.",
"required": true
}
}
}
Fonte: Asterisk Wiki
POR QUE A LOJAMUNDI É CONFIÁVEL?
ENTRE EM CONTATO COM A LOJAMUNDI.
Assine nossa Newsletter! É gratuito!
Cadastre seu nome e email para receber novidades e materiais gratuitos da Lojamundi.