access_token
- токен доступа, будет указан в письме для каждого сайта. Этот параметр должен передаваться в каждом запросе.list_id
- идентификатор списка, будет указан в письме для каждого сайта. Параметр используется в запросах работы со списками (базами) пользователей.
send_verification
- Отправка проверочного кода.verify_number
- Проверка номера по коду- Заполнение базы списка
- Отправка SMS
- Отправка пакета смс сообщений
- Проверка баланса
Урл запроса - https://global-sms.info/api/lists/:list_id/send_verification
HTTP Method - POST
Обязательные параметры запроса:
sender
- имя отправителя СМС сообщения (например, Rafinad)receiver
- мобильный номер получателя в формате 7XXXXXXXXXXaccess_token
- см Основные параметры Необязательные параметры запросаpromt
- текст сообщения, поумолчанию - «Код Активации: »translitirate
- траслитирация сообщения, поумолчаниюfalse
Все хорошо - HTTP STATUS CODE - 200 OK
{
"token":<значение проверочного кода, который был выслан в смс>,
"message_ids":<идинтифиакторы отосланных сообщений> ,
"parts":<количество отосланных смс частей>,
"charged":<стоимость>,
"balance":<баланс после рассылки>
}
Не достаточно средств - HTTP STATUS CODE - 422 Unprocessable Entity
{
"error": "no_money"
}
Номер уже в списке (базе) - HTTP STATUS CODE - 422 Unprocessable Entity
{
"error": "phone_already_in_list"
}
Урл запроса - https://global-sms.info/api/lists/:list_id/verify_number
HTTP Method - POST
Обязательные параметры запроса:
receiver
- мобильный номер для проверки в формате 7XXXXXXXXXXtoken
- код, полученный черезsend_verification
access_token
- см Основные параметры
Результат проверки - HTTP STATUS CODE - 200 OK
{
"verified":true|false
}
Урл запроса - https://global-sms.info/api/lists/:list_id/members
HTTP Method - POST
Обязательные параметры запроса:
access_token
- см Основные параметрыmember
- структура - см ниже
{
"member": {
"card_number":"Строка, номер карты",
"phone":"Строка, номер телефона, в формате 7xxxxxxxxxx. Обязательно>",
"email":"Строка, email",
"first_name":"Строка, Имя",
"last_name":"Строка, Фамилия",
"middle_name":"Строка, Отчество",
"birth_date_text":"Строка, гггг-мм-дд",
"gender":"Строка, ‘f’ или ‘m’",
"address":"Строка, Адрес",
"notes":"Строка, Заметки, например, добавлено через сайт"
}
}
HTTP STATUS CODE - 200 OK
{
<данные пользователя>
}
Ошибки - HTTP STATUS CODE - 422 Unprocessable Entity
{
errors:<ошибки>
}
Урл запроса - https://global-sms.info/api/sms
HTTP Method - POST
Обязательные параметры запроса
access_token
- см Основные параметрыsender
- имя отправителья (11 латинских символов)msg
- сообщениеreceivers
- получатели сообщения (сотовые номера через запятую в формате 7xxxxxxxxxx)
Урл запроса - https://global-sms.info/api/sms/batch
HTTP Method - POST
Обязательные параметры запроса
access_token
- см Основные параметрыsender
- имя отправителья (11 латинских символов)messages
- массив сообщений [{“msg”:”привет”, “to”:”7xxxxxxxxxx”}]
{
"access_token": "<>",
"sender": "test",
"messages":[
{
"msg":"Сообщение 1",
"to":"7xxxxxxxxx1"
},
{
"msg":"Сообщение 2",
"to":"7xxxxxxxxx2"
}
]
}
В теле запроса должен быть JSON
, заголовок Content-Type должен быть application/json; charset=utf-8
Урл запроса - https://global-sms.info/api/sms/batch
HTTP Method - POST
Обязательные параметры запроса
access_token
- см Основные параметрыsender
- имя отправителья (11 латинских символов)messages
- массив сообщений [{“msg”:”привет”, “to”:”7xxxxxxxxxx”}]
{
"access_token": "<>",
"sender": "test",
"messages":[
{
"msg":"Сообщение 1",
"to":"7xxxxxxxxx1",
"cmid": 1
},
{
"msg":"Сообщение 2",
"to":"7xxxxxxxxx2",
"cmid": 2
}
]
}
Урл запроса - https://global-sms.info/api/sms/cmid_states
HTTP Method - POST
Обязательные параметры запроса
access_token
- см Основные параметрыsender
- имя отправителья (11 латинских символов)cmids
- массив сообщений [1,2]
{
"access_token": "<>",
"sender": "test",
"cmids":[1,2]
}
{
"id": <gsms id>,
"cmid": <custom message id>,
"state":<current message state>
}
0
- ожидает отправки (в очереди)1
- обрабатывается2
- отправлено в шлюз10
- принято шлюзом11
- доставлено12
- недоставлено13
- отклонено
Статусы 11
,12
,13
- конечные, дальше проверять состояния для этих cmid не имеет смысла.
Урл запроса - https://global-sms.info//api/account
HTTP Method - GET
Обязательные параметры запроса
access_token
- см Основные параметры
{
"balance_cop": <целое число>,
}