API для интеграции

Программный интерфейс API для интеграции сall-центра, CRM и облачной АТС

HTTP GET NOTIFICATION 1.0 Для подключения услуги необходимо сообщить адрес для нотификации менеджеру.
Например http://84.52.103.114/test/requestlog.php/
Тип передачи данных: GET запрос.
Система сообщает о следующих событиях:

Название метода Описание Параметры Пример Направление звонка
StartCall Начало звонка на телефонный номер CALLID – уникальный идентификатор звонка; STATE=STARTCALL – описание состояния; ANI – номер абонента А (calling party number); DNIS – номер абонента Б (called party number); DT – дата; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE=STARTCALL&
ANI=9110000000& DNIS=8123350515&
DT=01.01.2012 10:00:00
для входящих звонков и исходящих звонков
CallOut Старт исходящей связи CALLID – уникальный идентификатор звонка; STATE=CALLOUT – описание состояния; ANI – номер абонента А (calling party number); DNIS – номер абонента Б (called party number); DT – дата; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE=CALLOUT&
ANI=9110000000& DNIS=8123350515&
DT=01.01.2012 10:00:00
для исходящих вызовов автоинформатора
Calling Переадресация CALLID – уникальный идентификатор звонка; STATE= REDIRECT – описание состояния; PHONE – номер переадресации; DT – дата; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE=REDIRECT&
DT=01.01.2012 10:00:05&
PHONE =9110000001
для входящих звонков
CallProcess Успешно установлено соединение CALLID – уникальный идентификатор звонка; STATE= CALLPROCESS -описание состояния; DT – дата; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE=CALLPROCESS&
DT=01.01.2012 10:00:30
для входящих звонков и исходящих звонков
CallNoAnswer Абонент не ответил CALLID – уникальный идентификатор звонка; STATE= CALLNOANSWER -описание состояния; REL – причина, по которой абонент не ответил; DT – дата; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE=CALLNOANSWER&
DT=01.01.2012 10:00:30& Rel=19
для входящих звонков
StartQueue Старт очереди ожидания CALLID – уникальный идентификатор звонка; STATE= QUEUESTART – описание состояния; DT – дата; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE=QUEUESTART&
DT=01.01.2012 10:00:15
для входящих звонков
EndQueue Окончание очереди ожидания CALLID – уникальный идентификатор звонка; STATE= QUEUEEND – описание состояния; DT – дата; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE=QUEUEEND&
DT=01.01.2012 10:00:15
для входящих звонков
GetDTMF Нажатие кнопок абонентом CALLID – уникальный идентификатор звонка; STATE= GETDTMF- описание состояния; DT – дата; ANI – номер абонента А (calling party number); DNIS – номер абонента Б (called party number); DTMF – нажатые абонентом клавиши; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE=GETDTMF&
DT=01.01.2012 10:00:00&
DTMF=1& ANI=9110000000&
DNIS=8123350515
для входящих звонков
EndCall Звонок завершен CALLID уникальный идентификатор звонка; STATE= ENDCALL – описание состояния; DT – дата; DURATION – длительность звонка; LINKDURATION – длительность соединения; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE=ENDCALL&
DT=01.01.2012 10:00:40&
DURATION=40& LINKDURATION=10
для входящих звонков и исходящих звонков
VoiceMail Записан VoiceMail CALLID уникальный идентификатор звонка; STATE= VOICEMAIL – описание состояния; DT – дата; FILENAME – имя файла; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE= VOICEMAIL &
DT=01.01.2012 10:00:40 &
FILENAME =VM_8123350515_VM_ 9111111111_010120121101010.wav
Для прослушивания/скачивания файла нужно вызвать
http://www.votbox.ru/phone/_playVMN.php?
username=USERNAME
&password=MD5(PASSWORD)&fn=FILENAME
для входящих звонков
RecordTalk Записан RecordTalk CALLID уникальный идентификатор звонка; STATE= RECORDTALK – описание состояния; DT – дата; FILENAME – имя файла; http://84.52.103.114/test/requestlog.php/?
CALLID=4654& STATE= RECORDTALK &
DT=01.01.2012 10:00:40 &
FILENAME = RT_8123350515_89211111111_ 9111111111_010120121101010.wav
http://www.votbox.ru/phone/_playRTN..php?
username=USERNAME
&password=MD5(PASSWORD)&fn=FILENAME
для входящих звонков

CHECK BALANCE API

Для получения текущего баланса надо вызвать скрипт http://www.votbox.ru/api/check.balance.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
* – параметр является обязательным.

Верный ответ выглядит так:

В случае ошибки:

1. FAX SEND API

Для отправки факса следует вызвать скрипт http://www.votbox.ru/api/fax.send.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
Phone ** Text Телефон в формате:
Для звонков по России:
8 (код города/префикс) (номер абонента), например: 84950000000 или 89110000000
Для междугородних звонков:
810 (код страны) (код города) (номер абонента), например, 810490000000000
item_csv ** File Файл с номерами для отправки
Формат файла CSV (Comma Separated Values)
вида : 88121112233 84952223344 84993334455
IsDialExt Text Признак донабора:
1 – вводить донабор; 0 – донабор не требуется
NextAttemptStart Text Дата/время отправки факса
(формат "YYYY-MM-DD hh:mm:ss")
DialExtVal Text Донабор
DialExtTimeout Text Таймаут перед донабором в секундах
userfile *** File Файл для отправки.
Список поддерживаемых форматов:
Microsoft Word files (*.doc, *.rtf, *.txt, *.wri, *.log, *.xml)
Microsoft Excel files (*.xls, *.xlw, *.xlc)
Microsoft PowerPoint files (*.ppt, *.pps)
HTML files (*.htm, *.html, *.shtm, *.shtml)
Portable Document Format files (*.pdf)
JPEG image files (*.jpg)
TIFF image files (*.tif)
Windows Bitmap image files (*.bmp)
ZSoft PCX image files (*.pcx)
ZSoft DCX image files (*.dcx)
CServe Portable Network Graphics image files (*.png)
Graphics Interchange Format image files (*.gif)
FileID *** Text Уникальный идентификатор ранее загруженного в систему файла
Attempts Text Количество попыток дозвона
Delay Text Интервал между попытками в минутах
NotifyOnOk Text Признак уведомления об успешной отправке:
0 – не отправлять уведомление; 1 – уведомлять по EMail
NotifyOnError Text Признак уведомления об ошибке:
0 – не отправлять уведомление; 1 – уведомлять по EMail
NotifyEMail Text Email адрес для получения уведомлений
* – параметр является обязательным.
** – наличие одного из параметров Phone или item_csv обязательно.
*** – наличие одного из параметров userfile или FileID обязательно.

В ответе сгенерирует XML сообщение следующего вида:

1. В случае успешной постановки задачи:

Где

Имя поля Тип
id уникальный идентификатор задачи
fileid уникальный идентификатор загруженного в систему файла
proprity приоритет задачи
jobstatus статус выполнения
1 – задача находится в процессе обработки
2 – факс успешно доставлен
3 – ошибка
4 – задача находится в очереди на отправку
6 – задача остановленна пользователем
7 – конвертируется файл
attempts количество попыток отправки
attemptsdone количество совершённых попыток отправки
nextattemptstart время следующей попытки
tifffilepages количество страниц
notifyonok признак уведомления об успешной отправке
notifyonerror признак уведомления об ошибке
notifyemail email для отправки уведомлений
isdialext признак донабора:
1 – вводить донабор; 0 – донабор не требуется
dialextval донабор
dialexttimeout таймаут перед донабором в секундах

2. Если же в процессе постановки задачи (либо в полученных данных) была ошибка, то:

2. FAX CHECK API

Для отправки факса следует вызвать скрипт http://www.votbox.ru/api/fax.check.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
faxid ** Text уникальный идентификатор задачи если надо проверить единичный факс
listid ** Text уникальный идентификатор списка рассылки свойство listid элемента item при постановке задачи
* – параметр является обязательным.
** – один из параметров должен быть передан.

В ответе сгенерирует XML сообщение следующего вида:

Если был передан параметр listid, будет возвращен список задач

Либо в случае ошибки вызова или обработки запроса:

3. FAX STOP API

Для отмены отправки факса следует вызвать скрипт http://www.votbox.ru/api/fax.stop.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
faxid Text уникальный идентификатор задачи
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Если был передан параметр listid, будет возвращен список задач

Либо в случае ошибки вызова или обработки запроса:

1. AUTOCALL SIMPLE API

Для упрощённой постановки задачи на 1 номер надо вызвать скрипт http://www.votbox.ru/api/autocall.simple.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
schemeid * Text ID шаблона используемого при звонке
phone * Text Номер телефона в формате 8XXXYYYZZAA
* – параметр является обязательным.

Верный ответ выглядит так:

В случае ошибки:

2. AUTOCALL GET ANI API

Для получения списка доступных АОН номеров надо вызвать скрипт http://www.votbox.ru/api/autocall.get.ani.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
* – параметр является обязательным.

Верный ответ выглядит так:

В случае ошибки:

3. AI TEMPLATE API

Для создания шаблона автоинформатора следует вызвать скрипт http://www.votbox.ru/api/autocall.scheme.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
TemplateName * Text Название шаблона для отображения в пользовательском интерфейсе
TemplateDescription Text Описание
AniID * Text ID – АОНа телефонного номера, от которого будет проводиться звонок. Список ID доступных АОНов можно посмотреть в пользовательском интерфейсе
IsRandom Text Возможность случайного выбора АОНа;
0 – только указаный в шаблоне; 1 – выбирать случайным образом из списка доступных;
CheckPlayGreeting Text 0 – без приветствия; 1 – читать файл приветствия
GreetingFromFile Text 0 – загрузить звук или ТТС текст в шаблон; 1 – брать ТТС текст или ID звукового файла из CSV при постановке задачи
FGREETING ** *** File Звуковой файл приветствия
tts_FGREETING ** *** Text Текст файла приветствия для конвертации
tts_voice_FGREETING Text Голос приветствия для конвертации (0 – женский; 1 – мужской)
IsRecordMessages Text 0 – без записи сообщения абонента; 1 – записать голосовое сообщение
MessageParam Text EMail адрес для отправки сообщения
CancelDTMF Text В случае IsCancelDTMF=1 клавиша отказа от звонка
CheckPlayInfo Text 0 – без информационного файла; 1 – читать информационный файл
FINFO ** File Звуковой информационный файл
tts_FINFO ** Text Текст информационного файла для конвертации
tts_voice_FINFO Text Голос информационного файла для конвертации (0 – женский; 1 – мужской)
CheckUserReaction Text Признак необходимости запроса реакции пользователя:
0 – не требуется; 1 – запрос
ReactionType Text Тип интерактивного запроса реакции пользователя:
0 – без интерактивного запроса; 1 – предоставить меню выбора
AutoAction Text В случае ReactionType=0 вариант действий системы:
0 – завершение звонка; 1 – повтор информационного сообщения; 2 – соединение с оператором из списка
AutoActionParam Text В случае AutoAction=1 количество повторов
ActionPhoneList Text В случае AutoAction=2 список телефонов для переадресации, разделённых символом | (вертикальная черта)
FMENU File В случае ReactionType=1 файл звукового меню
tts_FMENU Text Текст меню для конвертации
tts_voice_FMENU Text Голос меню для конвертации (0 – женский; 1 – мужской)
MenuRepeatCount Text Количество повторов файла меню при отсутствии выбора абонента
MENU_STRUCT Text Структура интерактивного меню срока вида
KEY1:DESCR1:ACTIONCODE1:ACTIONPARAM1;
KEY2:DESCR2:ACTIONCODE2;
KEY3:DESCR3:ACTIONCODE3:ACTIONPARAM3
Где
KEY – клавиша (цифра * или #)
DESCR – Описание для отображения в интерфейсе
ACTIONCODE тип действия при нажатии:
0 – закончить звонок;
1 – повтор информационного сообщения;
2 – звонок оператору из списка;
ACTIONPARAM – в случае ACTIONCODE=1 количество повторов, если же ACTIONCODE=2 список номеров для переадресации, разделённых символом | (вертикальная черта)
CheckPlayFinal Text Признак использования звукового файла завершения звонка
FFINAL ** File Звуковой файл завершения звонка
tts_FFINAL ** Text Текст файла завершения для конвертации
tts_voice_FFINAL Text Голос файла завершения для конвертации (0 – женский; 1 – мужской)
CheckPlayLoop Text Признак использования мелодии ожидания ответа оператора
FLOOP** File Звуковой файл мелодии ожидания ответа оператора
tts_ FLOOP ** Text Текст файла мелодии ожидания для конвертации
tts_voice_FLOOP Text Голос файла мелодии ожидания для конвертации (0 – женский; 1 – мужской)
DialTimeout Text Время ожидания ответа в секундах
MaxAttempts Text Число – количество попыток дозвона
AttemptsInterval Text Число – интервал между попытками
MenuOutCallCount Text Количество одновременных исходящих звонков
CallOkType Text Признак удачного завершения:
0 – был ответ абонента;
1 – длительность звонка;
2 – прочитан информационный файл;
3 – нажата клавиша меню;
4 – соединение с оператором
CallOkParam Text Если CallOkType=1 длительность в секундах
ttsVoice Text Тип голоса при генерации ТТС сообщений:
-1 = брать тип из CSV файла;
0 = женский;
1 = мужской
NotifyUrl Text URL callback скрипта нотификации о ходе исполнения (см. п. 15)
TransANI Text Трансляция номера абонента при звонке оператору
0 – нет; 1 – да;
* – параметр является обязательным.
** – в случае выставленного соответствующего признака CheckPlayXXX, наличие одного из параметров XXXGREETING или tts_XXXGREETING обязательно.
*** – для файла приветствия возможна также загрузка индивидуальных приветствий в составе CSV данных при постановке задачи.

1. В ответе сгенерирует XML сообщение следующего вида:

Где obj.id – уникальный идентификатор, который может быть использован при автоматической постановке задачи при помощи autocall api

2. Если же в процессе постановки задачи (либо в полученных данных) была ошибка, то:

4. AUTOCALL SCHEDULE API

Для изменения расписания шаблона следует вызвать скрипт http://www.votbox.ru/api/autocall.schedule.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
schemeid ** Text уникальный идентификатор шаблона задачи (obj.id из предыдущего запроса Template API)
dN * Text где N – порядковый номер записи (1,2,3 .... и т.д.)
номер дня недели, для которого устанавливаем расписание:
1 = Понедельник
2 = Вторник
3 = Среда
4 = Четверг
5 = Пятница
6 = Суббота
7 = Воскресенье
8 = Праздники
9 = Переносы
tsN * Text где N – порядковый номер записи (1,2,3 .... и т.д.)
время начала обзвона по Москве в формате 00:00
teN * Text где N – порядковый номер записи (1,2,3 .... и т.д.)
время окончания обзвона по Москве в формате 23:59
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Где obj.id – уникальный идентификатор расписания, который совпадает с obj.scheduleid из запроса Template API

Либо в случае ошибки вызова или обработки запроса:

5. AUTOCALL API

Для создания задачи автоинформатора следует вызвать скрипт http://www.votbox.ru/api/autocall.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
schemeid ** Text ID шаблона автоинформаирования (виден в интерфейсе в списке шаблонов)
voicefilefromcsv ** Text Признак необходимости брать файл приветствия из структуры CSV файла номеров
0 – Нет; 1 – Да
FGREETING ** File Звуковой файл приветствия
FLIST*** File Файл с номерами для отправки
Формат файла CSV (Comma Separated Values) вида:
88121112233; DESCR1; TIME1; FILEID1; VOICEID1; VOICETEXT1; DIALTIMEOUT1; DTEND1; DTDIFF1; CLIID1; CCPHONE1; ANI1
84952223344; DESCR2; TIME2; FILEID2; VOICEID2; VOICETEXT2; DIALTIMEOUT2; DTEND2; DTDIFF2; CLIID2; CCPHONE2; ANI2
84993334455; DESCR3; TIME3; FILEID3; VOICEID3; VOICETEXT3; DIALTIMEOUT3; DTEND3; DTDIFF3; CLIID3; CCPHONE3; ANI3

В случае voicefilefromcsv=0 обязательным является только номер телефона
DESCR – необязательное описание (можно указать 2 значения, разделив их символом ~ тильда)
TIME – дата и время обзвона номера например 2011-07-18 14:30:00
FILEID – идентификатор ранее загруженного в систему звукового файла
VOICEID1 – тип голоса (0 – женский; 1 – мужской)
VOICETEXT1 – текст сообщения
Также поддерживается механизм автозамены.
Для этого в нужные места текста вставляются маркеры {S}, а в следующих после текста полях – значения для замены (количество маркеров должно соответствовать количеству значений)
DIALTIMEOUT1 – время дозвона в секундах
DTEND1 – время жизни сообщения
DTDIFF1 – "сдвиг" времени обзвона (время указывается для МСК, а этот параметр – поправка на часовой пояс абонента)
CLIID1 – числовой параметр-идентификатор в "вашей" CRM позволяет в последствии отслеживать "историю" оповещений абонента
CCPHONE1 – номер оператора колцентра, который будет обслуживать абонента. В случае если в шаблоне указан список номеров, а в записи заполненно это поле, то список будет проигнорирован и дозвон будет производиться только на этот номер
ANI1 – индивидуальный АОН для звонка абоненту в формате XXXYYYYYYY без лидирующей восьмёрки
start_time Text Дата и время запуска задачи (в случае отсутсвия – текущее время)
schemedialtimeout **** Text Время ожидания ответа в секундах
schememaxattempts **** Text Количество попыток дозвона
schemeattemptsdelay **** Text Интервал между попытками
schemeaniid **** Text ID – АОНа телефонного номера, от которого будет проводиться звонок. Список ID доступных АОНов можно посмотреть в пользовательском интерфейсе
isPaused Text Признак создать задачу, но не стартовать сразу (0 – старт; 1 – пауза)
schemenotifyurl **** File URL callback скрипта нотификации о ходе исполнения (см. п. 15)
* – параметр является обязательным.
** – наличие одного из параметров schemeid, voicefilefromcsv или FGREETING обязательно.
*** – наличие FLIST обязательно.
**** – имеет смысл только при отсутствии параметра schemeid.

В ответе сгенерирует XML сообщение следующего вида:

1. В случае успешной постановки задачи:

Где:

Имя поля Тип
task.id Уникальный идентификатор задачи
task.taskname Имя созданной задачи
task.taskstarttime Время запуска задачи (Unix)
task.taskstatus Статус выполнения
task.taskstatusstr Статус выполнения строка
item.id ID звонка
item.phonenumber Телефон для звонка
item.jobstatus Статус звонка
item.jobstatusstr Статус выполнения строка

2. Если же в процессе постановки задачи (либо в полученных данных) была ошибка, то:

6. AUTOCALL CHECK API

Для проверки статуса задачи следует вызвать скрипт http://www.votbox.ru/api/autocall.check.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
taskid * Text Уникальный идентификатор задачи (task.id из предыдущего запроса)
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Значения для jobstatus:
0 – в очереди;
1 – в процессе;
2 – ошибка;
3 – успешно;
4 – соединен с оператором;
5 – ошибка биллинга;
7 – истекло время жизни;
11 – завершено пользователем.

Либо в случае ошибки вызова или обработки запроса:

7. AUTOCALL GET ACTIVE API

Для списка активных следует вызвать скрипт http://www.votbox.ru/api/autocall.get.task.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Либо в случае ошибки вызова или обработки запроса:

8. AUTOCALL CHECK CALL API

Для подробной статистики по звонку следует вызвать скрипт http://www.votbox.ru/api/autocall.detail.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
itemid * Text Уникальный идентификатор звонка (item.id из запроса 4)
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Либо в случае ошибки вызова или обработки запроса:

9. AUTOCALL GET RECORDTALK API

Для получения звукового файла записи разговора с оператором нужно вызвать скрипт http://www.votbox.ru/api/autocall.recordtalk.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
callid ** Text Уникальный идентификатор звонка (item.id из предыдущего запроса) ЛИБО
filename ** Text Имя файла записи (item.recfilename из предыдущего запроса)
* – параметр является обязательным.
** – наличие одного из параметров является обязательным.

В ответе будет звуковой файл записи разговора с оператором.

Либо в случае ошибки вызова или обработки запроса:

10. AUTOCALL START API

Для немедленного запуска задачи следует вызвать скрипт http://www.votbox.ru/api/autocall.start.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
Taskid * Text Уникальный идентификатор задачи (task.id из запроса постановки задачи)
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Либо в случае ошибки вызова или обработки запроса:

11. AUTOCALL PAUSE API

Для приостановки выполнения задачи следует вызвать скрипт http://www.votbox.ru/api/autocall.pause.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
Taskid * Text Уникальный идентификатор задачи (task.id из запроса постановки задачи)
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Либо в случае ошибки вызова или обработки запроса:

12. AUTOCALL STOP API

Для завершения выполнения задачи следует вызвать скрипт http://www.votbox.ru/api/autocall.stop.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
Taskid * Text Уникальный идентификатор задачи (task.id из запроса постановки задачи)
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Либо в случае ошибки вызова или обработки запроса:

13. AUTOCALL CREATE WAV FILE API

Для загрузки файла в медиахранилище (подменю "Звуковые файлы") следует вызвать скрипт http://www.votbox.ru/api/autocall.mediafile.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
userfile * File Звуковой файл (допустимые форматы: .cda .m2a .mp1 .mp2 .mp3 .mpga .mpa .mpx .mpg .wav)
tts_userfile * Text Текст для конвертации TTS
tts_voice_userfile Text Голос для TTS (0 – женский; 1 – мужской)
Descr Text Описание / комментарий
UserID Text Уникальный идентификатор для последующего использования см. п. 3. Autocall API
* – один из параметров является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Либо в случае ошибки вызова или обработки запроса:

14. AUTOCALL STOP LIST

Для принудительного завершения обзвона нескольких номеров в рамках задачи следует вызвать скрипт http://www.votbox.ru/api/autocall.stop.file.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
taskid * Text Уникальный идентификатор задачи (task.id из запроса 4.)
StopPhoneFileName File CSV файл срок вида
PHONE1;ITEMID1
PHONE2;ITEMID2
Где
PHONE1 – номер, дозвон на который надо остановить
ITEMID1 – itemid из запроса 4., дозвон на который надо остановить
Один из параметров должен присутствовать!
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Либо в случае ошибки вызова или обработки запроса:

15. AUTOCALL BREAK API

Для завершения выполнения задачи и прерывания всех соединений следует вызвать скрипт http://www.votbox.ru/api/autocall.break.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
taskid * Text Уникальный идентификатор задачи (task.id из запроса постановки задачи)
* – параметр является обязательным.

Прервать можно не все задачи, а только с установленным признаком, для чего при создании задачи в autocall.api.php нужно указать дополнительный параметр canbreakcalls=1.

В ответе сгенерирует XML сообщение следующего вида:

Либо в случае ошибки вызова или обработки запроса:

16. СПИСОК НОТИФИКАЦИЙ, ПРИХОДЯЩИХ НА АДРЕС СКРИПТА NOTIFYURL (SCHEMENOTIFYURL)

Общие параметры для любого вызова:
CALLID – уникальный идентификатор звонка (item.id из запроса 4.)
STATE – событие
DT – дата время события

Событие Описание Доп. параметры
STATE=CALLOUT начало обработки звонка, старт вызова ANI – АОН вызова;
DNIS – номер абонента
STATE=STARTCALL абонент поднял трубку
STATE=CALLPROCESS оператор (второй вызов) поднял трубку
STATE=CALLNOANSWER абонент/оператор не отвечает REL – тип отбоя от абонента
STATE=GETDTMF Нажатие кнопок абонентом DTMF - нажатая абонентом клавиша
STATE=REDIRECT переадресация на второго абонента (оператора) Phone – номер оператора;
addinfo – информация, передаваемая вместе с номером абонента при постановке задачи (FLIST поле DESCR)
STATE=ENDCALL звонок завершен CALLDURATION – длительность соединения с первым абонентом
OPERCALLDURATION – длительность соединения с оператором
JOBSTATUS – статус звонка
CALLPAY – стоимость вызова на абонента (копеек)
OPERCALLPAY – стоимость вызова на оператора (копеек)

17. TEMPLATE LINES API

Для получения или изменения количества одновременных исходящих звонков в указанном шаблоне надо вызвать скрипт http://www.votbox.ru/api/autocall.schemelines.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
schemeid * Text Уникальный идентификатор шаблона
MenuOutCallCount Text Количество одновременных исходящих звонков. Если параметр не указан, скрипт вернёт текущее количество из шаблона.
* – параметр является обязательным.

В ответе сгенерирует XML сообщение следующего вида:

Либо в случае ошибки вызова или обработки запроса:

18. AUTOCALL GET SCHEME LIST API

Для получения списка доступных шаблонов надо вызвать скрипт http://www.votbox.ru/api/autocall.get.scheme.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
* – параметр является обязательным.

Верный ответ выглядит так:

В случае ошибки:

1. SMS SEND API

Для отправки одиночного SMS сообщения следует вызвать скрипт http://www.votbox.ru/api/sms.task.once.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
sender * Text Имя отправителя – строка латинских букв или цифр не более 11 символов
phone * Text Телефон в формате:
8<10-значный номер абонента> либо 7<10-значный номер абонента>,
например, 89111234567;
отправка СМС за переделы РФ не производится
smstext * Text Текст сообщения
starttime Text Дата отправки сообщения
например: 2011-05-05 17:30
endtime Text Дата, после которой сообщение теряет актуальность и, если оно еще не было отправлено абоненту, отправляться не будет (необязательный атрибут).
например: 2011-05-20 18:00
* – параметр является обязательным. Латинскими считаются символы с кодом до #127.

В ответе сгенерирует XML сообщение следущего вида:

1. В случае успешной постановки задачи:

Где

Имя поля Тип
id уникальный идентификатор задачи
phonenumber номер телефона, на который будет отправлено сообщение
jobstatus статус выполнения
0 – задача находится в процессе обработки

2. Если же в процессе постановки задачи (либо в полученных данных) была ошибка, то:

Для отправки множественной СМС рассылки следует вызвать скрипт http://www.votbox.ru/api/sms.task.api.php

И передать методом POST следующие параметры:

Имя поля Тип Описание
username* Text Имя пользователя в системе VotBox
password* Text MD5 хэш пароля пользователя в системе VotBox
sender* Text Имя отправителя – строка латинских букв или цифр не более 11 символов
smstext* Text Текст сообщения
starttime Text Дата отправки сообщения
например: 2011-05-05 17:30
endtime Text Дата, после которой сообщение теряет актуальность и, если оно еще не было отправлено абоненту, отправляться не будет (необязательный атрибут).
например: 2011-05-20 18:00
FLIST* File Файл с номерами для отправки
Формат файла CSV (Comma Separated Values)
вида:
88121112233
84952223344
84993334455
* – параметр является обязательным.

В ответе сгенерирует XML сообщение аналогичное случаю отправки одиночного СМС, с единственным отличем что в случае успеха количество элементов item в ответе будет соответствовать количеству поставленных задач.

Внимание! Существует возможность отправить персонифицированную рассылку для этого в тексте сообщения в нужных местах укажите подстановочные переменные в виде {%}. Например: «Здравствуйте, {%}! Ваша задолженность составляет {%}. Просим погасить задолженность до 15.10.10» Создайте файл с номерами получателей сообщений и значениями для подстановочных переменных. Файл должен соответствовать формату csv. Номера и значения переменных должны разделяться точкой с запятой.
Например:
89218887766; Иван Иванович; 352,60 руб
89115554433; Иван Петрович; 1034,00 руб

Для проверки статуса обработки задачи следует вызвать скрипт http://www.votbox.ru/api/sms.task.api.php

И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
taskid ** Text Уникальный идентификатор задачи, полученный при отправке
listid ** Text Уникальный идентификатор списка задач, полученный при отправке в свойстве listid элемента item
* – параметр является обязательным.
** – один из параметров должен быть передан.

В ответе сгенерирует XML сообщение следущего вида:

1. В случае успешной постановки задачи:

Где

Имя поля Значение
id уникальный идентификатор задачи
phonenumber номер телефона, на который будет отправлено сообщение
jobstatus статус выполнения
меньше нуля – задача находится в процессе обработки
0 – задача успешно выполнена
больше нуля – произошла ошибка:
10 – неверно указан отправитель
11 – неверно указан телефон
41 – телефон отключён
42 – телефон не принимает СМС
46 – таймаут при отправке
69 – телефон отключён
99 – 255 – неизвестная ошибка

Если был передан параметр listid, будет возвращен список задач

2. Если же в процессе постановки задачи (либо в полученных данных) была ошибка, то:

Программный интерфейс API для настройки переадресации

Для настройки переадресации виртуального номера надо вызвать скрипт http://www.votbox.ru/api/pbx.setphone.api.php
И передать методом POST следующие параметры:

Имя поля Тип Описание
username * Text Имя пользователя в системе VotBox
password * Text MD5 хэш пароля пользователя в системе VotBox
numberA * Text Ваш Виртуальный номер, так как он указан в личном кабинете, например 8123350515
numberB * Text Номер телефона, на который должна происходить переадресация,
в формате 8<код><номер телефона> или <810><код страны><код><номер телефона>
* – параметр является обязательным.

Верный ответ выглядит так:

В случае ошибки:

Остались вопросы? Звоните!

8 800 555-85-90

ЗВОНОК ПО РФ БЕСПЛАТНЫЙ

VotBox ©
2001-2016

8 800 555-85-90
8 812 335-05-15
8 495 785-21-01

Техподдержка 24/7

Звонки по всей России бесплатно




Система восстановления пароля

Войти ×

Войти в личный кабинет

Забыли пароль?
У меня еще нет логина и пароля ×

Регистрация

или Войти ×
×