Текст книги "Asterisk™: будущее телефонии Второе издание"

Автор книги: Джим Меггелен

Соавторы: Джаред Смит,Лейф Мадсен
сообщить о нарушении

Текущая страница: 39 (всего у книги 41 страниц)

AbsoluteTimeout

Задает максимальное время ожидания для канала

Выполняет разъединение канала по прошествии определенного времени.

Параметры

Channel

[обязательный] Имя канала, для которого задается максимальное время ожидания.

Timeout

[обязательный] Максимальная продолжительность вызова, в секундах.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Примечания

call, all

Пример

Action: AbsoluteTimeout

Channel: SIP/testphone-10210698 Timeout: 15 ActionID: 12345

Response: Success Message: Timeout Set ActionID: 12345

AgentCallbackLogin

Регистрирует агента в системе очереди вызовов в режиме обратного вызова

Регистрирует указанного агента в системе очереди вызовов Asterisk в режиме обратного вызова. При распределении вызова этот агент будет переведен на заданный добавочный номер.

Параметры

Agent

[обязательный] Идентификатор агента для регистрации в системе, как задано в файле agents.conf.

Exten

[обязательный] Добавочный номер, используемый для обратного вызова.

Context

[необязательный] Контекст, используемый для обратного вызова.

AckCall

[необязательный] Если задано значение true, агент должен подтвердить прием вызова (агент нажимает кнопку #) при обратном вызове к нему.

WrapupTime

[необязательный] Минимальный промежуток времени после разъединения, перед тем как агент получит новый вызов.

ActionID agent, all

Пример

Action: AgentCallbackLogin

Agent: 1001

Exten: 201

Context: Lab

ActionID: 24242424

Response: Success Message: Agent logged in ActionID: 24242424

Event: Agentcallbacklogin Privilege: agent,all Agent: 1001 Loginchan: 201@Lab

Примечания

Команда AgentCallbackLogin (а также приложение AgentCallbackLogin()) была признана устаревшей. Вместо нее предлагается использовать команду QueueAdd. Более подробную информацию можно найти в файле doc/queues-with-callback-members.txt в папке исходного кода Asterisk.

AgentLogoff

Отменяет регистрацию агента

Отменяет регистрацию указанного агента в системе очереди вызовов.

Параметры

Agent

[обязательный] Идентификатор агента, регистрация которого должна быть отменена.

Soft

[необязательный] Задайте значение true, чтобы не происходило разъединение существующих вызовов.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

Action: AgentLogoff Agent: 1001 Soft: true

ActionID: blahblahblah

Response: Success Message: Agent logged out ActionID: blahblahblah

Event: Agentcallbacklogoff Privilege: agent,all Agent: 1001 Reason: CommandLogoff Loginchan: 201@Lab Logintime: 5698

Agents

Представляет список агентов и их статусов

Данная команда служит для предоставления списка с информацией обо всех сконфигурированных агентах.

Привилегии

agent, all

Пример

Action: Agents ActionID: mylistofagents

Response: Success Message: Agents will follow ActionID: mylistofagents

Event: Agents Agent: 1001 Name: Jared Smith Status: AGENT_IDLE LoggedlnChan: 201@Lab LoggedlnTime: 1173237646 TalkingTo: n/a ActionID: mylistofagents

Event: Agents Agent: 1002 Name: Leif Madsen Status: AGENT_LOGGEDOFF LoggedInChan: n/a LoggedInTime: 0

TalkingTo: n/a ActionID: mylistofagents

Event: Agents Agent: 1003 Name: Jim VanMeggelen Status: AGENT_LOGGEDOFF LoggedlnChan: n/a LoggedlnTime: 0 TalkingTo: n/a ActionID: mylistofagents

Event: AgentsComplete ActionID: mylistofagents

ChangeMonitor

Меняет имя файла для записи разговора по каналу

Команда ChangeMonitor может использоваться для изменения файла, запись которого была начата ранее по команде Monitor. Для этого используются следующие параметры.

Параметры

Channel

[обязательный] Используется для задания канала, разговоры по которому будут записываться.

File

[обязательный] Новое имя файла, в который будут записываться разговоры по каналу.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

call, all

Пример

Action: ChangeMonitor Channel: SIP/linksys-084c63c0 File: new-test-recording ActionID: 555544443333

Response: Success

ActionID: 555544443333

Message: Changed monitor filename

Command

Выполняет CLI -команду Asterisk

Выполняет CLI-команду Asterisk так, как если бы она выполнялась из CLI.

Параметры

Command

[обязательный] CLI-команда Asterisk, которая должна быть выполнена.

ActionID

[необязательный] Идентификатор команды, который может использоваться для опознавания ответа Asterisk.

Привилегии

command, all

Пример

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—

DBGet

Возвращает запись AstDB

Эта команда извлекает значение из базы данных AstDB.

Параметры

Family

[обязательный] Семейство ключей AstDB, из которого извлекается значение.

Key

[обязательный] Имя ключа AstDB.

ActionID

Привилегии

system,all

Пример

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.

Параметры

Family

[обязательный] Семейство ключей AstDB, для которого задается значение.

Key

[обязательный] Имя ключа AstDB.

Val

[обязательный] Значение, которое должно быть присвоено ключу.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

system, all

Пример

Action: DBPut Family: testfamily Key: mykey Val: 42

ActionID: testing123

Response: Success

Message: Updated database successfully ActionID: testing123

Events

Управляет потоком событий

Активирует или отключает отправку событий на это соединение интерфейса Manager.

Параметры

EventMask

[обязательный] Задайте значение on, если должны отправляться все события, off, если события не должны передаваться, или system, call, log, чтобы выбрать тип событий, который должен отправляться на это соединение интерфейса Manager.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

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

Проверяет состояние добавочного номера

Exten

[обязательный] Имя проверяемого добавочного номера.

Context

[обязательный] Имя контекста, в котором находится заданный добавочный номер.

ActionId

[необязательный] Идентификатор команды, который может использоваться для опознавания этой транзакции интерфейса Manager.

Привилегии

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

Примечания

Вот возможные состояния добавочного номера: Добавочный номер удален. Подсказка добавочного номера не обнаружена.

0

Свободен. Используется.

GetConfig

Возвращает конфигурацию

Извлекает данные из конфигурационного файла Asterisk.

Параметры

Filename

[обязательный] Имя конфигурационного файла, из которого должны извлекаться данные.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

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

GetVar

Возвращает значение переменной

Возвращает значение локальной переменной канала или глобальной переменной.

Параметры

Channel

[необязательный] Имя канала, значение переменной которого должно быть возвращено.

Variable

[обязательный] Имя переменной.

ActionID

Привилегии

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

Выполняет разъединение канала

Выполняет разрыв соединения по заданному каналу.

Параметры

Channel

[необязательный] Имя канала, разъединение которого должно быть выполнено.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

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

lAXNetstats

Представляет статистику IAX

Представляет сводку статистки сетевой активности драйвера IAX2– канала.

Привилегии

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

lAXPeers

Создает список равноправных участников IAX

Создает список всех равноправных участников IAX2 с указанием их текущего статуса.

Привилегии

none

Пример

Action: IAXPeers

Name/Username Host Mask Port StatusName/Username Host Mask Port Status

jared/jared 192.168.0.71 (S) 255.255.255.255 4569 UNREACHABLE

jaredsmith 192.168.0.72 (S) 255.255.255.255 4569 OK (43 ms)

arrivaltel/8017 172.20.95.2 (S) 255.255.255.255 4569 Unmonitored

sokol/jsmith 172.17.122.217 (S) 255.255.255.255 4569 OK (48 ms)

demo/asterisk 216.207.245.47 (S) 255.255.255.255 4569 Unmonitored

5 iax2 peers [2 online, 1 offline, 2 unmonitored]

ListCommands

Создает список команд интерфейса Manager Привилегии

none

Пример

Action: ListCommands

Response: Success

AbsoluteTimeout: Set Absolute Timeout (Priv: call,all)

AgentCallbackLogin: Sets an agent as logged in by callback (Priv: agent,all) AgentLogoff: Sets an agent as no longer logged in (Priv: agent,all)

ZapTransfer: Transfer Zap Channel (Priv: )

Logoff

Завершает сеанс интерфейса Manager

Завершает данный сеанс интерфейса Manager.

Привилегии

none

Пример

Action: Logoff

Response: Goodbye

Message: Thanks for all the fish.

MailboxCount

Проверяет количество сообщений в почтовом ящике

Возвращает количество сообщений в заданном ящике голосовой почты.

Привилегии

call, all

Пример

Action: MailboxCount Mailbox: 100@lab ActionID: 54321abcde

Response: Success ActionID: 54321abcde Message: Mailbox Message Count Mailbox: 100@lab NewMessages: 2 OldMessages: 0

MailboxStatus

Проверяет статус почтового ящика

Проверяет статус заданного ящика голосовой почты.

Параметры

Mailbox

[обязательный] Полный идентификатор почтового ящика, включая почтовый ящик и контекст (ящик контекст).

ActionID

[необязательный] Уникальный идентификатор, который может использоваться для опознавания ответов на эту команду интерфейса Manager.

Привилегии

call, all

Пример

Action: MailboxStatus Mailbox: 100@lab ActionID: abcdef0123456789

Response: Success ActionID: abcdef0123456789 Message: Mailbox Status Mailbox: 100@lab Waiting: 1

MeetmeMute

Выключает микрофон пользователя MeetMe

Выключает микрофон конкретного пользователя, участвующего в конференции MeetMe.

Параметры

Meetme

[обязательный] Номер конференции MeetMe.

Usernum

[обязательный] Номер абонента в заданной конференции.

ActionID

call, all

Пример

Action: MeetmeMute Meetme: 104 Usernum: 1

ActionID: 5432154321

Response: Success ActionID: 5432154321 Message: User muted

Event: MeetmeMute

Privilege: call,all

Channel: SIP/linksys2-10211dc0

Uniqueid: 1174008176.3

Meetme: 104

Usernum: 1

Status: on

Примечания

Чтобы найти номер Usernum конкретного вызывающего абонента, понаблюдайте за интерфейсом Asterisk Manager при входе нового участника в конференцию. Когда это произойдет, вы увидите такое событие:

Event: MeetmeJoin Privilege: call,all Channel: SIP/linksys2-10211dc0 Uniqueid: 1174008176.3 Meetme: 104 Usernum: 1

MeetMeUnmute

Включает микрофон пользователя MeetMe

Включает микрофон заданного пользователя в конференции MeetMe.

Параметры

Meetme

[обязательный] Номер конференции MeetMe.

Usernum

[обязательный] Номер пользователя в заданной конференции.

ActionID

call, all

Пример

Action: MeetmeUnmute Meetme: 104 Usernum: 1

ActionID: abcdefghijklmnop

Response: Success ActionID: abcdefghijklmnop Message: User unmuted

Event: MeetmeMute

Privilege: call,all

Channel: SIP/linksys2-10211dc0

Uniqueid: 1174008176.3

Meetme: 104

Usernum: 1

Status: off

Monitor

Записывает разговор по каналу

Записывает аудиоданные, передаваемые по каналу, в заданный файл.

Параметры

Channel

[обязательный] Определяет канал, разговор по которому будет записываться.

File

[необязательный] Имя файла, в который производится запись разговора по каналу. По умолчанию запись ведется в папку очереди для записи разговоров Asterisk, которой обычно является /var/spool/ asterisk/monitor. Если имя файла не задано, в качестве него используется имя канала, при этом символы слэша заменяются на тире.

Format

[необязательный] Аудиоформат, в котором производится запись канала. По умолчанию используется wav.

Mix

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

call, all

Пример

Action: Monitor Channel: SIP/linksys2-10216e38 Filename: test-recording Format: gsm Mix: true

Response: Success

Message: Started monitoring channel

Originate

Формирует вызов

Формирует исходящий вызов из Asterisk и соединяет канал с контекстом/добавочным номером/приоритетом или приложением диал– плана.

Параметры

Channel

[обязательный] Имя канала, которому адресован вызов. Как только вызываемый канал отвечает на вызов, управление вызовом передается в заданные Exten/Context/Priority или Application.

Exten

[необязательный] Используемый добавочный номер (должны быть заданы значения Context и Priority).

Context

[необязательный] Используемый контекст (должны быть заданы значения Exten и Priority).

Priority

[необязательный] Используемый приоритет (должны быть заданы значения Exten и Context).

Data

[необязательный] Данные, которые должны быть переданы как параметры приложения (должно быть задано значение Application).

Timeout

[необязательный] Как долго необходимо ожидать ответа на звонок, в миллисекундах.

CallerID

[необязательный] Идентификатор вызывающего абонента, который должен быть задан для исходящего канала.

Variable

[необязательный] Переменная канала, которая должна быть задана. Допускается множество переменных в заголовке.

Account

[необязательный] Учетная запись.

Async

[необязательный] Задайте значение true, чтобы выполнять асинхронные вызовы. Асинхронное формирование вызовов позволяет создавать один или более вызовов, не ожидая немедленного ответа.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

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

Park

Выполняет парковку канала

Выполняет парковку заданного канала в слот парковки.

Параметры

Channel

[обязательный] Имя канала, который должен быть припаркован.

Channel2

[обязательный] Канал, которому должна быть предоставлена информация о парковке (и возвращен звонок, если допустимое время парковки истекло).

Timeout

[необязательный] Время ожидания, в миллисекундах, перед выполнением обратного вызова.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

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

Примечания

Конфигурация слота парковки вызовов выполняется в файле features. conf в папке конфигурации Asterisk.

ParkedCalls

Создает список припаркованных вызовов

none

Пример

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

Примечания

Конфигурация слота парковки вызовов выполняется в файле features. conf в папке конфигурации Asterisk.

PauseMonitor

Приостанавливает запись канала

Приостанавливает отслеживание (запись) канала, для которого производится запись разговоров.

Параметры

Channel

[обязательный] Идентификатор записываемого в настоящее время канала.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

Пример

Action: PauseMonitor Channel: SIP/linksys2-10212040 ActionID: 987987987987

Response: Success

ActionID: 987987987987

Message: Paused monitoring of the channel

Ping

Поддерживает соединение активным

Посылает запрос на сервер Asterisk, чтобы убедиться, что он до сих пор отвечает. Asterisk ответит сообщением Pong. Эта команда также может использоваться, чтобы не допустить разрыва соединения в результате истечения времени ожидания.

Пример

Action: Ping

Response: Pong

PlayDTMF

Передает DTMF -код в канал

Передает DTMF-код в заданный канал.

Параметры

Channel

[обязательный] Идентификатор канала, в который должен быть отправлен DTMF-код.

Digit

[обязательный] DTMF-код, который должен быть отправлен в канал.

ActionID

[необязательный] Идентификатор, который может использоваться для опознавания ответа на эту команду.

Привилегии

call, all

Пример

Action: PlayDTMF

Channel: Local/201@lab-157a,1

Digit: 9

Response: Success

Message: DTMF successfully queued

QueueAdd

Добавляет участника в заданную очередь

Добавляет участника обработки очереди вызовов.

Параметры

Queue

[обязательный] Имя очереди вызовов.

Interface

[обязательный] Имя участника, который должен быть добавлен в очередь. Это будет технология или ресурс, например SIP/Jane или Local/203@lab/n. Также с помощью синтаксиса Agent/1234 могут быть добавлены агенты (описанные в файле agents.conf).

MemberName

[необязательный] Это удобный для человека псевдоним интерфейса, который будет использоваться в статистических данных и журналах регистрации очереди.

Penalty

[необязательный] Числовой приоритет, применяемый к данному участнику обработки очереди. Asterisk сначала пытается распределить вызовы между участниками с более низкими значениями приоритетов, а затем переходит к участникам с более высокими приоритетами.

Paused

[необязательный] Должен ли участник добавляться в изначально приостановленном состоянии.

ActionID

[необязательный] Идентификатор команды, который можно использовать для опознавания ответа на эту транзакцию интерфейса Manager.

Привилегии

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

QueuePause

Приостанавливает или возобновляет работу участника обработки очереди вызовов

Приостанавливает или возобновляет работу участника обработки очереди вызовов.

Параметры

Interface

[обязательный] Имя интерфейса, участие которого в обработке вызовов должно быть приостановлено или возобновлено.

Paused

[обязательный] Должна ли быть приостановлена работа участника обработки вызовов. Задайте значение true, чтобы приостановить работу участника, или false, чтобы возобновить ее.

Queue

[необязательный] Имя очереди вызовов, участие в обработке которой приостанавливается или возобновляется для данного участника. Если не задано, работа участника будет приостановлена или возобновлена во всех очередях вызовов, участником обработки которых он является.

ActionID

Привилегии

agent, all

Пример

Action: QueuePause Interface: SIP/testphone Paused: true Queue: myqueue

Response: Success

Message: Interface paused successfully

Event: QueueMemberPaused Privilege: agent,all Queue: myqueue Location: SIP/testphone MemberName: Jared Smith Paused: 1

Action: QueuePause Interface: SIP/testphone Paused: false

Response: Success

Message: Interface unpaused successfully

Event: QueueMemberPaused Privilege: agent,all Queue: myqueue Location: SIP/testphone MemberName: Jared Smith Paused: 0

QueueRemove

Удаляет интерфейс из очереди

Удаляет интерфейс из очереди вызовов.

Параметры

Queue

[обязательный] Очередь, из которой должен быть удален участник.

Interface

[обязательный] Интерфейс (участник), который должен быть удален из заданной очереди.

ActionID

Привилегии

agent, all

Пример

Action: QueueRemove Queue: myqueue Interface: SIP/testphone

Response: Success

Message: Removed interface from queue

Event: QueueMemberRemoved (Privilege: agent,all Queue: myqueue Location: SIP/testphone MemberName: Jared Smith

QueueStatus

Проверяет статус очереди

Проверяет статус одной или более очередей вызовов.

Параметры

Queue

[необязательный] Если задан, ограничивает ответ статусом заданной очереди.

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/4020@agents/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/4020@agents/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/200@lab-4d13,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: 101@lab