Gsm шлюзы GOIP и SMS интерфейс

 Шаг

Описание

1.Register and
Keep

GOIP будет отправлять пакет keepalive на сервер каждые 30 с.
Format:
req:$count;id:$id;pass:$password;num:$gsm_num;signal:$gsm_signal
;gsm_status:$gsm_status;voip_status:$voip_status;imei:$imei;imsi:$i

alive

msi;iccid:$iccid;

Variable:
$count: counter for sending packets. Initialize to 1 when GOIP power up and increase by 1 after a packet is sent out.
$id: authentication id set in configuration page.
$password: authentication password set in configuration page.
$gsm_num: sim card number
$gsm_signal: sim signal
$gsm_status: LOGIN or LOGOUT
$voip_status: status of VoIP,   LOGIN or LOGOUT
$imei: IMEI of GSM Module
$imsi: IMSI of SIM Card
$iccid: ICCID of SIM Card

2.keep alive ack

SMS server will verify the authentication id and password of the keepalive packet received. And send keepalive ack if the id and password are matched with the authentication list.

Format:
reg:$count;status:$status; Variable:
$count: Integer, the same as Register and Keep alive packet of GoIP.
$status: Integer, 0 means ok..

Шаг

Описание

1. Запрос (BulkSMSRequest)

В начале SMS-сервер отправит массовый SMS-запрос в GOIP, включит в себя содержание и длину SMS в формате utf8. Содержание SMS должно быть ограничено 3000 байтами или менее.

Формат: MSG $sendid $length $msg\n Переменная:

$sendid: Integer, как идентификатор пакета сервера. Обратите внимание, что все сообщения, описанные ниже, должны использовать один и тот же "sendid", определенный здесь, если они принадлежат к одному и тому же массовому сеансу SMS.

$length: целое число в формате utf8, как длина содержимого SMS

$msg: SMS-контент в формате utf8

2. Подтверждение (BulkSMSConfirm BulkSMSReject)

GOIP выполнит инициализацию для массового SMS при получении массового SMS-запроса. Обратите внимание, что другие сообщения этого массового SMS должны быть получены в 90-х годах после получения массового SMS-запроса. Или GOIP остановит сеанс и выпустит.

(1) При успешной инициализации GOIP отправит на сервер подтверждение BulkRequest и запрос на аутентификацию

Формат: PASSWORD $sendid\n Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в BulkSMSRequest.

(2) Если инициализация не удалась, GOIP отправит на сервер BulkSMSReject, включив сообщение об ошибке.

Формат: ERROR $sendid $errormsg\n Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в BulkSMSRequest.

$errormsg: Строка, Сообщение об ошибке. Сейчас слишком много запросов на массовые SMS, полученные одновременно, является основной причиной сбоя. Обратите внимание, что GOIP поддерживает только 5 массовых SMS-сессий одновременно. Сервер должен остановить сеанс при получении

bulkSMSЗапрос Отклонить. Затем повторите попытку позже.

3.Проверка подлинности Запрос (AuthenticationRequest)

SMS-сервер должен отправить Запрос аутентификации с паролем в GOIP.

Формат: PASSWORD $sendid $password\n

Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в BulkSMSRequest.

$password: Регистрационный пароль GOIP

4.Аутентификация Подтверждение аутентификации. Выгрузка. (AuthenticationConfirm AuthenticationReject)

GOIP проверит пароль в AuthenticationRequest и вернет результат на сервер.

(1)  При успешной аутентификации GOIP отправит на сервер подтверждение аутентификации.

Формат: SEND $sendid\n Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в BulkSMSRequest.

(2)   Если аутентификация не удалась, GOIP отправит AuthenticationReject на сервер и дождается следующего запроса AuthenticationRequest или endRequest Format: ERROR $sendid PASSWORD\n

Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в BulkSMSRequest.

5.SubmitNumber Запрос (SubmitNumberRequest)

GOIP нужно около 2-5 секунд, чтобы отправить SMS. Таким образом, чтобы избежать потери пакетов, СЕРВЕР SMS может отправлять SubmitNumberRequest в GOIP, чтобы получить статус отправки назначенного номера каждые последовательные секунды до успешной отправки SMS. И, GOIP сохраняет только статус отправки последних 10 номеров в этой группе

Формат: SEND $sendid $telid $telnum\n Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в BulkSMSRequest.

$telid:                Integer,                              уникальный порядковый номер SubmitNumberRequest, определенный сервером.

$teinum: Строка, номер телефона

6. Отправить Нумер Статус (SubmitNumberStatus)

GOIP отправит SubmitNumberStatus на сервер при получении SubmitNumberRequest.

(1) При успешной отправке SMS на назначенный номер GOIP отправит на сервер SubmitNumberStatus с OK.

Формат: OK $sendid $telid\n Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в

BulkSMSЗапрос.

$telid: Целое число, уникальный порядковый номер в SubmitNumberRequest.

(2)  Если      отправка  не удалась,          GOIP отправит                 submitNumberStatus с ошибкой на сервер.             

Формат:              ERROR            $sendid              $telid errorstatus:$errorid\n

Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в BulkSMSRequest.

$telid: Целое число, уникальный порядковый номер в SubmitNumberRequest.

$errorid: Целое число, код ошибки. Обычно он равен 1.

(3)  Если telid в SubmitNumberRequest отсутствует в списке, в котором сохранен последний номер отправки 10, GOIP сохранит telid в списке ожидания и отправит SubmitNumberStatus с WAIT.

Формат: WAIT $sendid $telid\n Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в BulkSMSRequest.

$telid: Целое число, уникальный порядковый номер в

SubmitNumberRequest.

7.Отправить Нумер Запрос (SubmitNumberRequest)

Обратите внимание, что SMS-сервер должен отправить следующий SubmitNumberRequest в GOIP после получения SubmitNumberStatus с OK или ERROR

То же, что и 5

8. Отправить Номер Статус (SubmitNumberStatus)

То же, что и 6

9. End Reqeust

SMS-сервер может отправить EndRequest в GOIP, чтобы завершить массовый SMS-сеанс.

Формат: DONE $sendid\n Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в

BulkSMSЗапрос.

10.Конец (End)

GOIP выпустит ресурс массового СЕАНСА SMS при получении EndRequest. И возврат EndConfirm на сервер

Формат: DONE $sendid\n Переменная:

$sendid: Целое число, идентификатор сеанса массового SMS в

BulkSMSЗапрос.

OK Format: get_gsm_num $sendid $gsmnum Error Format: ERROR $sendid $errmsg Variable:
$sendid:the same as server packet;
$gsmnum:GSM number;
$errmsg: string of error message

Шаг

Описание

1.сервер отправить

Format:
set_gsm_num $sendid $gsmnum $password
Variable:
$sendid: integer, the id of server packet increase by 1;
$gsmnum:the gsm number which want to set
$password: The registration password of GOIP;

2.Возврат

OK Format: set_gsm_num $sendid $gsmnum ok Error Format: ERROR $sendid $gsmnum $errmsg Variable:
$sendid:the same as server packet;
$gsmnum: the gsm number which want to set;
$errmsg: string of error message;

Шаг

Описание

1.сервер отправить

Format:
get_exp_time $sendid $password
Variable:

$sendid: integer, the id of server packet increase by 1;
$password: The registration password of GOIP;

2.Возврат

OK Format: get_exp_time $sendid $exptime Error Format: ERROR $sendid $errmsg Variable:
$sendid:the same as server packet;
$exptime: expiry time of out call of a channel (minute);
$errmsg: string of error message;

Шаг

Описание

1.сервер отправить

Format:
set_exp_time $sendid $exptime $password
Variable:
$sendid: integer, the id of server packet increase by 1;
$exptime: expiry time (minute) witch want to set
$password: The registration password of GOIP;

2.Возврат

OK Format: set_exp_time $sendid $exptime ok Error Format: ERROR $sendid $exptime $errmsg Variable:
$sendid:the same as server packet;
$exptime: expiry time of out call of a channel (minute);
$errmsg: string of error message;

Шаг

Описание

1.сервер отправить

Format:
get_remain_time $sendid $password
Variable:
$sendid: integer, the id of server packet increase by 1;
$password: The registration password of GOIP;

2.Возврат

OK Format: get_remain_time $sendid $remaintime Error Format: ERROR $sendid $errmsg

Variable:
$sendid:the same as server packet;
$remaintime: remain time of out call(minute)
$errmsg: string of error message;

Шаг

Описание

1.сервер отправить

Формат:
reset_remain_time $ $password
Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;$password: Регистрационный пароль GOIP;

2.Возврат

OK Формат: reset_remain_time $sendid ok Формат ошибки: ERROR $sendid $errmsg Переменная:
$sendid:то же, что и пакет сервера;
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Формат:
get_gsm_state $$password 

Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;
$password: Регистрационный пароль GOIP;

2.Возврат

OK Формат: get_gsm_state $sendid $state Формат ошибки: ERROR $sendid $errmsg Переменная:
$sendid:то же, что и пакет сервера;
$state: состояние строки,строка (IDLE или ACTIVE)
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Формат:
svr_drop_call $ отправить $password 

Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;
$password: Регистрационный пароль GOIP;

2.Возврат

GoIP попытается отбросить текущий вызов. ФОРМАТ OK: svr_drop_call $sendid $ok Формат ошибки: ERROR $sendid $errmsg Переменная:
$sendid:то же, что и пакет сервера;
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Формат:
svr_reboot_module $ $password
Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;
$password: Регистрационный пароль GOIP;

2.Возврат

Goip попытается перезагрузить канал
OK Формат: svr_reboot_module $sendid $ok Формат ошибки: ERROR $sendid $errmsg Переменная:
$sendid:то же, что и пакет сервера;
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Формат:
svr_reboot_dev $ $password 

Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;
$password: Регистрационный пароль GOIP;

2.Возврат

Goip попытается перезагрузиться
OK Формат: svr_reboot_dev $sendid $ok Формат ошибки: ERROR $sendid $errmsg Переменная:
$sendid:то же, что и пакет сервера;
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Format:
CF $sendid $password $reason $mode $num $ftime
Variable:
$sendid: integer, the id of server packet increase by 1;
$password: The registration password of GOIP;
$reason: type of call forward. 0: unconditional，1: busy，2: noreply， 3: noreachable, 4: all，5:busy,noreply,noreachable；
$mode: enable or disable forward。3:enable，4:disable。
$num: forward to this number
$ftime: timeout (second) of noreply forward type. Other types set to 0.

2.Возврат

Goip will try to set call forward. OK Format: CFOK $sendid
Error Format: CFERROR $sendid

3. Возврат сервера

Format:
DONE $sendid

Шаг

Описание

1.GoIP Отправить
статус звонка

Format:
RECORD:$recvid;id:$goipid;password:$password;dir:$dir;num:$num

на сервер

Переменная:
$recvid: int, count с уменьшением текущей отметки времени;
$goipid: идентификатор аутентификации, заданный на странице конфигурации.
$password: пароль аутентификации, заданный на странице конфигурации.
$dir: int,означает направление вызова. 1:ВХОДЯЩИЕ,2:ИСХОДЯЩИЕ

2.Возврат сервера

ФОРМАТ OK: RECORD $recvid OK Формат ошибки: RECORD $recvid $errmsg Переменная:
$recvid: то же самое, что и goip send.
$errmsg: сообщение об ошибке, определенное вами

Шаг

Описание

1.Goip send remain tiem

Формат: REMAIN:$recvid;id:$goipid;password:$password;gsm_remain_time:$time Переменная:
$recvid: int, count с уменьшением текущей отметки времени;
$goipid: идентификатор аутентификации, заданный на странице конфигурации.
$password: пароль аутентификации, заданный на странице конфигурации.
$time:время сохранения канала выездного вызова, минут。

2.Сервер Ответ

ФорматOK: REMAIN $recvid OK Формат ошибки: REMAIN $recvid $errmsg Переменная:$recvid: то же самое, что и goip send.
$errmsg: сообщение об ошибке, определенное вами

Шаг

Описание

1.сервер отправить

Если сервер не может получить ответ клиента в течение 10 секунд, повторно отсыпьте

ussd команда

однократной команды.
Формат:

Общая USSD-команда:

USSD $отправить $password $ussdcmd

Команда «Выйти из USSD»:

USSDEXIT $отправить $password

Переменная:
$ sendid: int, количество посылающих пакетов увеличивается на 1;
$password: Регистрационный пароль GOIP;

$ussdcmd: USSD команда

2.Возврат

Goip получил команду, отправить команду провайдеру, затем арендовать ответ на сервер.
Формат: USSD $sendid $msg
Форматошибки:USSDERROR $sendid $errmsg USSD disconneted:USSDEXIT $sendid Переменная:
$sendid: то же, что и сервер send;
$msg: сообщение провайдера возвращает, код utf8
$errmsg: сообщение об ошибке

Шаг

Описание

1.сервер отправить

Формат:
get_imei $ отправить $password
Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;
$password: Регистрационный пароль GOIP;

2.Возврат

OK Формат: get_imei $sendid $imei Форматошибки: ERROR $sendid $errmsg Переменная:
$sendid:то же, что и пакет сервера;
$imei:Номер IMEI
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Формат:
set_imei $ Sendid $imei $password
Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;
$imei: IMEI номер,15 цифр.
$password: Регистрационный пароль GOIP;

2.Возврат

OK Формат: set_imei $sendid $imei ok Формат ошибки: ERROR $sendid $errmsg Переменная:
$sendid:то же, что и пакет сервера;
$imei:Номер IMEI
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Формат:
get_out_call_interval $ $password

Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;
$password: Регистрационный пароль GOIP;

2.Возврат

OK Формат: get_out_call_interval $sendid $interval Формат ошибки: ERROR $sendid $errmsg
Переменная:
$sendid:то же, что и пакет сервера;
$interval: интервал выездного вызова (секунда)
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Формат:
set_out_call_interval $ Отправить $interval $password
Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;
$interval: интервал выездного вызова (секунда)
$password: Регистрационный пароль GOIP;

2.Возврат

Формат OK: set_out_call_interval $sendid $interval OK Формат ошибки: ERROR $sendid $errmsg
Переменная:
sendid:то же, что и пакет сервера;
$interval: интервал выездного вызова (секунда)
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Формат:
module_ctl_i $с $value $password
Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;
$value: 1 для включения, 2 для отключения.
$password: Регистрационный пароль GOIP;

2.Возврат

Формат OK: module_ctl_i $sendid $ok Формат ошибки: ERROR $sendid $errmsg Переменная:
sendid:то же, что и пакет сервера;
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Format:
module_ctl $sendid $value $password
Variable:
$sendid: integer, the id of server packet increase by 1;
$value: 1 to enable, 0 to disable, 2 to not change, each digit for each channel. For example 10120121, means channel 1 enable, channel 2 disable, channel 3 enable, channel 4 not change, channel 5 disable, channel 6 enable, channel 7 not change and channel 8 enable.
$password: The registration password of GOIP;

2.Возврат

Формат OK: module_ctl $sendid $ok Формат ошибки: ERROR $sendid $errmsg Переменная:
sendid:то же, что и пакет сервера;
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.goip отправляет список ячеек на сервер, когда goip читает ячейки.

Формат: CELLS:$recvid;id:$id;пароль:$пароль;списки:$cell_list Переменная:
$recvid: int, count с уменьшением текущей отметки времени;
$id: идентификатор проверки подлинности, заданный на странице конфигурации.
$пароль:Регистрационный пароль GOIP;
$cell_list: строки списка ячеек, каждая ячейка как число разделено на ",‟, например      123,456,789,10,

2.Возврат сервера

Формат OK: ЯЧЕЙКИ $recvid OK\n
Формат ошибки: CELLS $recvid ERROR $errmsg
Переменная:
$recvid: то же самое, что и пакет goip;
$errmsg: строка сообщения об ошибке;

Шаг

Описание

1.сервер отправить

Формат:

команда на

goip    to    set cell

set_base_cell $Sendid $cell_id $password
Переменная:
$sendid: целое число, идентификатор пакета сервера увеличивается на 1;

$cell_id: идентификатор ячейки