Описание API

(4 [e-mail] www.tel-media.ru

Описание API

1. ПЕРЕДАЧА ОДНОГО SMS СООБЩЕНИЯ

2. ПЕРЕДАЧА МНОЖЕСТВА SMS СООБЩЕНИЙ

3. ПРОВЕРКА СОСТОЯНИЯ СЧЕТА

4. ЗАПРОС НА ПОЛУЧЕНИЕ СПИСКА БАЗ

5. ЗАПРОС НА ПОЛУЧЕНИЕ СПИСКА АБОНЕНТОВ УКАЗАННОЙ БАЗЫ

6. ЗАПРОС НА ДОБАВЛЕНИЕ ИЛИ РЕДАКТИРОВАНИЕ АБОНЕНТОВ БАЗЫ

7. ЗАПРОСЫ ДЛЯ РАБОТЫ СО СТОП-ЛИСТОМ АБОНЕНТОВ

8. ЗАПРОС НА ПОЛУЧЕНИЯ СТАТУСА СООБЩЕНИЯ/СООБЩЕНИЙ

1. ПЕРЕДАЧА ОДНОГО SMS СООБЩЕНИЯ

GET или POST запрос на сервер, вида:

https://*****/api. php? user=test&pass=test&from=test&text=text&to=

Вы можете сделать тестовую отправку запроса через браузер.

Кириллицу следует передавать в формате ‘url encoded’, например:

UTF-8: тест

url encoded: %D1%82%D0%B5%D1%81%D1%82

Параметр	Статус	Описание
user	Обязательно	Логин в системе
pass	Обязательно	Пароль
to	Обязательно	Номер телефона получателя, в формате
text	Обязательно	Текст сообщения, в UTF-8 кодировке
from	Обязательно	Подпись отправителя (латиница до 11 или цифры до 14 символов)
date	Не обязательно	Дата для отложенной отправки сообщения, Unix time (количество секунд с 1 января 1970 года) Если не указано, отправляется сразу после запроса

При успешной отправке, в ответ сервис должен вернуть text/xml ответ вида: <response> <status>accepted</status> <sms id_sms="">send</sms> </response>

При ошибке: <response> <status>error</status> <message>текст ошибки</message> </response>

Расшифровка ошибок:

Параметр	Описание
accepted	Сообщение принято сервисом
empty field. reject	Не все обязательные поля заполнены
incorrect user or password. reject	Ошибка авторизации
no credits	Недостаточно sms на балансе
incorrect destination adress. reject	Неверно задан номер телефона (формат )
incorrect date. reject	Неправильный формат даты (только unix time)
incorrect sender name. reject	Неверная (неразрешенная) подпись отправителя

2. ПЕРЕДАЧА МНОЖЕСТВА SMS СООБЩЕНИЙ

Если номеров несколько – они должны быть перечислены через запятую, без пробелов.

https://*****/api. php? user=test&pass=test&from=test&text=text&to=,

Рекомендуем не делать отправку более 80 сообщений за один запрос.

Это оптимальное значение.

3. ПРОВЕРКА СОСТОЯНИЯ СЧЕТА

GET или POST запрос на сервер, вида:

https://*****/api. php? a=balance&user=test&pass=test

Параметр	Статус	Описание
user	Обязательно	Логин в системе
pass	Обязательно	Пароль

При успешной авторизации, в ответ сервис должен вернуть text/xml ответ вида:

<response>

<balance>38</balance>

</response>

где цифра – это количество SMS, доступных на балансе.

4. ЗАПРОС НА ПОЛУЧЕНИЕ СПИСКА БАЗ

GET или POST запрос на сервер, вида:

https://*****/api. php? a=bases&user=test&pass=test

5. ЗАПРОС НА ПОЛУЧЕНИЕ СПИСКА АБОНЕНТОВ УКАЗАННОЙ БАЗЫ

GET или POST запрос на сервер, вида:

https://*****/api. php? a=list_phones&user=test&pass=test&baseid=74275&pageid=1

Параметр	Статус	Описание
user	Обязательно	Логин в системе
pass	Обязательно	Пароль
baseid	Обязательно	ID базы. Посмотреть можно в личном кабинете или через API, запросив список баз.
pageid	Обязательно	Номер страницы

Весь список номеров базы делится на страницы. Запросить целиком базу нельзя, во избежание перегрузки системы запросом, т. к. базы могут быть достаточно большие, сотни тысяч записей. Можно лишь запросить отдельную страницу.

Нумерация начинается с «1».

6. ЗАПРОС НА ДОБАВЛЕНИЕ ИЛИ РЕДАКТИРОВАНИЕ АБОНЕНТОВ БАЗЫ

https://*****/api. php? a=phones&user=test&pass=test&baseid=999&phone=

Параметр	Статус	Описание
user	Обязательно	Логин в системе
pass	Обязательно	Пароль
baseid	Обязательно	Номер базы в системе.
phone	Обязательно	Номер телефона абонента. Если абонент с таким номером уже существует, то он будет отредактирован.
region	Не обязательно	Регион. Если не задано, определяется автоматически.
operator	Не обязательно	Оператор. Если не задано, определяется автоматически.
name	Не обязательно	Имя абонента
surname	Не обязательно	Фамилия абонента
patronymic	Не обязательно	Отчество абонента
date_birth	Не обязательно	Дата рождения
male	Не обязательно	Пол. «m» - мужской, «f» - женский.
addition_1	Не обязательно	Первое дополнительное поле.
addition_2	Не обязательно	Второе дополнительное поле.

7. ЗАПРОСЫ ДЛЯ РАБОТЫ СО СТОП-ЛИСТОМ АБОНЕНТОВ

На номера, добавленные в стоп-лист, не будет происходить рассылка, даже если сервер получает запрос на отправку sms на этот номер.

7.1. Добавить в стоп-лист:

https://*****/api. php? a=addstop&user=test&pass=test&phones=

или номера через запятую

7.2. Удалить из стоп-листа

https://*****/api. php? a=delstop&user=test&pass=test&phones=

или номера через запятую

8. ЗАПРОС НА ПОЛУЧЕНИЯ СТАТУСА СООБЩЕНИЯ/СООБЩЕНИЙ

Вы можете узнать статус отправки одного сообщения следующим запросом:

https://*****/api. php? checkid=&user=test&pass=test

Если Вы хотите узнать несколько статусов, перечислите ID сообщений через запятую:

https://*****/api. php? checkid=,&user=test&pass=test

В случае успешной доставки, Вы получите ответ:

sms id_sms="" err="000" deliver sms

err="000" означает отсутствие ошибок.

Ниже приводим список возможных статусов и ошибок:

Параметр	Описание
send	статус сообщения еще не получен от оператора абонента
not_deliver	сообщение не было доставлено. Конечный статус (не меняется со временем)
expired	абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный статус (не меняется со временем)
deliver	сообщение доставлено. Конечный статус (не меняется со временем)
partly_deliver	сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки

Если статус сообщения “not_deliver”, то параметр “err” имеет значение отличное от “000″.

Система может отдавать следующие коды ошибок получения сообщения абонентом:

№	Description	Описание
0	No errors	Ошибок нет (или ошибка не может быть определена системой)
1	The subscriber is absent or out of a coverage	Абонент недоступен или отключен
2	Call barred service activated	У абонента включен запрет на прием сообщений или абонента заблокировал оператор (возможно, в связи с отрицательным балансом)
3	Unknown subscriber	Номер телефона не существует или не обслуживается
4	Memory capacity exceeded	Память телефона абонента переполнена
5	Equipment protocol error	Аппаратная ошибка телефона абонента
6	Teleservice not provisioned	Сервис коротких сообщений не предоставляется
7	Facility not supported	Аппарат абонента не поддерживает прием коротких сообщений
8	Subscriber is busy	Аппарат абонента занят операцией, препятствующей получению короткого сообщения
9	Roaming restrictions	Абонент находится в роуминге
10	Timeout	Время ожидания ответа от SMSC абонента истекло
11	SS7 routing error	Внутренняя ошибка маршрутизации
12	Internal system failure	Внутренняя ошибка системы абонента
13	SMSC failure	коммутатора (внутренняя ошибка передачи данных оператора)

По всем вопросам пишите на *****@***ru