Приложения Реального Времени

• CGPL файлы с кодом Приложений и кодом модулей.
• VoiceXML файлы с кодом Приложений
• Произвольные служебные файлы - например, записанные заранее медиа файлы.
• Директории с файлами для различных Языков.

Среды разработаны таким образом, что бы они могли поддерживать работу нескольких разных человеческих (разговорных) языков. По умолчанию языком Среды является Английский. Для поддержки других языковых файлов Среда должна иметь языковые директории, названные по имени поддерживаемого в них языка (french, russian, japanese и т.д.).

Языковая директория может содержать такие же файлы, что и Среда, но она не может иметь поддиректорий.

Задача Приложения Реального Времени может выбирать используемый язык. При выборе языка, не являющегося языком по умолчанию, код приложения пытается прочитать файл из Среды Приложения, используя выбранную языковую поддиректорию. Если в языковой поддиректории файл не найден, то запрашивается файл из самой Среды Приложения (то есть, используется язык по умолчанию).

Сервер CommuniGate Pro поставляется со "стандартной" Средой Приложений Реального Времени. Эта Среда содержит некоторые базовые приложения и все файлы, необходимые для нормальной работы этих приложений, а также некоторые полезные разделы кода и медиа файлы.

Каждая система CommuniGate Pro имеет Общую для Сервера Среду Приложения. В установках с Динамическим Кластером CommuniGate Pro также существует Общая для Кластера Среда Приложения. Для того, что бы изменить эти Среды, откройте через Веб Интерфейс Администратора область Домены и пройдите по ссылке PBX.

Каждый Домен CommuniGate Pro имеет свою собственную Среду Приложения. Для изменения этой Среды, откройте через Веб Интерфейс Администратора область Домены, откройте для требуемого Домена его Установки и пройдите по ссылке PBX.

Изменения Среды, Общей для Кластера, а также изменения Среды для Общих Доменов автоматически распространяются на всех членов Кластера.

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

Все файлы Среды Приложений для не ASCII символов должны использовать кодировку UTF-8.

Задачи Приложений Реального Времени выполняются "от имени" определённого Пользователя CommuniGate Pro.
Когда Приложению требуется "файл среды" и выбран язык по умолчанию, Сервер ищет этот файл в:

• Среде Домена Пользователя.
• Общей для Сервера Среде (или, если Пользователь находится в Общем Домене) в Общей для Кластера Среде.
• в Стандартной Среде.

Если выбран язык, не являющийся языком по умолчанию, то Сервер ищет этот файл в языковых поддиректориях вышеперечисленных Сред. Если файл не найден в какой-либо из этих директорий, то осуществляется поиск в самих вышеперечисленных Средах. Таким образом, если файл для требуемого языка не был создан, то будет использоваться язык по умолчанию (Английский).

Такая иерархия обеспечивает простую настройку Приложений. Пользователи во всех Доменах могут использовать одинаковые Стандартные или Общие для Сервера Приложения, а Администраторы конкретного Домена могут настраивать эти приложения под свой домен, загружая пользовательские файлы в Среды своего Домена.

Приложения Реального Времени запускаются как Задачи. Запуская Приложение, Сервер CommuniGate Pro запускает новую Задачу и указывает ей начать выполнение с main - точки входараздела кода указанного Приложения.

Задача Приложения Реального Времени может быть запущена в режиме disconnected, а может являться частью какой-либо одной сессии Реального Времени (такой, как телефонный звонок) с некоторым участником (peer). Участником является любая единица, принимающая участие в коммуникациях Реального Времени, например: SIP телефон, шлюз в ТфОП, удалённое Приложение Реального Времени, взаимодействующее через SIP протокол, локальное Приложение Реального Времени (то есть, некоторая другая Задача).

Если Задача взаимодействует с каким-либо участником в сессии, она может работать в одном из следующих режимов:

incoming

входящая сессия (в телефонной терминологии - звонок, в SIP терминологии - запрос INVITE) была направлена Задаче, но Задача ещё не приняла сессию (звонок).

provisioned

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

connecting

задача инициировала исходящую сессию (звонок), но сессия еще не была установлена

connected

Задача приняла водящую сессию или Задача установила исходящую сессию.

Задача может как получать от участника Сигналы, так и отправлять Сигналы сама. Сигналы могут использоваться для окончания текущей сессии, изменения параметров сессии и т.д. Некоторые из Сигналов, отправляемые участнику, обрабатываются непосредственно самой Средой для Приложений Реального Времени, тогда как другие Сигналы передаются на обработку Задаче.

Задача Приложения Реального Времени имеет связанный с ней Медиа Канал. При установлении сессии, Медиа Канал Задачи соединяется с медиа каналом участника.

Задача может использовать свой Медиа Канал для отправки медиа (аудио, видео) данных участнику, а также для записи отправляемых участником медиа данных.

Задача может переключать медиа участника и в каких-нибудь других местах - например, для отделения сервиса музыка при ожидании от других медиа сервисов. При переключении (отключении) медиа, поступающего от участника, Медиа Канал Задачи не может использоваться, но Задача все еще может контролировать участника, отправляя ему Сигналы, а также будет в состоянии получать Сигналы от участника. Задача может переключить (подключать) медиа, поступающее к/от участника обратно, к своему собственному Медиа Каналу.

Медиа Канал создаёт пространство разговора. Задача может присоединять медиа от других участников к собственному Медиа Каналу Задачи. Эта операция создаёт пространство разговора (или конференцию), которая включает в себя собственного участника Задачи и всех участников, чьи медиа присоединены к этой Задаче. Медиа, отправляемое любым участником, находящимся в пространстве разговора, ретранслируется на всех других участников в этом пространстве, используя специальные алгоритмы смешивания данных и параметры, заданные для этого типа медиа.

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

Перевод Звонка

Сигнал INVITE, инициированный сигналом REFER, может содержать аутентифицирующую информацию. Приложение может указать Задаче:

• аутентифицировать сигнал INVITE как сигнал, приходящий от текущего Пользователя Эта опция используется по умолчанию.
• аутентифицировать сигнал INVITE как сигнал, приходящий от участника (от единицы, отправившей сигнал REFER).
• отвергать сигналы REFER.

Для обработки "сопровождаемого" Перевода Звонка, ядро Приложения Реального Времени определяет все сигналы INVITE, в которых присутствуют поля Replaces. Если данные из диалога, указанные в полях Replaces, соответствуют активному диалогу, установленному в любой Задаче Реального Времени, то сигнал INVITE направляется этой Задаче. Задача посылает текущему участнику сигнал BYE и переключает свой сигнальный диалог на источник этого сигнала INVITE, а также переключает на единицу, отправившую сигнал INVITE, свой Медиа Канал.
Эта обработка происходит автоматически и является прозрачной для приложения, в котором обрабатывается Задача.

Мост между Звонками

• приложение некоторой работающей Задачи A использует функцию CG/PL StartBridge для отправки специального события [bridgeStart] Задаче B. В запросе содержится описание медиа участника текущей Задачи A.
• запущенное приложение Задачи B получает этот запрос.
• приложение Задачи B использует функцию CG/PL AcceptBridge для построения моста.
• ядро Приложения Реального Времени посылает сигнал re-INVITE участнику Задачи B, переключая его Медиа на Медиа участника Задачи A.
• ядро Приложения Реального Времени посылает событие [bridgeResponse] в Задачу A. Это событие содержит описание медиа участника Задачи B.
• в Задаче B завершается операция AcceptBridge и приложение Задачи B продолжает работу.
• когда Задача A получает событие [bridgeResponse], ядро Приложения Реального Времени обрабатывает это событие самостоятельно и не доставляет его в приложение Задачи A.
• ядро Приложения Реального Времени отправляет re-INVITE участнику Задачи A, переключая его Медиа на Медиа участника Задачи B.
• операция StartBridge в Задаче A завершается и приложение Задачи A продолжает работу.

Если между Задачами A и B построен мост, то одна из Задач (в нашем примере - Задача B) может получить от своего участника сигнал re-INVITE. Новое описание медиа в этом сигнальном запросе может попросить Задачу изменить параметры её медиа (приостановить/продолжить, переключить на другой источник медиа и т.д.). Этот сигнал re-INVITE обрабатывается автоматически и не требует участия со стороны работающего приложения Задачи:

• ядро Приложения Реального Времени посылает специальное событие [bridgeUpdate] в Задачу A. Это событие содержит новое описание медиа.
• ядро Приложения Реального Времени самостоятельно обрабатывает событие [bridgeUpdate] и не доставляет его в работающее Приложения Задачи A.
• ядро Приложения Реального Времени посылает сигнал re-INVITE участнику Задачи A, переключая его на новый источник Медиа участника Задачи B.
• ядро Приложения Реального Времени посылает новое описание медиа участника A (полученное в отклике re-INVITE) Задаче B как специальное событие [bridgeResponse].
• когда Задача B получает событие [bridgeResponse], ядро Приложения Реального Времени обрабатывает его самостоятельно и не доставляет его в приложение Задачи B.
• новое полученное описание медиа Задачи A отправляется участнику B как отклик на начальный сигнал re-INVITE, переключая участника Задачи B на новое медиа участника Задачи A.

Если между Задачами A и B построен мост, то одна из Задач (в нашем примере - Задача A) может получить от своего участника запрос на Перевод Звонка (REFER):

• ядро Приложения Реального Времени формирует сигнал INVITE для Задачи A и отправляет его участнику; в Сигнале содержится описание медиа участника Задачи B.
• сигнал INVITE заканчивается успешно, описание медиа нового участника Задачи A (участника C) получено.
• ядро Приложения Реального Времени автоматически посылает специальное событие [bridgeUpdate] в Задачу B с новым описанием медиа участника.
• когда Задача B получает событие [bridgeUpdate], ядро Приложения Реального Времени обрабатывает это событие самостоятельно и не доставляет его в приложение Задачи B.
• ядро Приложения Реального Времени посылает сигнал re-INVITE участнику Задачи B, переключая его на источник Медиа нового участника Задачи A.

Если между Задачами A и B построен мост, то одна из Задач (в нашем примере - Задача A) может получить от своего участника сигнал запроса на Перевод Звонка - INVITE, в котором есть Replaces (доставляемый модулем Signal в зависимости от содержимого полей Replaces):

• ядро Приложения Реального Времени автоматически посылает специальное событие [bridgeUpdate] в Задачу B с новыми параметрами медиа участника A.
• ядро Приложения Реального Времени посылает сигнал re-INVITE участнику Задачи B, переключая его на источник Медиа нового участника Задачи A.
• ядро Приложения Реального Времени отправляет отклик INVITE новому участнику Задачи A, с параметрами медиа участника Задачи B, соединяя нового участника Задачи A с медиа участника Задачи B.

Если между Задачами A и B построен мост, то одна из Задач (в нашем примере - Задача A) может разорвать Медиа Мост:

• приложение Задачи A использует функцию BreakBridge CG/PL для того, что бы разорвать Медиа мост.
• ядро Приложения Реального Времени автоматически отправляет специальное событие [bridgeClose] в Задачу B и посылает сигнал re-INVITE участнику Задачи A, переключая его на Медиа Канал Задачи A.
• когда Задача B получает событие [bridgeClose], ядро Приложения Реального Времени автоматически отправляет запрос re-INVITE участнику Задачи B, переключая его на Медиа Канал Задачи B.
• ядро Приложения Реального Времени доставляет событие [bridgeClose] приложению Задачи B.

Если между Задачами A и B построен мост, то одна из Задач (в нашем примере - Задача A) может получить от своего участника сигнал на отсоединение (BYE), либо участник может прекратить работу по каким-либо другим причинам. В этом случае:

• ядро Приложения Реального Времени автоматически посылает специальное событие [bridgeClose] в Задачу B.
• когда Задача B получает событие [bridgeClose], ядро Приложения Реального Времени автоматически отправляет запрос re-INVITE участнику Задачи B, переключая его на Медиа Канал Задачи B.
• ядро Приложения Реального Времени доставляет событие [bridgeClose] приложению Задачи B.

Ядро Приложения Реального Времени может создавать Медиа Мост, используя Медиа Канал Задачи как "медиа релей" (ретранслятор медиа).

B2BUA

Приложения Реального Времени могут быть написаны на языке CG/PL.

Если Задача создаётся для обработки входящего звонка, то её выполнение начинается с точки входа main указанного CG/PL приложения.

Приложения Реального Времени могут использовать поддерживаемую в CG/PL возможность внешнего объявления. Когда вызывается раздел кода (процедура или функция), объявленный как внешний, то из среды загружается файл с именем раздела кода и расширением .sppi. Код программы в этом файле должен содержать раздел кода с указанным именем и требуемым типом (процедуру или функцию).
Код программы в .sppi файле может содержать также и другие разделы программы.

В Приложении Реального Времени, написанном на языке CG/PL, могут использоваться следующие встроенные процедуры и функции.

Ввод

ReadInput(timeOut)

Эта функция используется для получения внешних коммуникаций Задачи: символ DTMF (символ тонового набора), введённый участником, сигналы, отправленные участником, а также События, отправляемые как другими Задачами, так и самой системой. Дополнительную информацию смотрите в разделе CG/PL События.
Значение timeOut должно быть числом, задающим максимальный период ожидания (в секундах). Если значение timeOut является нулём, то функция проверяет наличие уже ожидающих прочтения цифр или событий, не ожидая дополнительное время.
Функция возвращает:

• строку с первым символом DTMF из DTMF буфера Задачи. Этот символ удаляется из буфера Задачи.
• словарь с первым ожидающим Событием. Событие удаляется из очереди Событий Задачи.
• нулевое значение, если в течении указанного периода времени не был получен DTMF символ или Событие.

При отсоединении участника, Задача получает от системы Событие Disconnect (в словаре этого События отсутствует элемент .sender).

IsDisconnectEvent(input)

Эта функция возвращает истину, если значением input является Событие Disconnect.

//
// Sample: ReadInput()
//   Accept an incoming call (stop if it's not possible).
//   Play the PressPound media file.
//   Wait for any input for up to 5 seconds.
//   If the "pound" ("#") symbol was entered,
//     play the Good media file.
//   Otherwise,
//     play the Bad media file.
//   Stop.
//
entry Main is
  if AcceptCall() != null then stop; end if;
  PlayFile("PressPound");
  PlayFile(ReadInput(5) == "#" ? "Good" : "Bad");
end entry;

Сигналы

RejectCall(responseCode)

Эта процедура отвергает входящую сессию при условии, что Задача находится в режиме incoming или provisioned.
Значением responseCode должно быть числовое значение между 400 и 699. Это число отправляется обратно вызывающей стороне как код Отклика на Сигнал. Если обратно отправляется код 401 и запрос пришёл извне Сервера CommuniGate Pro (через SIP протокол), то модуль SIP сервера добавляет надлежащие поля в отклик, что бы способствовать Аутентификации клиента.
Задача переводится в режим disconnected.

AcceptCall()

Эта функция принимает входящую сессию при условии, если Задача находится в режиме incoming или provisioned.
Эта функция возвращает нулевое значение, если сессии принята успешно и Задача переведена в режим connected.
Если сессия не может быть принята, то эта функция возвращает строку с кодом ошибки и Задачи переводятся в режим disconnected.

//
// Sample: AcceptCall()/RejectCall()
//   If the current local time is not between 8:00 and 17:00,
//     reject the call (with the 403 error code) and stop.
//   Otherwise,
//     accept the call (stop if it is not possible)
//     play the Welcome media file and stop.
//
entry Main is
  currentTime = TimeOfDay(GMTToLocal(GMTTime()));
  currentHour = currentTime / 3600;
  if currentHour < 8 or currentHour >= 17 then
    RejectCall(403); stop;
  end if;
  if AcceptCall() != null then stop; end if;
  PlayFile("Welcome");
end entry;

RedirectCall(newURI)

Эта процедура перенаправляет входящую сессию при условии, что Задача находится в режиме incoming или provisioned.
Значение newURI должно быть строкой или массивом строк. Входящая сессия перенаправляется на указанный URI и Задача переводится в режим disconnected.

ForkCall(newURI)

Эта процедура перенаправляет входящую сессию при условии, что Задача находится в режиме incoming или provisioned.
Значение newURI должно быть строкой или массивом строк. Входящая сессия перенаправляется на указанный URI, но текущая Задача остаётся в том же состоянии и впоследствии сможет принять, отвергнуть, перенаправить, отправить промежуточный отклик или подключить другого участника.

ProvisionCall(startMedia,reliably)

Эта функция отправляет промежуточный Отклик на Запрос входящей сессии, при условии, что Задача находится в режиме incoming или provisioned.
Если значение startMedia не является нулевым, то создаётся Медиа Канал Задачи, Задача переводится в режим provisioned и может использовать операции Медиа Канала (такие как PlayFile) для "контроля посылки вызова".
Если значение reliably не является нулевым, то требуется подтверждение отклика (SIP PRACK) и Задача приостанавливается до момента прихода такого подтверждения.
Эта функция возвращает нулевое значение если отклик был успешно отправлен.
Если промежуточный отклик не может быть отправлен, то эта функция возвращает строку с кодом ошибки.

//
// Sample: RedirectCall()/ProvisionCall()
//   Provision the call (stop if it is not possible).
//   If the current local time is between 12:00 and 13:00,
//     fork the call to user1 in the same domain.
//   Play the "PleaseWait" media file.
//   If the current local time is not between 8:00 and 17:00,
//     redirect the call to user2 in the same domain, and stop.
//   Otherwise,
//   Accept the call (stop if it's not possible).
//   Play the Welcome media file, and stop.
//
entry Main is
  if ProvisionCall(true,true) != null then stop; end if;
  currentTime = TimeOfDay(GMTToLocal(GMTTime()));
  currentHour = currentTime / 3600;
  if currentHour >= 12 and currentHour <= 13 then
    ForkCall("sip:user1@" + MyDomain());
    stop;
  end if;
  PlayFile("PleaseWait");
  if currentHour < 8 or currentHour >= 17 then
    RedirectCall("sip:user2@" + MyDomain());
    stop;
  end if;
  if AcceptCall() != null then stop; end if;
  PlayFile("Welcome");
end entry;

Обратите внимание: если ожидающий входящий звонок был прерван, то Задача получает события Disconnect и режим задачи изменяется на disconnected.

StartCall(destination)

Эта функция инициирует исходящую сессию. Задача должна находиться в режиме disconnected.
Значение destination должно быть строкой, содержащий URI, на который отправляется запрос на сессию или значение должно быть словарём, содержащим следущие строковые элементы:

"" (пустая строка)

URI, на который отправляется запрос на сессию.

From (опционально)

адрес электронной почты, URI или другие данные, используемые в поле From. Если они указаны, то используются данные текущего Пользователя.

To (опционально)

адрес электронной почты, URI или другие данные, используемые в поле To. Если они указаны, то используется URI запроса.

Call-ID (опционально)

строка, используемая для поля Call-ID запроса. Если она не указана, то генерируется новый Call-ID.

Expires (опционально)

число, указывающее максимальную продолжительность вызова (в секундах).

Subject (опционально)

строка Subject запроса.

Remote-Party-Id (опционально)

словарь, с помощью данных которого формируется поле Remote-Party-Id запроса.

Privacy (опционально)

строка, используемая для поля Privace запроса.

Diversion (опционально)

массив, используемый для полей Diversion запроса.

P-CGP-Private (опционально)

строка, используемая для поля P-CGP-Private запроса. Это поле может использоваться для передачи произвольных параметров между отправляющей и принимающей Задачами (в одной или разных системах).

Эта функция возвращает строку с кодом ошибки, если исходящий вызов не может быть инициирован.
Если исходящий вызов был успешно инициирован, то функция возвращает нулевое значение и Задача начинает получать от системы События, возникающие во время звонка: ноль или больше Событий с промежуточными откликами, за которым следует одно Событие с финальным откликом.
Если исходящая сессия задача была успешно установлена, то Задачи получает Событие с финальными откликом без параметров.
Если исходящая сессия задача не была успешно установлена, то Задача получает Событие с финальными откликом с параметром - строкой с кодом ошибки.

IsCallProvisionEvent(input)

Эта функция возвращает истину, если значением input является Событие с промежуточным откликом на вызов. В противном случае функция возвращает нулевое значение.

IsCallCompletedEvent(input)

Эта функция возвращает истину, если значением input является Событие с финальным откликом на Звонок. В противном случае функция возвращает нулевое значение. Если Задача получает Событие с финальным откликом, то процесс обработки сигналов вызова завершается. Если Событие имеет параметр, то звонок заканчивается неудачно; в этом случае в параметре содержится строка с кодом ошибки.

CancelCall()

Если у Задачи имеется ожидающий исходящий вызов (инициированный при помощи функции StartCall), то эта процедура прекращает выполнение этого вызова (при этом Задача не получит События с финальным откликом).

Disconnect()

Эта процедура заканчивает активную сессию (если есть) и Задача переводится в режим disconnected.

//
// Sample: StartCall()/Disconnect()
//   Accept an incoming call (stop if it's not possible).
//   Remember the caller URI.
//   Play the CallBack media file.
//   Disconnect();
//   Call the caller back (stop if it's not possible).
//   Play the IamBack media file, and stop.
//
entry Main is
  if AcceptCall() != null then stop; end if;
  fromWhom = RemoteURI();
  PlayFile("CallBack");
  Disconnect();

  if StartCall(fromWhom) != null then stop; end if;

  loop
    input = ReadInput(3600);
  exitif not IsCallProvisionEvent(input);
    null;
  end loop;

  if not IsCallCompletedEvent(input) or else
     input.parameter != null then stop; end if;

  PlayFile("IamBack");
end entry;

IsConnected()

Эта функция возвращает истину, если Задача находится в режиме connected.

IsHalfConnected()

Эта функция возвращает истину, если Задача находится в режиме connected или provisioned.

PendingRequestData(fieldName)

Эта функция возвращает элемент данных из ожидающего входящего запроса.
Если запрос является ожидающим, то функция возвращает следующие данные, в зависимости от значения fieldName, которое должно являться строкой:

Call-ID

Функция возвращает строку со значением Call-ID запроса.

From, To, Remote-Party-Id

функция возвращает словарь, если такое поле существует в этом запросе. В словаре содержатся следующие элементы:

"" (элемент с пустой строкой-ключом)

адрес (в форме username@domain)

@realName

строка, в которой содержится часть адреса "отображаемое имя" (Display Name)

tag

параметр "tag" из URI

@uri-params

словарь с другими параметрами URI.

Все элементы, кроме элемента адрес, являются опциональными.

Route, Record-Route, Diversion, Via, Path, Supported, Require, Proxy-Require, Privacy

функция возвращает массив, содержащий одну или более строк со значениями полей. Если никаких значений не существует, то функция возвращает нулевое значение.

CSeq

функция возвращает число - значение числовой части поля CSeq

Max-Forwards

функция возвращает число - значение поля Max-Forwards.

User-Agent, Reason, Privacy, P-CGP-Private

функция возвращает строку - значение поля. Если поле отсутствует, то функция возвращает нулевое значение.

Accept

функция возвращает массив, содержащий 2 строки для каждого значения поля: принятый тип содержимого (content type) и принятый подтип содержимого (content subtype). Если поле отсутствует, то функция возвращает нулевое значение.

Foreign-Asserted-Identity

функция возвращает массив, содержащий один или более словарь для каждого поля запроса P-Asserted-Identity. Каждый словарь содержит такие же элементы, как и поле From словаря.

Если нет никакого ожидающего запроса, то функция возвращает нулевое значение.

SetForeignCredentials(authName,password)

Эта процедура задаёт полномочия (аутентифицированное имя пользователя и пароль), используемое исходящими запросами, отправленными этой Задачей.
Значения authName и password должны быть строками, в противном случае полномочия сбрасываются.

SetReferMode(mode)

Эта процедура используется для указания способа обработки Задачей запросов REFER и INVITE/replaces. Параметр mode должен быть строкой:

self

аутентифицировать исходящие сигналы как приходящие от текущего Пользователя

peer

аутентифицировать исходящие сигналы как приходящие от участника Задачи (то есть, от отправителя сигнала REFER).

любое другое значение

запретить обработку запросов REFER и INVITE/replaces

SetTransferReportMode(mode)

Эта функция функция устанавливает флаг функции для отчётов о переводе звонка.
Если значение mode является нулевым, то Событие при переводе звонка другому участнику не отправляется.
В противном случае Задача получает специальное Событие CallTransferred, когда она переводится на другого участника.
Функция возвращает предыдущее значение этого флага функции.
При создании новой Задачи, её отчёты о переводе звонков выключаются (флаг функции устанавливается в нулевое значение).

IsCallTransferredEvent(input)

Эта функция возвращает истину, если значением input является Событие CallTransferred. В противном случае функция возвращает нулевое значение.

SetBridgeBreakMode(mode)

Эта процедура используется для указания способа реакции Задачи на разрыв моста другой задачей. Параметр mode должен быть строкой:

disconnect

сигнал BYE отправляется участнику Задачи и Задача переводится в режим disconnected.

keep

если Задача не имеет Медиа Канала, он создаётся и участник Задачи переключается на этот канал.

Диалог

RemoteURI()

Эта функция возвращает строку с URI участника (взятых из адресов диалога From/To). Если сессия отсутствует, функция возвращает нулевое значение.

LocalURI()

Эта функция возвращает строку с URI Задачи.

IncomingRequestURI()

Эта функция возвращает строку с URI ожидающего входящего запроса INVITE. Если ожидающий входящий запрос INVITE отсутствует, то функция возвращает нулевое значение.

RouteLocalURI(uri)

Эта функция пытается провести Маршрутизацию для адреса электронной почты, задаваемого URI. Если URI не может быть разобран или для адреса из URI невозможно провести маршрутизацию, или он маршрутизируется в адрес, не являющийся локальным (то есть, адрес электронной почты принадлежит другой системе), то функция возвращает нулевое значение. В противном случае функция возвращает адрес электронной почты того пользователя CommuniGate Pro, на которого указывает адрес из URI после проведения маршрутизации.
Эта функция позволяет вам корректно обрабатывать все Переадресаторы, Псевдонимы и другие методы маршрутизации, используемые в CommuniGate Pro.

RemoteIPAddress()

Эта функция возвращает объект типа IP адрес, с которого был получен или на который был отправлен запрос на установление сессии. Эта пара IP адрес/порт является фактическим адресом участника или адресом прокси, используемого для ретрансляции сигналов участника.

RemoteAuthentication()

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

DTMF

//
// Sample: ReadInput()/SendDTMF()
//   Accept an incoming call (stop if it's not possible).
//   Wait for an input for 10 seconds. If no input - stop.
//   If a digit is entered
//      play that digit, and send it back.
//      (using "0" ... "9" files)
//   If a star ("*") is entered,
//     wait for a digit (for 3 seconds)
//     and play the digit number square (2 digits)
//   If a pound ("#") is entered or the Peer
//     has disconnected, or any Event was sent, stop.
//
entry Main is
  if AcceptCall() != null then stop; end if;
  loop
    input = ReadInput(10);
	if input == "*" then
	  input = ReadInput(3);
	  if IsString(input) and input != "#" then
	    input = "*" + input;
	  end if;
	end if;
  exitif not IsString(input) or input == "#";
    if Substring(input,0,1) != "*" then
	  PlayFile(input);
	  void(SendDTMF(input));
	else
	  input = Number(Substring(input,1,1);
	  product = input *  input;
	  PlayFile(String(product/10));
	  PlayFile(String(product%10));
	end if;
  end loop;
end entry;

Медиа

PlayFile(fileName)

Эта процедура запрашивает файл из Среды Приложения и воспроизводит его. В строковом параметре fileName задаётся имя файла. Если указанное имя файла не содержит расширения файла, то к нему добавляются поддерживаемые расширения и попытка повторяется.
Файл должен содержать медиа данные в одном из поддерживаемых форматов.
Воспроизведение останавливается или прерывается, если сессия заканчивается или буфер DTMF не пуст (если только Прерывание при DTMF не было выключено), или если Задаче было направлено Событие.

PlayFileInLoop(fileName,msec)

Эта процедура подобна процедуре PlayFile.
Значение msec должно быть числом.
Эта процедура воспроизводит указанный файл в течении msec миллисекунд, повторяя, если время его воспроизведения короче, чем указанный период, файл с начала. Если параметр msec имеет отрицательное значение, то файл воспроизводится в цикле без ограничения времени.
Воспроизведение останавливается или прерывается, если сессия заканчивается или буфер DTMF не пуст (если только Прерывание при DTMF не было выключено), или если Задаче было направлено Событие.

Play(waveData)

Эта процедура воспроизводит блок данных waveData.
Блок данных должен содержать медиа данные в одном из поддерживаемых форматов.
Воспроизведение останавливается или прерывается, если сессия заканчивается или буфер DTMF не пуст (если только Прерывание при DTMF не было выключено), или если Задаче было направлено Событие.

PlayInLoop(waveData,msec)

Эта процедура такая же, как и процедура Play, но она может воспроизводить медиа данные в цикле, так, как это делает процедура PlayFileInLoop.

Record(timeLimit)

Эта функция записывает входящие аудио данные. Значение timeLimit должно быть положительным числом, задающим максимальную продолжительность воспроизведения в секундах.
Запись останавливается или прерывается, если сессия заканчивается или буфер DTMF не пуст, или если Задаче было направлено Событие.
Функция возвращает либо нулевое значение, если запись была остановлена, либо блок данных с записанным аудио в формате WAV.

SetLocalHold(flag)

Эта процедура ставит текущий вызов "на ожидание" (если flag имеет значение истина) или снимает его с ожидания (если flag имеет нулевое значение).
Эта процедура может использоваться только когда задача находится в режиме connected и медиа мост у участника Задачи участника Задачи отсутствует.

ReleaseMediaChannel()

Эта процедура освобождает Медиа Канал Задачи (и связанные с ним системные ресурсы).
Эта процедура может использоваться только когда Задача находится в режиме disconnected или у участника Задачи существует медиа мост.

//
// Sample: Record()/PlayFile()/Play()
//   Accept an incoming call (stop if it's not possible).
//   Play the GreetingIs file.
//   Read the current prompt from
//      the MyGreeting.wav file in the Personal Site.
//   Loop playing the greeting.
//      if "1" is entered, rewrite the prompt file and quit
//      if "2" is entered, play "Beep" and record the prompt.
//
entry Main is
  if AcceptCall() != null then stop; end if;
  PlayFile("GreetingIs");
  prompt = ReadSiteFile("MyGreeting.wav");
  loop
    if IsData(prompt) then Play(prompt); end if;
    input = ReadInput(10);
  exitif not IsString(input) or else input == "#";
    if input == "1" then
	  if WriteSiteFile("MyGreeting.wav",prompt) then
	    PlayFile("Goodbye"); stop;
	  end if;
	  PlayFile("Failure");
	elif input == "2" then
	  PlayFile("Beep");
	  prompt = Record(30);
	else
	  PlayFile("InvalidEntry");
	end if;
  end loop;
  PlayFile("GoodBye");
end entry;

Мосты и Миксеры

//
// Sample: StartBridge()/AcceptBridge()/BreakBridge()
//   Accept an incoming call (stop if it's not possible).
//   Create a new Task to run the Caller code,
//     and send it an Event with the URI to dial.
//   Play the PleaseWait media file.
//   Wait for a StartBridge Event from the Caller Task.
//   Accept it and loop till the user disconnects.
//
//   The Caller code:
//   Receive a URI to call as an Event from the parent Task
//   Connect to the URI and play the YouGotACall media file
//   StartBridge with the parent, loop till the user disconnects
//
entry Caller forward;
procedure ControlBridge() forward;

entry Main is
  if AcceptCall() != null then stop; end if;

  callerTask = spawn Caller;
  if callerTask == null or else
     SendEvent(callerTask,"dial","sip:internal@partner.dom") != null then
	PlayFile("Failure");
	stop;
  end if;

  PlayFile("PleaseWait");
  input = ReadInput(30);
  if not IsStartBridgeEvent(input) or else
     AcceptBridge(input) != null then
	PlayFile("Failure");
	stop;
  end if;

  // we have established a bridge
  ControlBridge();
  PlayFile("GoodBye");
end entry;

//
// Caller Task code
//
entry Caller is
  // wait for a "dial" event from the main task
  input = ReadInput(30);
  if input == null or input.what != "dial" then stop; end if;

  mainTask = input.sender;

  // Calling the URI specified as the Event parameter
  // If connection failed, send an Event back to the
  //  main task and quit 
  resultCode = StartCall(startEvent.parameter);
  if resultCode != null then
    void(SendEvent(mainTask,"result",resultCode));
	stop;
  end if;

  // wait for any Event other than provisional ones
  loop
    input = ReadInput(3600);
  exitif not IsCallProvisionEvent(input);
  end loop;

  // the parent has sent us "stop" - then we'll die immediately
  if IsDictionary(input) and then input.what == "stop" then stop; end if;
  
  if not IsCallCompletedEvent(input) or else input.parameter != null then
    void(SendEvent(mainTask,"result","generic error"));
	stop;
  end if;

  if StartBridge(mainTask) != null then
	PlayFile("Failure");
	stop;
  end if;

  // we have established a bridge
  ControlBridge();
  PlayFile("GoodBye");
end entry;

//
// Controlling the peer signaling:
// while the media is bridged:
//	exit if the peer hangs up, dials "#"
//  or if the bridge is removed
//  
procedure ControlBridge() is
  loop
    input = ReadInput(3600);
  exitif IsBreakBridgeEvent(input) or else 
          IsDisconnectEvent(input) or else input == "#";
  end loop;
  void(BreakBridge());
end procedure;

Перевод Звонка

Запросы INFO