Переслать несколько полученных SMS сразу
POSThttps://{ourserver.com}/api/resellers/addMessages
Пересылает несколько SMS одним запросом. Каждое SMS обрабатывается как в addMessage, а ответ содержит результат по каждому. Мы рекомендуем этот метод вместо addMessage: собирайте SMS и отправляйте их пакетами, например раз в несколько секунд.
Ответ — HTTP 200, даже если ни одно SMS не принято: проверяйте response и results.
Параметры
header1
| Название | Тип | Описание |
|---|---|---|
Authorization* | string | Смотрите подробнее тут |
Тело запроса
Content-Type
application/jsonСхема
schemaobject
messagesobject[]ОбязательныйSMS, минимум одно. Также принимается JSON-строка с массивом.minItems: 1
teststring
Тестовый режим, только для запросов /api/resellers*. Его можно передать в строке запроса или в теле запроса.
test1— запрос выполняется, и ответ приходит как обычно, но изменения в базе данных откатываются. Действия вне базы данных все равно происходят: например, SMS, принятое addMessage, все равно доставляется клиенту, а значенияusedвсе равно сохраняются.test2— запрос не выполняется: ответ — отладочный дамп (HTML, HTTP 200) заголовков и тела запроса в том виде, в каком их получил наш сервер.
test не подтверждает, что Ваш сервер работает.Перечисление:test1test2Пример:test1Примеры
twoSms
Два SMS
{
"messages": [
{
"number": "33712345678",
"from": "Telegram",
"message": "Code: 12345"
},
{
"number": "33712345679",
"from": "WhatsApp",
"message": "Code: 56789"
}
]
}Ответы
200Результат по каждому SMS
Content-Type
application/jsonСхема
schemaobject
responsestringОбязательный
1, если принято хотя бы одно SMS, иначе 0Перечисление:01Пример:1totalintegerОбязательный
Количество SMS в запросеПример:2successintegerОбязательный
Количество принятых SMSПример:1failedintegerОбязательный
Количество непринятых SMSПример:1resultsobject[]ОбязательныйРезультат по каждому SMS, в порядке запроса
Примеры
partlyAcceptedСтрок: 21
Одно SMS принято, для другого нет подходящей операции
{
"response": "1",
"total": 2,
"success": 1,
"failed": 1,
"results": [
{
"index": 0,
"number": "33712345678",
"from": "Telegram",
"response": "1"
},
{
"index": 1,
"number": "33712345679",
"from": "WhatsApp",
"response": "0",
"error": "NO_OPERATION"
}
]
}400messages отсутствует, пуст или не является списком
Content-Type
application/jsonСхема
schemaobjectОтвет с ошибкой: response и message содержат один и тот же код ошибки.
responsestringОбязательный
Перечисление:ERROR_PARAMSmessagestringОбязательный
Пример:ERROR_PARAMS401API-ключ не передан или не существует. Тело ответа — простой текст Unauthorized.
Запрос с Accept: application/json вместо этого получает HTTP 200 с {"response":"ERROR_WRONG_KEY"}.
Content-Type
text/htmlСхема
schemastring
Перечисление:Unauthorized.Пример:Unauthorized.403Доступ запрещен: API-ключ действителен, но запрос отклонен. Коды ошибок:
ERROR_DISABLED — партнерский аккаунт не активирован;
ERROR_BANNED — партнерский аккаунт заблокирован;
ERROR_IP — запрос пришел с IP-адреса, которого нет в списке разрешенных для аккаунта;
ERROR_RENT — запрошен rent, но у аккаунта нет доступа к аренде (только addNumber).
ERROR_DISABLED — партнерский аккаунт не активирован;ERROR_BANNED — партнерский аккаунт заблокирован;ERROR_IP — запрос пришел с IP-адреса, которого нет в списке разрешенных для аккаунта;ERROR_RENT — запрошен rent, но у аккаунта нет доступа к аренде (только addNumber).Content-Type
application/jsonСхема
schemaobject
responsestringОбязательный
Код ошибкиПеречисление:ERROR_DISABLEDERROR_BANNEDERROR_IPERROR_RENTmessagestringОбязательный
Тот же код ошибкиПримеры
ERROR_IP
Запрос с IP-адреса вне списка разрешенных
{
"response": "ERROR_IP",
"message": "ERROR_IP"
}Примеры кода
Генерация примеров...