Джим Меггелен - Asterisk™: будущее телефонии Второе издание
Member
[необязательный] Идентификатор команды, который можно использовать для опознавания ответа на эту транзакцию интерфейса Manager.
ActionID
[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.
Привилегии
none
Пример
Action: QueueStatus Queue: inbound-queue ActionID: 11223344556677889900
Response: Success
ActionID: 11223344556677889900
Message: Queue status will follow
Event: QueueParams Queue: inbound-queue Max: 0 Calls: 1 Holdtime: 99 Completed: 540 Abandoned: 51 ServiceLevel: 60 ServicelevelPerf: 50.4 Weight: 0
ActionID: 11223344556677889900
Event: QueueMember Queue: inbound-queue Location: Local/ [email protected]/n Membership: dynamic Penalty: 2 CallsTaken: 25 LastCall: 1175563440 Status: 2 Paused: 0
ActionID: 11223344556677889900
Event: QueueEntry Queue: inbound-queue Position: 1 Channel: Zap/25-1 CallerID: 8012317154 CallerIDName: JOHN Q PUBLIC Wait: 377
ActionID: 11223344556677889900
Event: QueueStatusComplete ActionID: 11223344556677889900
Queues
Представляет основную информацию очередей вызовов
Представляет очереди вызовов с информацией об участниках обработки очередей, вызывающих абонентах и с основными статистическими данными.
Привилегии
none
Пример
Action: Queues
inbound-queue has 0 calls (max unlimited) in 'rrmemory' strategy (81s holdtime), W:0, C:542, A:51, SL:50.4% within 60s
Members:
Local/ [email protected]/n with penalty 2 (dynamic) (Unknown) has taken 27 calls (last was 124 secs ago) No Callers
Примечания
Эта команда интерфейса Manager обеспечивает вывод, аналогичный выводу команды show queues интерфейса командной строки Asterisk. Однако вывод данной команды трудно поддается программному синтаксическому разбору, поэтому, вероятно, лучше использовать команду QueueStatus.
Redirect
Перенаправляет (переадресовывает) канал
Перенаправляет канал в новый контекст, добавочный номер и приоритет диалплана.
Параметры
Channel
[обязательный] Перенаправляемый канал.
ExtraChannel
[необязательный] Идентификатор канала второго плеча вызова для переадресации.
ActionID
[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.
Exten
[обязательный] Добавочный номер в диалплане, на который выполняется переадресация.
Context
[обязательный] Контекст, на который выполняется переадресация.
Priority
[обязательный] Приоритет, на который выполняется переадресация.
Привилегии
call, all
Пример
Action: Redirect
Channel: SIP/linksys2-10201e90
Context: lab
Exten: 500 Priority: 1
ActionID: 010123234545
Response: Success ActionID: 010123234545 Message: Redirect successful
SIPpeers
Создает список всех равноправных участников SIP
Создает список сконфигурированных в данный момент равноправных участников SIP с указанием их статуса.
Параметры
ActionID
[необязательный] Идентификатор команды, который можно использовать для опознавания ответа на эту транзакцию интерфейса Manager.
Привилегии
system, all
Пример
Action: SIPPeers ActionID: 555444333222111
Response: Success
ActionID: 555444333222111
Message: Peer status list will follow
Event: PeerEntry ActionID: 555444333222111 Channeltype: SIP ObjectName: labrat ChanObjectType: peer IPaddress: 10.0.0.75 IPport: 5060 Dynamic: no Natsupport: no VideoSupport: no ACL: no
Status: OK (318 ms) RealtimeDevice: no
Event: PeerEntry ActionID: 555444333222111 Channeltype: SIP
ObjectName: guineapig ChanObjectType: peer IPaddress: 172.18.227.72 IPport: 5060 Dynamic: no Natsupport: no VideoSupport: no ACL: no
Status: Unmonitored RealtimeDevice: no
Event: PeerEntry ActionID: 555444333222111 Channeltype: SIP ObjectName: another ChanObjectType: peer IPaddress: 172.18.227.73 IPport: 5060 Dynamic: yes Natsupport: no VideoSupport: no ACL: no
Status: Unmonitored RealtimeDevice: no
Event: PeerlistComplete ListItems: 7
ActionID: 555444333222111
SIPShowPeer
Представляет информацию о равноправном участнике SIP
Представляет подробную информацию о сконфигурированном равноправном участнике SIP.
Параметры
Peer
[обязательный] Имя равноправного участника SIP.
ActionID
[необязательный] Идентификатор команды, который можно использовать для опознавания ответа на эту транзакцию интерфейса Manager.
Привилегии
Action: SIPShowPeer Peer: linksys2 ActionID: 9988776655
Response: Success ActionID: 9988776655 Channeltype: SIP ObjectName: linksys2 ChanObjectType: peer SecretExist: Y MD5SecretExist: N Context: lab Language: AMAflags: Unknown
CID-CallingPres: Presentation Allowed, Not Screened
Callgroup:
Pickupgroup:
VoiceMailbox:
TransferMode: open
LastMsgsSent: -1
Call-limit: 0
MaxCallBR: 384 kbps
Dynamic: Y
Callerid: "Linksys #2" <555> RegExpire: 2516 seconds SIP-AuthInsecure: no SIP-NatSupport: RFC3581 ACL: N
SIP-CanReinvite: Y SIP-PromiscRedir: N SIP-UserPhone: N SIP-VideoSupport: N SIP-DTMFmode: rfc2833 SIPLastMsg: 0 ToHost:
Address-IP: 192.168.5.71
Address-Port: 5061
Default-addr-IP: 0.0.0.0
Default-addr-port: 5056
Default-Username: linksys2
RegExtension: 6100
Codecs: 0x4 (ulaw)
CodecOrder: ulaw
Status: Unmonitored
SIP-Useragent: Linksys/SPA962-5.1.5
Reg-Contact : sip: [email protected]:5061
SetCDRUserField
Задает поле пользователя записи CDR
Параметры
Channel
[обязательный] Канал, для которого задается настройка UserField записи CDR.
UserField
[обязательный] Значение, которое должно быть присвоено UserField в записи CDR.
ActionID
[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.
Привилегии
call, all
Пример
Action: SetCDRUserField Channel: SIP/test-10225140 UserField: abcdefg
Response: Success Message: CDR Userfield Set
SetVar
Задает переменную канала
Задает значение глобальной переменной или переменной канала.
Параметры
Channel
[необязательный] Канал, для переменной которого задается значение. Если не указан, переменная будет задана как глобальная.
Variable
[обязательный] Имя переменной.
Value
[обязательный] Значение.
Привилегии
call, all
Пример
Action: SetVar
Channel: SIP/linksys2-10225140 Variable: MyOwnChannelVariable Value: 42
Response: Success Message: Variable Set
Action: SetVar
Variable: MyOwnGlobalVariable Value: 25
Response: Success Message: Variable Set
Status
Представляет статус канала
Представляет статус одного или более каналов с подробной информацией об их текущем состоянии.
Параметры
Channel
[необязательный] Ограничивает вывод статусом заданного канала.
ActionID
[необязательный] Идентификатор команды, который можно использовать для опознаввания ответа на эту транзакцию интерфейса Manager.
Привилегии
call, all
Пример
Action: Status
Channel: SIP/test-10225140
ActionID: 101010101010101
Response: Success
ActionID: 101010101010101
Message: Channel status will follow
Event: Status Privilege: Call Channel: SIP/test-10225140 CallerID: "Bob Jones" <501> CallerIDNum: 501 CallerIDName: "Bob Jones"
Account: State: Up Context: lab Extension: 201 Priority: 1 Seconds: 865
Link: Local/ [email protected],1 Uniqueid: 1177550165.0 ActionID: 101010101010101 Event: StatusComplete ActionID: 101010101010101
StopMonitor
Прекращает запись разговора по каналу
Прекращает ранее начатое отслеживание (запись) канала.
Параметры
Channel
[обязательный] Имя канала, запись которого должна быть прекращена.
ActionID
[необязательный] Уникальный идентификатор, который может служить для опознавания ответов на эту команду.
Привилегии
call, all
Пример
Action: StopMonitor Channel: SIP/linksys2-10216e38
Response: Success
Message: Stopped monitoring channel
UnpauseMonitor
Возобновляет запись
Возобновляет отслеживание (запись) разговора по указанному каналу.
Параметры
Channel
[обязательный] Имя канала, запись которого должна быть возобновлена.
ActionID
Привилегии
call, all
Пример
Action: UnpauseMonitor Channel: SIP/linksys2-10212040 ActionID: 282828282828282
Response: Success
ActionID: 282828282828282
Message: Unpaused monitoring of the channel
UpdateConfig
Обновляет конфигурационный файл
Динамически обновляет конфигурационный файл Asterisk.
Параметры
SrcFilename
[обязательный] Имя конфигурационного файла, из которого следует читать текущую информацию.
DstFilename
[обязательный] Имя записываемого конфигурационного файла.
Reload
[необязательный] Определяет, должна ли быть выполнена перезагрузка после обновления конфигурации, или задает имя конкретного модуля, который должен быть перезагружен.
Action-XXXXXX
[обязательный] Действие, которое необходимо предпринять. Это может быть NewCat, RenameCat, DelCat, Update, Delete или Append.
Cat-XXXXXX
[обязательный] Имя изменяемой категории.
Var-XXXXXX
[необязательный] Имя изменяемой переменной.
Value-XXXXXX
[необязательный] Значение изменяемой переменной.
Match-XXXXXX
ActionID
[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.
Привилегии
config,all
Пример
Action: UpdateConfig SrcFilename: sip.conf DstFilename: test.conf Action-000000: update Cat-000000: linksys Var-000000: mailbox Value-000000: [email protected]
Response: Success
Примечания
Обратите внимание, что первый набор параметров должен быть обозначен номером 000000, второй - 000001 и т. д. Это позволяет одновременно обновлять множество разных значений конфигурации. Также следует отметить, что Asterisk GUI использует это как основной механизм для обновления конфигурации Asterisk.