AbsoluteTimeout
Описание
Выполняет разъединение канала по прошествии определенного времени
Синтаксис
Action: AbsoluteTimeout ActionID: <value> Channel: <value> Timeout: <value>
Аргументы
Примечание
Asterisk подтвердит установку времени ожидания сообщением Timeout Set.
Response: Success Message: Timeout Set
AgentLogoff
Описание
Отменяет регистрацию указанного агента в системе очереди вызовов.
Аргументы
Права
agent, all
Синтаксис
Action: AgentLogoff ActionID: <value> Agent: <value> Soft: <value>
Пример
Команда:
Action: AgentLogoff Agent: 902 Soft: true ActionID: rom-asterisk-agentlogoff-902
Ответ:
Response: Success Message: Agent logged out ActionID: rom-asterisk-agentlogoff-902
Agents
Описание
Данная команда служит для предоставления списка с информацией обо всех сконфигурированных агентах.
Привилегии
agent, all
Синтаксис
Action: Agents ActionID: <value>
Аргументы
AGI
Описание
Add an AGI command to the execute queue of the channel in Async AGI.
Синтаксис
Action: AGI ActionID: <value> Channel: <value> Command: <value> CommandID: <value>
Аргументы
Atxfer
Описание
Условный (сопровождаемый) перевод звонка
Синтаксис
Action: Atxfer ActionID: <value> Channel: <value> Exten: <value> Context: <value> Priority: <value>
Аргументы
Bridge
Описание
Соединяет 2 канала вместе.
Синтаксис
Action: Bridge ActionID: <value> Channel1: <value> Channel2: <value> Tone: <value>
Аргументы
ChangeMonitor
Описание
Меняет имя файла для записи разговора по каналу.
Команда ChangeMonitor может использоваться для изменения файла, запись которого была начата ранее по команде Monitor.
Привилегии
call, all
Синтаксис
Action: ChangeMonitor ActionID: <value> Channel: <value> File: <value>
Агрументы
Command
Выполняет CLI-команду Asterisk так, как если бы она выполнялась из CLI.
Привилегии
command, all
Синтаксис
Action: Command ActionID: <value> Command: <value>
Аргументы
Пример
Команда:
Action: Command Command: core show version ActionID: 0123456789abcdef
Ответ:
Response: Follows Privilege: Command ActionID: 0123456789abcdef Asterisk SVN-branch-1.4-r55869 built by jsmith @ hockey on a ppc running Linux on 2007-02-21 16:55:26 UTC --END COMMAND——
ConfbridgeKick
Описание
Kick a Confbridge user.
Синтаксис
Action: ConfbridgeKick ActionID: <value> Conference: <value> Channel: <value>
Аргументы
ConfbridgeList
Описание
Lists all users in a particular ConfBridge conference. ConfbridgeList will follow as separate events, followed by a final event called ConfbridgeListComplete.
Синтаксис
Action: ConfbridgeList ActionID: <value> Conference: <value>
Аргументы
ConfbridgeListRooms
Описание
Список данных о всех активных конференциях.
Элементы списка будут отображены как отдельные события, завершающиеся строкой «ConfbridgeListRoomsComplete»
Синтаксис
Action: ConfbridgeListRooms ActionID: <value>
Аргументы
ConfbridgeLock
Описание
Заблокировать Confbridge-конференцию
Описание
Action: ConfbridgeLock ActionID: <value> Conference: <value>
Аргументы
ConfbridgeMute
Описание
Отключение звука пользователю Confbridge.
Синтаксис
Action: ConfbridgeMute ActionID: <value> Conference: <value> Channel: <value>
Аргументы
ConfbridgeSetSingleVideoSrc
Описание
Установить пользователя конференции в качестве единственного источника видео для распространения среди всех других участников.
Синтаксис
Action: ConfbridgeSetSingleVideoSrc ActionID: <value> Conference: <value> Channel: <value>
Аргументы
ConfbridgeStartRecord
Описание
Старт записи конференции. Если запись уже присутствует будет возвращена ошибка. Если RecordFile не предусмотрен, будет использован файл записи по умолчанию, указанный в профиле конференции. Если нет ни того, ни другого, тогда файл будет сгенерирован автоматически в каталоге monitor
Синтаксис
Action: ConfbridgeStartRecord ActionID: <value> Conference: <value> [RecordFile:] <value>
Аргументы
ConfbridgeStopRecord
Описание
Останавливает запись в конференции
Синтаксис
Action: ConfbridgeStopRecord ActionID: <value> Conference: <value>
Синтаксис
ConfbridgeUnlock
Описание Разблокировать конференцию
Синтаксис
Action: ConfbridgeUnlock ActionID: <value> Conference: <value>
Аргументы
ConfbridgeUnmute
Описание Включить звук пользователю конференции
Синтаксис
Action: ConfbridgeUnmute ActionID: <value> Conference: <value> Channel: <value>
Аргументы
CoreSettings
Описание Запрос информации о настройках PBX (версия и т.д.)
Синтаксис
Action: CoreSettings ActionID: <value>
Аргументы
Пример
Action: CoreSettings Response: Success AMIversion: 1.1 AsteriskVersion: 1.8.8.0 SystemName: CoreMaxCalls: 0 CoreMaxLoadAvg: 0.000000 CoreRunUser: CoreRunGroup: CoreMaxFilehandles: 0 CoreRealTimeEnabled: No CoreCDRenabled: Yes CoreHTTPenabled: Yes
CoreShowChannels
Описание Список текущих активных каналов и информация о них
Синтаксис
Action: CoreShowChannels ActionID: <value>
Аргументы
Примечание
Каждый элемент списка выводится отдельно.
Событие начала списка:
Response: Success EventList: start Message: Channels will follow
Событие окончания списка:
Event: CoreShowChannelsComplete EventList: Complete ListItems: 0
CoreStatus
Описание Запрос переменных статуса ядра PBX.
Синтаксис
Action: CoreStatus ActionID: <value>
Аргументы
Пример
Action: CoreStatus Response: Success CoreStartupDate: 2013-04-10 CoreStartupTime: 10:47:31 CoreReloadDate: 2013-04-10 CoreReloadTime: 10:47:31 CoreCurrentCalls: 0
CreateConfig
Описание
Создает пустой файл в конфигурационном каталоге. Вызывается перед UpdateConfig.
Синтаксис
Action: CreateConfig ActionID: <value> Filename: <value>
Аргументы
DAHDIDialOffhook
Описание
Dial over DAHDI channel while offhook.
Generate DTMF control frames to the bridged peer.
Синтаксис
Action: DAHDIDialOffhook ActionID: <value> DAHDIChannel: <value> Number: <value>
Аргументы
DAHDIDNDoff
Описание
Переключает режим «Не беспокоить» (Do Not Disturb) DAHDI-канала в положение «OFF»
Эквивалентно команде CLI «dahdi set dnd channel off».
Синтаксис
Action: DAHDIDNDoff ActionID: <value> DAHDIChannel: <value>
Аргументы
DAHDIDNDon
Описание
Переключает режим «Не беспокоить» (Do Not Disturb) DAHDI-канала в положение «ON»
Эквивалентно команде CLI «dahdi set dnd channel on».
Синтаксис
Action: DAHDIDNDon ActionID: <value> DAHDIChannel: <value>
Аргументы
DAHDIHangup
Описание Подожить трубку DAHDI-канала
Симуляция события положить трубку для пользователя, подключенного к каналу
Синтаксис
Action: DAHDIHangup ActionID: <value> DAHDIChannel: <value>
Аргументы
DAHDIRestart
Описание
Полный рестарт канала DAHDI (звонки завершаются).
Эквивалент команды CLI: «dahdi restart».
Синтаксис
Action: DAHDIRestart ActionID: <value>
Аргументы
DAHDIShowChannels
Описание
Show status of DAHDI channels.
Similar to the CLI command «dahdi show channels».
Синтаксис
Action: DAHDIShowChannels ActionID: <value> DAHDIChannel: <value>
Аргументы
DAHDITransfer
Описание Перевод DAHDI-канала
Simulate a flash hook event by the user connected to the channel.
Синтаксис
Action: DAHDITransfer ActionID: <value> DAHDIChannel: <value>
Аргументы
DataGet
Описание
Retrieve the data api tree.
Синтаксис
Action: DataGet ActionID: <value> Path: <value> Search: <value> Filter: <value>
Аргументы
DBGet
Описание Извлекает значение из базы данных AstDB.
Аргументы
Привилегии system, all
Синтаксис
Action: DBGet ActionID: <value> Family: <value> Key: <value>
Пример
Action: DBGet Family: testfamily Key: mykey ActionID: 01234-astdb-43210 Response: Success Message: Result will follow ActionID: 01234-astdb-43210
Ответ:
Event: DBGetResponse Family: testfamily Key: mykey Val: 42 ActionID: 01234-astdb-43210
DBPut
Описание
Задает значение ключа в базе данных AstDB.
Синтаксис
Action: DBPut ActionID: <value> Family: <value> Key: <value> Val: <value>
Аргументы
Привилегии system, all
Пример
Запрос:
Action: DBPut Family: testfamily Key: mykey Val: 42 ActionID: testing123
Ответ:
Response: Success Message: Updated database successfully ActionID: testing123
Events
Описание Управляет потоком событий. Активирует или отключает отправку событий на это соединение интерфейса Manager
Синтаксис
Action: Events ActionID: <value> EventMask: <value>
Аргументы
Привилегии none
Пример
Action: Events EventMask: off ActionID: 2938416 Response: Events Off ActionID: 2938416
Action: Events EventMask: log,call ActionID: blah1234 Response: Events On ActionID: blah1234
ExtensionState
Описание
Cообщает о состоянии заданного добавочного номера. Если добавочный номер имеет подсказку, эта команда обеспечит передачу состояния устройства, соединенного с данным добавочным номером.
Синтаксис
Action: ExtensionState ActionID: <value> Exten: <value> Context: <value>
Аргументы
Привилегии
call, all
Пример
Запрос:
Action: ExtensionState Exten: 200 Context: lab ActionID: 54321
Ответ:
Response: Success ActionID: 54321 Message: Extension Status Exten: 200 Context: lab Hint: SIP/testphone Status: 0
Примечания
Возможные состояния добавочного номера:
GetConfig
Описание
Извлекает данные из конфигурационного файла Asterisk.
Синтаксис
Action: GetConfig ActionID: <value> Filename: <value> Category: <value>
Аргументы
Привилегии
config, all
Пример
Запрос:
Action: GetConfig Filename: musiconhold.conf ActionID: 09235012
Ответ:
Response: Success ActionID: 09235012 Category-000000: default Line-000000-000000: mode=files Line-000000-000001: directory=/var/lib/asterisk/moh Line-000000-000002: random=yes
GetConfigJSON
Описание
Извлекает конфигурацию в JSON-формате. Имеет смысл при использовании rawman поверх HTTP.
Синтаксис
Action: GetConfigJSON ActionID: <value> Filename: <value>
Аргументы
GetVar
Описание
Возвращает значение локальной переменной канала или глобальной переменной.
Синтаксис
Action: Getvar ActionID: <value> Channel: <value> Variable: <value>
Аргументы
Привилегии
call, all
Пример
Запрос:
Action: GetVar Channel: SIP/linksys2-1020e2b0 Variable: SIPUSERAGENT ActionID: abcd1234
Ответ:
Response: Success Variable: SIPUSERAGENT Value: Linksys/SPA962-5.1.5 ActionID: abcd1234
Запрос:
Action: GetVar Variable: TRUNKMSD
Ответ:
Response: Success Variable: TRUNKMSD Value: 1
Hangup
Выполняет разрыв соединения по заданному каналу.
Синтаксис
Action: Hangup ActionID: <value> Channel: <value> Cause: <value>
Аргументы
Привилегии
call, all
Пример
Команда:
Action: Hangup Channel: SIP/labrat-8d3a
Ответ:
Response: Success Message: Channel Hungup Event: Hangup Privilege: call,all Channel: SIP/labrat-8d3a Uniqueid: 1173448206.0 Cause: 0 Cause-txt: Unknown
IAXNetstats
Описание
Представляет сводку статистки сетевой активности драйвера IAX2-канала.
Синтаксис
Action: IAXnetstats
Привилегии
none
Пример
Команда:
Action: IAXNetstats
Ответ:
IAX2/216.207.245.8:4569-1 608 -1 0 -1 -1 0 -1 1 288 508 10 1 3 0 0
IAXpeerlist
Описание
Список всех IAX пиров.
Синтаксис
Action: IAXpeerlist ActionID: <value>
Аргументы
IAXpeers
Описание
Список IAX пиров. Каждый элемент выводится отдельно в виде события Event: PeerEntry
Синтаксис
Action: IAXpeers ActionID: <value>
Аргументы
Примечание Asterisk Manager ответит списком элементов, который начинается с события:
Response: Success EventList: start Message: Peer status list will follow
Заканчивается список событием:
Event: PeerlistComplete EventList: Complete
Пример
Action: IAXpeers
Ответ:
Response: Success EventList: start Message: Peer status list will follow Event: PeerEntry Channeltype: IAX2 ObjectName: 907 ChanObjectType: peer IPaddress: (null) IPport: 0 Dynamic: yes Trunk: no Encryption: no Status: UNKNOWN Event: PeerlistComplete EventList: Complete ListItems: 1
IAXregistry
Описание
Показать IAX-регистрации.
Синтаксис
Action: IAXregistry ActionID: <value>
Аргументы
Примечание
Каждый элемент списка регистраций выводится отдельно событием Event: Registry.
Событие начала списка:
Response: Success EventList: start Message: Registrations will follow
Событие окончания списка:
Event: RegistrationsComplete EventList: Complete ListItems: 0
JabberSend
Описание
Посылает сообщение в Jabber-клиент
Синтаксис
Action: JabberSend ActionID: <value> Jabber: <value> JID: <value> Message: <value>
Аргументы
ListCategories
Описание
Список категорий в конфигурационном файле
Синтаксис
Action: ListCategories ActionID: <value> Filename: <value>
Аргументы
ListCommands
Описание
Создает список всех команд интерфейса Asterisk Manager с указанием имени команды и краткого описания каждой из них
Привилегии
none
Синтаксис
Action: ListCommands ActionID: <value>
Аргументы
Пример
Команда:
Action: ListCommands
Ответ:
Response: Success AbsoluteTimeout: Set Absolute Timeout (Priv: call,all) AgentLogoff: Sets an agent as no longer logged in (Priv: agent,all) . . . ZapTransfer: Transfer Zap Channel (Priv: <none>)
LocalOptimizeAway
Описание Optimize away a local channel when possible.
A local channel created with «/n» will not automatically optimize away. Calling this command on the local channel will clear that flag and allow it to optimize away if it's bridged or when it becomes bridged.
Синтаксис
Action: LocalOptimizeAway ActionID: <value> Channel: <value>
Аргументы
Login
Описание Залогиниться в Asterisk Manager
Синтаксис
Action: Login ActionID: <value> Username: <value> Secret: <value>
Аргументы
Пример
Action: Login Username: amiuser Secret: password1234
Ответ:
Response: Success Message: Authentication accepted
Logoff
Описание
Завершает сеанс интерфейса Manager
Привилегии
none
Синтаксис
Action: Logoff ActionID: <value>
Аргументы
Пример
Action: Logoff
Ответ:
Response: Goodbye Message: Thanks for all the fish
MailboxCount
Описание
Возвращает количество сообщений в заданном ящике голосовой почты.
Привилегии
call, all
Синтаксис
Action: MailboxCount ActionID: <value> Mailbox: <value>
Аргументы
Пример
Action: MailboxCount Mailbox: 902@default
Ответ:
Response: Success Message: Mailbox Message Count Mailbox: 902@default UrgMessages: 0 NewMessages: 2 OldMessages: 0
MailboxStatus
Описание
Проверяет статус заданного ящика голосовой почты.
Синтаксис
Action: MailboxStatus ActionID: <value> Mailbox: <value>
Аргументы
Привилегии
call, all
Пример
Action: MailboxStatus Mailbox: 900@default
Ответ:
Response: Success Message: Mailbox Status Mailbox: 900@default Waiting: 1
MeetmeList
Описание
Список всех пользователей в конкретной конференции. Каждый элементы списка выводится отдельно.
Событие начала списка: MeetmeList will follow
Событие окончания списка: MeetmeListComplete
Синтаксис
Action: MeetmeList ActionID: <value> [Conference:] <value>
Аргументы
MeetmeListRooms
Описание
Спискок активных конференций. Каждый элементы списка выводится отдельно.
Событие начала списка: MeetmeListRooms will follow
Событие окончания списка: MeetmeListRoomsComplete
Синтаксис
Action: MeetmeListRooms ActionID: <value>
Аргументы
MeetmeMute
Описание
Выключает микрофон конкретного пользователя, участвующего в конференции MeetMe.
Привилегии
call, all
Синтаксис
Action: MeetmeMute ActionID: <value> Meetme: <value> Usernum: <value>
Аргументы
Пример
Action: MeetmeMute Meetme: 104 Usernum: 1 ActionID: 5432154321
Ответ:
Response: Success ActionID: 5432154321 Message: User muted
MeetmeUnmute
Описание
Включает микрофон конкретного пользователя, участвующего в конференции MeetMe.
Синтаксис
Action: MeetmeUnmute ActionID: <value> Meetme: <value> Usernum: <value>
Аргументы
MessageSend
Описание Отправить сообщение для конечной точки
Синтаксис
Action: MessageSend ActionID: <value> To: <value> From: <value> Body: <value> Base64Body: <value> Variable: <value>
Аргументы
Technology: SIP
Specifying a prefix of sip: will send the message as a SIP MESSAGE request.
Technology: XMPP
Specifying a prefix of xmpp: will send the message as an XMPP chat message.
Technology: SIP
The from parameter can be a configured peer name or in the form of «display-name» <URI>.
Technology: XMPP
Specifying a prefix of xmpp: will specify the account defined in xmpp.conf to send the message from. Note that this field is required for XMPP messages.
MixMonitor
Описание
Записывает разговор и микширует аудио в процессе записи
Синтаксис
Action: MixMonitor ActionID: <value> Channel: <value> File: <value> options: <value>
Аргументы
MixMonitorMute
Описание
Включение / Отключение записи через Mixmonitor
Синтаксис
Action: MixMonitorMute ActionID: <value> Channel: <value> Direction: <value> State: <value>
Аргументы
ModuleCheck
Описание
Проверка загружен ли модуль. Возвращает Success
или Failure
.
В случае успеха возвращает номер ревизии модуля.
Action: ModuleCheck Module: <value>
Аргументы
ModuleLoad
Описание Module management.
Загрузка, выгрузка, перезагрузка модуля Asterisk.
Синтаксис
Action: ModuleLoad ActionID: <value> Module: <value> LoadType: <value>
Аргументы
Если для модуля не указан reload loadtype
выполняется reload.
Monitor
Описание
Записывает аудиоданные, передаваемые по каналу, в заданный файл.
Синтаксис
Syntax Action: Monitor ActionID: <value> Channel: <value> File: <value> Format: <value> Mix: <value>
Аргументы
MuteAudio
Описание
Отключает входящий или исходящий аудиопоток на канале
Синтаксис
Action: MuteAudio ActionID: <value> Channel: <value> Direction: <value> State: <value>
Аргументы
Originate
Описание
Формирует исходящий вызов из Asterisk и соединяет канал с контекстом/добавочным номером/приоритетом или приложением диалплана.
Синтаксис
Action: Originate ActionID: <value> Channel: <value> Exten: <value> Context: <value> Priority: <value> Application: <value> Data: <value> Timeout: <value> CallerID: <value> Variable: <value> Account: <value> EarlyMedia: <value> Async: <value> Codecs: <value>
Аргументы
Привилегии
call, all
Пример
Команда:
Action: Originate Channel: SIP/linksys2 Context: lab Exten: 201 Priority: 1 CallerID:
Ответ:
Response: Success Message: Originate successfully queued
Команда:
Action: Originate Application: MusicOnHold Data: default Channel: SIP/linksys2
Ответ:
Response: Success Message: Originate successfully queued
Event: OriginateResponse
Park
Описание
Выполняет парковку заданного канала в слот парковки.
Синтаксис
Action: Park ActionID: <value> Channel: <value> Channel2: <value> Timeout: <value> Parkinglot: <value>
Аргументы
Привилегии
call, all
Пример
Action: Park Channel: SIP/linksys-10228fb0 Channel2: SIP/linksys2-10231520 Timeout: 45 ActionID: parking-test-01
Ответ:
Response: Success ActionID: parking-test-01 Message: Park successful
ParkedCalls
Описание
Создает список всех вызовов, припаркованных в слоте парковки вызовов.
Привилегии
none
Синтаксис
Action: ParkedCalls ActionID: <value>
Аргументы
Пример
Action: ParkedCalls ActionID: 0982350175
Ответ:
Response: Success ActionID: 0982350175 Message: Parked calls will follow Event: ParkedCall Exten: 701 Channel: SIP/linksys2-101f98a8 From: SIP/linksys2-101f98a8 Timeout: 26 CallerID: linksys2 CallerIDName: linksys2 ActionID: 0982350175 Event: ParkedCallsComplete ActionID: 0982350175
Parkinglots
Описание
Получает список парковочных слотов в виде серии событий AMI.
Синтаксис
Action: Parkinglots ActionID: <value>
Аргументы
PauseMonitor
Описание
Приостанавливает отслеживание (запись) канала, для которого производится запись разговоров.
Аргументы
Привилегии
call, all
Синтаксис
Action: PauseMonitor ActionID: <value> Channel: <value>
Пример
Action: PauseMonitor Channel: SIP/linksys2-10212040 ActionID: 987987987987
Ответ:
Response: Success ActionID: 987987987987 Message: Paused monitoring of the channel
Ping
Описание
Поддерживает соединение активным. Посылает запрос на сервер Asterisk, чтобы убедиться, что он до сих пор отвечает. Asterisk ответит сообщением Pong. Эта команда также может использоваться, чтобы не допустить разрыва соединения в результате истечения времени ожидания.
Синтаксис
Action: Ping ActionID: <value>
Аргументы
Пример
Action: Ping Response: Pong
PlayDTMF
Описание
Передает DTMF-код в заданный канал.
Синтаксис
Action: PlayDTMF ActionID: <value> Channel: <value> Digit: <value>
Аргументы
Привилегии
call, all
Пример
Action: PlayDTMF Channel: Local/201@lab-157a,1 Digit: 9
Ответ:
Response: Success Message: DTMF successfully queued
PresenceState
Описание
Check Presence State. Report the presence state for the given presence provider.
Will return a Presence State message. The response will include the presence state and, if set, a presence subtype and custom message.
Синтаксис
Action: PresenceState ActionID: <value> Provider: <value>
Аргументы
PRIShowSpans
Описание Show status of PRI spans. Similar to the CLI command «pri show spans».
Синтаксис
Action: PRIShowSpans ActionID: <value> Span: <value>
Аргументы
QueueAdd
Описание
Добавляет участника обработки очереди вызовов.
Синтаксис
Action: QueueAdd ActionID: <value> Queue: <value> Interface: <value> Penalty: <value> Paused: <value> MemberName: <value> StateInterface: <value>
Аргументы
Привилегии
agent, all
Пример
Action: QueueAdd Queue: myqueue Interface: SIP/testphone MemberName: Jared Smith Penalty: 2 Paused: no ActionID: 4242424242
Ответ:
Response: Success ActionID: 4242424242 Message: Added interface to queue Event: QueueMemberAdded Privilege: agent,all Queue: myqueue Location: SIP/testphone MemberName: Jared Smith Membership: dynamic Penalty: 2 CallsTaken: 0 LastCall: 0 Status: 1 Paused: 0
QueueLog
Описание
Добавляет произвольную запись в queue_log.
Синтаксис
Action: QueueLog ActionID: <value> Queue: <value> Event: <value> Uniqueid: <value> Interface: <value> Message: <value>
Аргументы
QueueMemberRingInUse
Описание
Set the ringinuse value for a queue member.
Синтаксис
Action: QueueMemberRingInUse ActionID: <value> Interface: <value> RingInUse: <value> Queue: <value>
Аргументы
QueuePause
Описание
Приостанавливает или возобновляет работу участника обработки очереди вызовов.
Синтаксис
Action: QueuePause ActionID: <value> Interface: <value> Paused: <value> Queue: <value> Reason: <value>
Аргументы
Привилегии
agent, all
Пример
Action: QueuePause Interface: SIP/902 Paused: true Queue: 8000
Ответ:
Response: Success Message: Interface paused successfully Event: QueueMemberPaused Privilege: agent,all Queue: 8000 Location: SIP/902 MemberName: Service Desk Line 1 Paused: 1
QueuePenalty
Описание
Устанавливает пенальти для участника очереди
Синтаксис
Action: QueuePenalty ActionID: <value> Interface: <value> Penalty: <value> Queue: <value>
Аргументы
QueueReload
Описание Перезагрузка очереди, очередей, или каких-то подсекций очереди или очередей.
Описание
Action: QueueReload ActionID: <value> Queue: <value> Members: <value> Rules: <value> Parameters: <value>
Аргументы
QueueRemove
Описание
Удаляет интерфейс из очереди вызовов.
Синтаксис
Action: QueueRemove ActionID: <value> Queue: <value> Interface: <value>
Аргументы
Привилегии
agent, all
Пример
Action: QueueRemove Queue: 8000 Interface: SIP/902
Ответ:
Response: Success Message: Removed interface from queue Event: QueueMemberRemoved Privilege: agent,all Queue: myqueue Location: SIP/902 MemberName: Service Desk Line 1
QueueReset
Описание Сбросить статистику очереди
Синтаксис
Action: QueueReset ActionID: <value> Queue: <value>
Аргументы
QueueRule
Описание
Правила очереди
Синтаксис
Action: QueueRule ActionID: <value> Rule: <value>
Аргументы
Queues
Описание Информация об очередях
Синтаксис
Action: Queues
Пример
Action: Queues 8000 has 0 calls (max unlimited) in 'linear' strategy (7s holdtime, 9s talktime), W:0, C:6, A:53, SL:83.3% within 60s Members: Sales manager 2 (SIP/902) with penalty 1 (dynamic) (paused) (Not in use) has taken no calls yet Service Desk Line 1 (SIP/911) with penalty 1 (dynamic) (Not in use) has taken no calls yet No Callers
Примечания Эта команда интерфейса Manager обеспечивает вывод, аналогичный выводу команды show queues интерфейса командной строки Asterisk.
QueueStatus
Описание
Проверяет статус одной или более очередей вызовов.
Примечание Возвращается серия событий.
Событие начала списка:
Response: Success Message: Queue status will follow
Событие окончания списка:
Event: QueueStatusComplete
Элементы описания параметров очереди: Event: QueueParams
Элементы описания участника очереди: Event: QueueMember
Синтаксис
Action: QueueStatus ActionID: <value> Queue: <value> Member: <value>
Аргументы
Привилегии
none
Пример
Action: QueueStatus Response: Success Message: Queue status will follow Event: QueueParams Queue: 8000 Max: 0 Strategy: linear Calls: 0 Holdtime: 7 TalkTime: 9 Completed: 6 Abandoned: 53 ServiceLevel: 60 ServicelevelPerf: 83.3 Weight: 0 Event: QueueMember Queue: 8000 Name: Service Desk Line 1 Location: SIP/902 Membership: dynamic Penalty: 1 CallsTaken: 0 LastCall: 0 Status: 1 Paused: 1 Event: QueueStatusComplete
QueueSummary
Описание
Показывает итоги по очереди.
События начала списка:
Response: Success Message: Queue summary will follow
События окночания списка:
Event: QueueSummaryComplete
Элементы списка выводятся в виде событий: Event: QueueSummary
Синтаксис
Action: QueueSummary ActionID: <value> Queue: <value>
Аргументы
Пример
Action: QueueSummary Response: Success Message: Queue summary will follow Event: QueueSummary Queue: 8000 LoggedIn: 2 Available: 1 Callers: 0 HoldTime: 7 TalkTime: 9 LongestHoldTime: 0 Event: QueueSummaryComplete
Redirect
Описание
Перенаправляет канал в новый контекст, добавочный номер и приоритет диалплана.
Синтаксис
Action: Redirect ActionID: <value> Channel: <value> ExtraChannel: <value> Exten: <value> ExtraExten: <value> Context: <value> ExtraContext: <value> Priority: <value> ExtraPriority: <value>
Аргументы
Привилегии
call, all
Пример
Action: Redirect Channel: SIP/902-10201e90 Context: from-internal Exten: 900 Priority: 1 ActionID: 010123234545 Response: Success ActionID: 010123234545 Message: Redirect successful
Reload
Описание
Посылает событие Reload
Описание
Action: Reload ActionID: <value> Module: <value>
Аргументы
SendText
Описание
Послать текстовое сообщение в канал, в процессе звонка.
Синтаксис
Action: SendText ActionID: <value> Channel: <value> Message: <value>
Аргументы
SetVar
Описание
Задает значение глобальной переменной или переменной канала.
Синтаксис
Action: Setvar ActionID: <value> Channel: <value> Variable: <value> Value: <value>
Аргументы
Привилегии
call, all
Пример
Action: SetVar Channel: SIP/902-10225140 Variable: MyChannelVariable Value: 42 Response: Success Message: Variable Set Action: SetVar Variable: MyGlobalVariable Value: 25 Response: Success Message: Variable Set
ShowDialPlan
Описание
Показать контексты диалплана и экстеншенов.
Описание
Action: ShowDialPlan ActionID: <value> Extension: <value> Context: <value>
Аргументы
SIPnotify
Описание
Отправить событие оповещения.
Все параметры этого события должны быть определены в теле запроса. Для использования нескольких переменных используйте конструкцию Variable: name=value
Синтаксис
Action: SIPnotify ActionID: <value> Channel: <value> Variable: <value>
Аргументы
SIPpeers
Описание
Создает список сконфигурированных в данный момент равноправных участников SIP с указанием их статуса.
Событие начало списка:
Response: Success Message: Peer status list will follow
Событие окончания списка:
Event: PeerlistComplete
Элементы списка выводятся в виде серии событий Event: PeerEntry
Синтаксис
Action: SIPpeers ActionID: <value>
Аргументы
Привилегии
system, all
Пример
Action: SIPPeers ActionID: 1234567890 Response: Success ActionID: 1234567890 Message: Peer status list will follow Event: PeerEntry ActionID: 1234567890 Channeltype: SIP ObjectName: 902 ChanObjectType: peer IPaddress: 192.168.0.77 IPport: 5060 Dynamic: no Natsupport: no VideoSupport: no ACL: no Status: OK (18 ms) RealtimeDevice: no Event: PeerlistComplete ListItems: 1 ActionID: 1234567890
SIPpeerstatus
Описание
Запрашивает статус одного или всех участников SIP.
Синтаксис
Action: SIPpeerstatus ActionID: <value> [Peer:] <value>
Аргументы
SIPqualifypeer
Описание
Показать квалифицированных участников SIP
Синтаксис
Action: SIPqualifypeer ActionID: <value> Peer: <value>
Аргументы
Пример
Action: SIPqualifypeer Peer: KS-sip Event: PeerStatus Privilege: system,all ChannelType: SIP Peer: SIP/KS-sip PeerStatus: Lagged Time: 60
SIPShowPeer
Описание
Представляет подробную информацию о сконфигурированном равноправном участнике SIP.
Синтаксис
Action: SIPshowpeer ActionID: <value> Peer: <value>
Аргументы
Привилегии
system, all
Пример
Action: SIPshowpeer Peer: 902 Response: Success Channeltype: SIP ObjectName: 902 ChanObjectType: peer SecretExist: Y RemoteSecretExist: N MD5SecretExist: N Context: from-internal Language: ru AMAflags: Unknown CID-CallingPres: Presentation Allowed, Not Screened Callgroup: 1 Pickupgroup: 1 MOHSuggest: VoiceMailbox: 902@device TransferMode: open LastMsgsSent: -1 Maxforwards: 0 Call-limit: 2147483647 Busy-level: 0 MaxCallBR: 384 kbps Dynamic: Y Callerid: "Service Desk Line 1" <902> RegExpire: 697 seconds SIP-AuthInsecure: no SIP-Forcerport: N ACL: Y SIP-CanReinvite: N SIP-DirectMedia: N SIP-PromiscRedir: N SIP-UserPhone: N SIP-VideoSupport: Y SIP-TextSupport: N SIP-T.38Support: Y SIP-T.38EC: FEC SIP-T.38MaxDtgrm: -1 SIP-Sess-Timers: Accept SIP-Sess-Refresh: uas SIP-Sess-Expires: 1800 SIP-Sess-Min: 90 SIP-RTP-Engine: asterisk SIP-Encryption: N SIP-DTMFmode: rfc2833 ToHost: Address-IP: 192.168.0.17 Address-Port: 12558 Default-addr-IP: (null) Default-addr-port: 0 Default-Username: 902 Codecs: 0xc (ulaw|alaw) CodecOrder: ulaw,alaw Status: OK (101 ms) SIP-Useragent: X-Lite release 1104o stamp 56125 Reg-Contact: sip:902@192.168.0.17:12558;rinstance=b865e2f4dde0d2ac QualifyFreq: 60000 ms Parkinglot: SIP-Use-Reason-Header: N
SIPshowregistry
Описание
Список всех регистрационных запросов и их статус. Элементы списка регистрации выводятся отдельно.
Событие начала списка: Registrations will follow
Событие окончания списка: RegistrationsComplete
Элементы списка выводятся в виде серии событий: Event: RegistryEntry
Синтаксис
Action: SIPshowregistry ActionID: <value>
Аргументы
Пример
Action: SIPshowregistry Response: Success EventList: start Message: Registrations will follow Event: RegistryEntry Host: sip.skype.com Port: 5060 Username: 12345678901234 Domain: sip.skype.com DomainPort: 5060 Refresh: 105 State: Registered RegistrationTime: 1363530907 Event: RegistrationsComplete EventList: Complete ListItems: 1
SKINNYdevices
Описание
Lists Skinny devices in text format with details on current status. Devicelist will follow as separate events, followed by a final event called DevicelistComplete.
Синтаксис
Action: SKINNYdevices ActionID: <value>
Аргументы
SKINNYlines
Описание
Lists Skinny lines in text format with details on current status. Linelist will follow as separate events, followed by a final event called LinelistComplete.
Синтаксис
Action: SKINNYlines ActionID: <value>
Аргументы
SKINNYshowdevice
Описание
Show one SKINNY device with details on current status.
Синтаксис
Action: SKINNYshowdevice ActionID: <value> Device: <value>
Аргументы
SKINNYshowline
Описание
Show one SKINNY line with details on current status.
Синтаксис
Action: SKINNYshowline ActionID: <value> Line: <value>
Аргументы
Status
Описание
Представляет статус одного или более каналов с подробной информацией об их текущем состоянии.
Синтаксис
Action: Status ActionID: <value> Channel: <value> Variables: <value>
Аргументы
Привилегии
call, all
Пример
Action: Status Channel: SIP/902-111222333 ActionID: 1234567890 Response: Success ActionID: 1234567890 Message: Channel status will follow Event: Status Privilege: Call Channel: SIP/902-111222333 CallerID: "Service Desk Line 1" <902> CallerIDNum: 902 CallerIDName: "Service Desk Line 1" Account: State: Up Context: from-internal Extension: 900 Priority: 1 Seconds: 789 Link: SIP/900@from-inernal-4d14,1 Uniqueid: 1177550222.0 ActionID: 1234567890 Event: StatusComplete ActionID: 1234567890
StopMixMonitor
Описание Останавливает запись звонка через MixMonitor и освобождает хендл файла записи.
Синтаксис
Action: StopMixMonitor ActionID: <value> Channel: <value> [MixMonitorID:] <value>
Аргументы
StopMonitor
Описание
Прекращает ранее начатое отслеживание (запись) канала.
Аргументы
Привилегии
call, all
Пример
Action: StopMonitor Channel: SIP/902-12345678 Response: Success Message: Stopped monitoring channel
UnpauseMonitor
Описание
Возобновляет отслеживание (запись) разговора по указанному каналу.
Синтаксис
Action: UnpauseMonitor ActionID: <value> Channel: <value>
Аргументы
Привилегии
call, all
Пример
Action: UnpauseMonitor Channel: SIP/902-1234567 Response: Success Message: Unpaused monitoring of the channel
UpdateConfig
Описание
Динамически обновляет конфигурационный файл Asterisk.
Синтаксис
Action: UpdateConfig ActionID: <value> SrcFilename: <value> DstFilename: <value> Reload: <value> Action-XXXXXX: <value> Cat-XXXXXX: <value> Var-XXXXXX: <value> Value-XXXXXX: <value> Match-XXXXXX: <value> Line-XXXXXX: <value>
Аргументы
Привилегии
config, all
Пример
Action: UpdateConfig SrcFilename: sip.conf DstFilename: test.conf Action-000000: update Cat-000000: linksys Var-000000: mailbox Value-000000: 101@lab Response: Success
Примечания Первый набор параметров должен быть обозначен номером 000000, второй – 000001 и т.д. Это позволяет одновременно обновлять множество разных значений конфигурации. Также следует отметить, что Asterisk GUIиспользует это как основной механизм для обновления конфигурации Asterisk
UserEvent
Описание
Отправляет произвольное событие в интерфейс Asterisk Manager.
Синтаксис
Action: UserEvent ActionID: <value> UserEvent: <value> Header1: <value> HeaderN: <value>
Аргументы
Привилегии
user, all
Пример
Action: UserEvent MyFirstHeader: one MySecondHeader: two ActionID: 1234567890 Event: UserEvent Privilege: user,all UserEvent: Action: UserEvent MyFirstHeader: one MySecondHeader: two ActionID: 1234567890
VoicemailUsersList
Описание
Список всех пользователей голосовой почты
Синтаксис
Action: VoicemailUsersList ActionID: <value>
Аргументы
WaitEvent
Описание Ожидает возникновения события. После вызова этой команды Asterisk отправит сообщение Success, как только интерфейс Asterisk Manager поставит в очередь следующее событие. Если команда WaitEvent вызвана для HTTP-сеанса интерфейса Manager, события будут формироваться и ставиться в очередь
Синтаксис
Action: WaitEvent ActionID: <value> Timeout: <value>
Аргументы
Привилегии
none
Пример
Action: WaitEvent Timeout: 30 Action: Ping Response: Success Message: Waiting for Event... Event: WaitEventComplete Response: Pong