Требования к пользовательскому приложению (информация для разработчика)
Пользовательское приложение маршрутизации, указанное пользователем, запускается программным обеспечением Fax Voip T.38 Консоль при выполнении Пользовательского метода маршрутизации, после отправки факса или аудио сообщения. Индивидуальный разработчик отвечает за разработку этого приложения, создание графического интерфейса пользователя (GUI) для настройки правил и других параметров и за сохранение конфигурации. Функции приложения могут включать, но не ограничены печатью факсов, сохранением факсов и аудио сообщений, преобразованием графических изображений факса в текстовые файлы, доставкой факсов и аудио сообщений в приложениях электронной почты и т.д.
Ниже приведены общие требования, которые должны быть приняты во внимание разработчиками программного обеспечения при написании пользовательских приложений.
Аргументы командной строки
Командная строка, передаваемая в приложение, предопределена и содержит всю необходимую информацию. Разработчик может проанализировать командную строку в своем приложении, чтобы получить путь к факсу или аудио файлу и другие важные параметры, такие как номер получателя, идентификатор факса отправителя (TSID), идентификатор факса получателя (CSID) и т. д.
Ниже приведен пример аргументов командной строки, переданных вашему приложению в случае отправки факса:
/@@@Fax
/@@@FileName=C:\WINDOWS\TEMP\7E5371130B5A12C12C_occc\FAX.pdf
/@@@RecipientNumber=19012223344
/@@@SenderEmail=Dan@t38faxvoip.com
/@@@DocumentName=invoice07_10_20_003.pdf;Information.txt /@@@PagesTotal=4
/@@@RemoteFaxID=(901) 222-3344 /@@@LocalFaxID=(631) 490-16-10 FAX /@@@FaxHeader=FaxVoip Software, LLC
/@@@SubmissionTime=07.10.2020@01:28:18 /@@@OriginalScheduledTime=07.10.2020@01:28:18
/@@@ScheduledTime=07.10.2020@01:28:18
/@@@StartTime=07.10.2020@01:32:49 /@@@EndTime=07.10.2020@01:36:14 /@@@Duration=00:03:25
/@@@BitRate=14400 /@@@Ecm=0 /@@@FaxMode=T.38 /@@@PagesTransferred=4 /@@@Resolution=204x196 dpi
/@@@JobStatus=Completed /@@@ExtendedStatus=OK /@@@Retries=0
Ниже приведен пример аргументов командной строки, переданных вашему приложению в случае отправки аудио сообщения:
/@@@Audio
/@@@FileName=C:\WINDOWS\TEMP\7E53772E3B8E3A03A0_occc\MESSAGE.wav
/@@@RecipientNumber=19012223344
/@@@SenderEmail=Dan@t38faxvoip.com
/@@@DocumentName=Maid with the Flaxen Hair.mp3
/@@@WaveLength=156.1 s /@@@WaveFrequency=8,000 kHz
/@@@SubmissionTime=07.10.2020@01:28:18 /@@@OriginalScheduledTime=07.10.2020@01:28:18
/@@@ScheduledTime=07.10.2020@01:28:18
/@@@StartTime=07.10.2020@01:32:49 /@@@EndTime=07.10.2020@01:35:26 /@@@Duration=00:02:37
/@@@JobStatus=Completed /@@@ExtendedStatus=OK /@@@Retries=0
Командная строка содержит следующие аргументы:
Указывает, что исходящий вызов является вызовом факса.
Указывает, что исходящий вызов является аудио вызовом.
Временная копия исходящего факса (файл TIFF, PDF или SFF в зависимости от вашего выбора) или аудио сообщения (файл WAV). Этот файл и временная папка, в которой он находится (в папке %temp% для учетной записи текущего пользователя или системной учетной записи Local System), должны быть удалены в пользовательском приложении маршрутизации после выполнения необходимых действий. Если флажок Создавать временную копию отправленного факса в формате (Создавать временную копию отправленного аудио сообщения) не установлен, этот аргумент отсутствует в командной строке. См. также в главе Пользовательская маршрутизация исходящих факсов и аудио сообщений настоящего справочного руководства.
Номер факса или телефона получателя.
Адрес электронной почты отправителя. В случае создания факса или аудио сообщения функцией Почта-на-факс (аудио через почту), это адрес электронной почты отправителя, извлеченный из сообщения e-mail.
В случае создания факса функцией Почта-на-факс, исходное имя документа, включая расширение файла. При отправке нескольких документов их имена разделяются запятыми. В случае создания аудио сообщения функцией Аудио через почту, имя оригинального аудио файла, включая расширение файла.
Общее количество страниц в исходящем факсе. Значение (-1) используется, когда данные недоступны.
Код вызываемого абонента (CSID), принятый от получателя факса.
Код передающего абонента (TSID), идентифицирующий его как отправителя факса. Передается получателю при отправке факса.
Текст, передаваемый в верхней части каждой страницы факса.
Длина аудио сообщения, в секундах.
Частота дискретизации, кГц аудио файла.
Время добавления исходящего факса или аудио сообщения в папку Исходящие, в формате 'mm.dd.yyyy@hh:mm:ss'.
Время, на которое первоначально была назначена отправка исходящего факса или аудио сообщения, в формате 'mm.dd.yyyy@hh:mm:ss'.
Время, на которое была назначена отправка исходящего факса или аудио сообщения в последний раз, в формате 'mm.dd.yyyy@hh:mm:ss'. Это время может быть позже исходного запланированного времени из-за задержек, связанных например с занятостью номера.
Время начала осуществления исходящего вызова или время начала передачи исходящего факса (аудио сообщения), в формате 'mm.dd.yyyy@hh:mm:ss'.
Время окончания исходящего вызова или передачи исходящего факса (аудио сообщения), в формате 'mm.dd.yyyy@hh:mm:ss'.
Продолжительность исходящего вызова или продолжительность передачи исходящего факса (аудио сообщения), в формате 'hh:mm:ss'.
Скорость передачи факса.
Указывает, использовалась ли Коррекция ошибок (ECM) при отправке факса. Допустимые значения: 1 - с ECM, 0 - без ECM, -1 - данные отсутствуют, в частности, при отправке факса по протоколу ISDN-FAX B3:4:SFF.
Протокол, используемый при передаче факса. Допустимые значения: T.38, G711-FAX - аудио факс поверх кодека G.711 через VOIP или линию ISDN CAPI 2.0, ISDN-FAX B3:4:SFF - факс через линию ISDN CAPI 2.0 с использованием B3 Protocol 4: T.30 for Group 3 fax, ISDN-FAX B3:5:SFF - факс через линию ISDN CAPI 2.0 с использованием B3 Protocol 5: T.30 for Group 3 fax extended.
Число успешно переданных страниц факса. Значение (-1) используется, когда данные недоступны.
Качество изображения факса. Может быть 204x196 dpi (Fine) или 204x98 dpi (Normal).
Состояние задания отправки факса или аудио сообщения (на английском языке). Примеры: Completed, Retries exceeded.
Результат отправки факса или аудио сообщения. Пример: OK (в случае успешной отправки факса или аудио сообщения). В случае неудачной отправки факса или аудио сообщения содержит описание ошибки (на английском языке).
Число предпринятых системой попыток отправить исходящий факс или аудио сообщение после неудачной первоначальной попытки.
Временная копия отправленного факса или аудио сообщения
Если установлен флажок Создавать временную копию отправленного факса в формате (Создавать временную копию отправленного аудио сообщения) (см. в главе Пользовательская маршрутизация исходящих факсов и аудио сообщений настоящего справочного руководства), Пользовательский метод маршрутизации создает временную папку и копирует исходящий факс (файл TIFF, PDF или SFF в зависимости от вашего выбора) или аудио сообщение (файл WAV) в эту папку. Временная папка создается в папке %temp% для учетной записи текущего пользователя или системной учетной записи Local System (если Fax Voip T.38 Консоль запущена в качестве службы Windows). Путь к временному файлу (копия принятого факса или аудио сообщения) передается в пользовательское приложение через аргумент командной строки FileName, см. выше.
Например,
/@@@FileName=C:\WINDOWS\TEMP\7E5371130B5A12C12C_occc\FAX.pdf
Путь к факсу (PDF формат):
C:\WINDOWS\TEMP\7E5371130B5A12C12C_occc\FAX.pdf
Путь к временной папке:
C:\Windows\TEMP\7E5371130B5A12C12C_occc\
Например,
/@@@FileName=C:\WINDOWS\TEMP\7E53772E3B8E3A03A0_occc\MESSAGE.wav
Путь к аудио файлу:
C:\WINDOWS\TEMP\7E53772E3B8E3A03A0_occc\MESSAGE.wav
Путь к временной папке:
C:\Windows\TEMP\7E53772E3B8E3A03A0_occc\
Временная папка, в которой находится факс (FAX.tif, FAX.pdf или FAX.sff) или аудио файл (MESSAGE.wav), может использоваться вашим пользовательским приложением для хранения временных файлов, создаваемых вашим приложением.
Пользовательское приложение отвечает за удаление временной копии факса или аудио сообщения и временной папки, в которой она находится. Вы должны навсегда удалить временную папку в своем приложении после выполнения всех необходимых действий.
Если флажок Создавать временную копию отправленного факса в формате (Создавать временную копию отправленного аудио сообщения) не установлен, Пользовательский метод маршрутизации не создает копию исходящего факса или аудио сообщения.
Запуск под учетной записью текущего пользователя или под системной учетной записью Local System
Пользовательское приложение запускается в контексте учетной записи текущего пользователя или системной учетной записи Local System (если Fax Voip T.38 Консоль запущена в качестве службы Windows). Таким образом, соответствующая учетная запись должна иметь необходимый доступ к файлам, папкам и другим объектам, с которыми работает ваше приложение.
Завершение приложения
Пользовательский метод маршрутизации запускает пользовательское приложение маршрутизации в отдельном потоке путем вызова функции CreateProcess. Fax Voip T.38 Консоль не отслеживает приложение после его запуска и не гарантирует его корректное завершение. Разработчик пользовательского приложения отвечает за правильное автоматическое завершение работы приложения после его выполнения.