API/Модули

Основные функции API:

1. User.Registration

2. User.Confirmation

3. User.Login

4. Sms.Distribution

5. Sms.Distribution.Status

6. Sms.Signatures.Get

7. User.Balance.Get

 

1. Регистрация.

User.Registration принимает параметр phone в виде номаера телефона 89xxxxxxxxx и параметр full_name имя прользователя

 

http://gpsms.ru/api.php?command=User.Registration&phone=[&full_name=]

>>отправляет смс на <phone> с кодом активации XXXXXX

 

Ответ:

<Response>

<Success>1</Success>

<ErrorCode>0</ErrorCode>

</Response>

 

0 - ошибка отправки смс

1 - успешная отправка смс с кодом активации

2 - телефон уже зарегистрирован в системе


2. Подтверждение регистрации.

http://gpsms.ru/api.php?command=User.Confirmation&key=

<Response>

<Success>1</Success>

<ErrorCode>0</ErrorCode>

</Response>

 

0 - key не найден в системе

1 - успешная авторизация

>>отправляет смс на <phone> с кодом с приветствием, логином, паролем.

2 - key устарел

 

3. Логин.

http://gpsms.ru/api.php?command=User.Login&login=&password=

 

<Response>

            <Success>1</Success>

            <ErrorCode>

                        <Node0>0</Node0>

            </ErrorCode>

            <ErrorText/>

            <SessionID>xxxxxxxxxxxxxxxxxxx</SessionID>

</Response>

 

4. Отправка смс.

http://gpsms.ru/api.php?command=Sms.Distribution&phones=&message=&signature=

Запрос будет возвращать ИД рассылки.

Ответ:

<Response>

<Success>1</Success>

<ErrorCode>0</ErrorCode>

<Id>46</Id>

<ImportStatistic>

<dublicates>0</dublicates>

<bad_numbers>0</bad_numbers>

<good_for_sending>1</good_for_sending>

</ImportStatistic>

</Response>

 

5. Получение статусов.

http://gpsms.ru/api.php?command=Sms.Distribution.Status&id=

Ответ:

<Response>

<Success>1</Success>

<ErrorCode>0</ErrorCode>

<Statuses>

<Node0>

<Subnode1 value="Status">Sent</Subnode1>

<Subnode1 value="StatusMessage">Доставленно</Subnode1>

<Subnode1 value="PhoneNumber">79257405404</Subnode1>

<Subnode1 value="date">2014-03-25 02:50:47</Subnode1>

</Node0>

</Statuses>

</Response>

 

Статусы:

                        1  => "Доставленно",

                        2  => "Недоставленно",

                        4  => "В буфер",

                        8  => "Отправленно",

                        16 => "Oтвергнуто"

 

6. Получение списока подписей.

 

http://cp.gpsms.ru/api.php?command=Sms.Signatures.Get

 

Ответ:

<Response>

<Success>1</Success>

<ErrorCode>0</ErrorCode>

<Signatures>

<Node0>

<Subnode1 value="signature">gpsms.ru</Subnode1>

<Subnode1 value="status">confirmed</Subnode1>

</Node0>

</Signatures>

</Response>

 

7. Получать баланс по операторам.

http://cp.gpsms.ru/api.php?command=User.Balance.Get

Ответ:

<Response>

<Success>1</Success>

<ErrorCode>0</ErrorCode>

<Balance>

<Node0>

<Subnode1 value="package">Выборочный SMS</Subnode1>

<Subnode1 value="balance">4</Subnode1>

</Node0>

<Node1>

<Subnode1 value="package">Мегафон</Subnode1>

<Subnode1 value="balance">1</Subnode1>

</Node1>

<Node2>

<Subnode1 value="package">MTC</Subnode1>

<Subnode1 value="balance">1</Subnode1>

</Node2>

<Node3>

<Subnode1 value="package">Билайн</Subnode1>

<Subnode1 value="balance">1</Subnode1>

</Node3>

</Balance>

</Response>