Versions Compared

Key

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

...

  • default_language: string - Default language for media playback.
  • max_channels: int (optional) - Maximum number of simultaneous channels.
  • max_load: double (optional) - Maximum load avg on system.
  • max_open_files: int (optional) - Maximum number of open file handles (files, sockets).
  • name: string - Asterisk system name.
  • setid: SetId - Effective user/group id for running Asterisk.

ConfigTuple

A key/value pair that makes up part of a configuration object.

Code Block
languagejavascript
collapsetrue

{
  "properties": {
    "attribute": {
      "required": true,
      "type": "string",
      "description": "A configuration object attribute."
    },
    "value": {
      "required": true,
      "type": "string",
      "description": "The value for the attribute."
    }
  },
  "id": "ConfigTuple",
  "description": "A key/value pair that makes up part of a configuration object."
}
  • attribute: string - A configuration object attribute.
  • value: string - The value for the attribute.

LogChannel

Details of an Asterisk log channel

Code Block
languagejavascript
collapsetrue

{
  "properties": {
    "status": {
      "required": true,
      "type": "string",
      "description": "Whether or not a log type is enabled"
    },
    "configuration": {
      "required": true,
      "type": "string",
      "description": "The various log levels"
    },
    "type": {
      "required": true,
      "type": "string",
      "description": "Types of logs for the log channel"
    },
    "channel": {
      "required": true,
      "type": "string",
      "description": "The log channel path"
    }
  },
  "id": "LogChannel",
  "description": "Details of an Asterisk log channel"
}
  • channel: string - The log channel path
  • configuration: string - The various log levels
  • status: string - Whether or not a log type is enabled
  • type: string - Types of logs for the log channel

Module

Details of an Asterisk module

Code Block
languagejavascript
collapsetrue

{
  "properties": {
    "use_count": {
      "required": true,
      "type": "int",
      "description": "The number of times this module is being used"
    },
    "status": {
      "required": true,
      "type": "string",
      "description": "The running status of this module"
    },
    "support_level": {
      "required": true,
      "type": "string",
      "description": "The support state of this module"
    },
    "name": {
      "required": true,
      "type": "string",
      "description": "The name of this module"
    },
    "description": {
      "required": true,
      "type": "string",
      "description": "The description of this module"
    }
  },
  "id": "Module",
  "description": "Details of an Asterisk module"
}
  • description: string - The description of this module
  • name: string - The name of this module
  • status: string - The running status of this module
  • support_level: string - The support state of this module
  • use_count: int - The number of times this module is being used

SetId

Effective user/group id

...

  • 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.

ChannelHold

Base type: Event

A channel initiated a media hold.

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."
}
  • 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.

ChannelLeftBridge

Base type: 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.

ChannelUnhold

Base type: Event

A channel initiated a media unhold.

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."
}
  • 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.

ChannelUserevent

Base type: Event

...

  • value: string - The new value of the variable.
  • variable: string - The variable that changed.

ContactInfo

Detailed information about a contact on an endpoint.

Code Block
languagejavascript
collapsetrue

{
  "properties": {
    "aor": {
      "required": true,
      "type": "string",
      "description": "The Address of Record this contact belongs to."
    },
    "uri": {
      "required": true,
      "type": "string",
      "description": "The location of the contact."
    },
    "roundtrip_usec": {
      "required": false,
      "type": "string",
      "description": "Current round trip time, in microseconds, for the contact."
    },
    "contact_status": {
      "allowableValues": {
        "valueType": "LIST",
        "values": [
          "Unreachable",
          "Reachable",
          "Unknown",
          "Created",
          "Removed"
        ]
      },
      "required": true,
      "type": "string",
      "description": "The current status of the contact."
    }
  },
  "id": "ContactInfo",
  "description": "Detailed information about a contact on an endpoint."
}
  • aor: string - The Address of Record this contact belongs to.
  • contact_status: string - The current status of the contact.
  • roundtrip_usec: string (optional) - Current round trip time, in microseconds, for the contact.
  • uri: string - The location of the contact.

ContactStatusChange

Base type: Event

The state of a contact on an endpoint has changed.

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."
}
  • 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

DeviceStateChanged

Base type: Event

...

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

...

Code Block
languagejavascript
collapsetrue
{
  "subTypes": [
    "DeviceStateChanged",
    "PlaybackStarted",
    "PlaybackFinished",
    "RecordingStarted",
    "RecordingFinished",
    "RecordingFailed",
    "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."
}

...

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

...

  • type: string - Indicates the type of this message.
  • params: List[string] - A list of the missing parameters

Peer

Detailed information about a remote peer that communicates with Asterisk.

Code Block
languagejavascript
collapsetrue

{
  "properties": {
    "peer_status": {
      "required": true,
      "type": "string",
      "description": "The current state of the peer. Note that the values of the status are dependent on the underlying peer technology."
    },
    "time": {
      "required": false,
      "type": "string",
      "description": "The last known time the peer was contacted."
    },
    "cause": {
      "required": false,
      "type": "string",
      "description": "An optional reason associated with the change in peer_status."
    },
    "port": {
      "required": false,
      "type": "string",
      "description": "The port of the peer."
    },
    "address": {
      "required": false,
      "type": "string",
      "description": "The IP address of the peer."
    }
  },
  "id": "Peer",
  "description": "Detailed information about a remote peer that communicates with Asterisk."
}
  • address: string (optional) - The IP address of the peer.
  • cause: string (optional) - An optional reason associated with the change in peer_status.
  • peer_status: string - The current state of the peer. Note that the values of the status are dependent on the underlying peer technology.
  • port: string (optional) - The port of the peer.
  • time: string (optional) - The last known time the peer was contacted.

PeerStatusChange

Base type: Event

The state of a peer associated with an endpoint has changed.

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."
}
  • 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

PlaybackFinished

Base type: Event

...