Статус сообщения

Пример запроса для получение статуса сообщения.

URI: /api/json.php

Все запросы к API отправляются в формате JSON с помощью метода POST.

Параметры заголовков

В запросах обязательно должен быть заголовок Content-Type: application/json, иначе запрос будет считаться некорректным даже при валидном JSON в нем

Параметры запроса

authstringобязательный Ваш API-ключ, который можно получить в личном кабинете

datalist[object]обязательный Список объектов с параметрами запроса typestringобязательный Тип запроса idnumberобязательный Уникальный идентификатор сообщения в системе клиента

Пример запроса

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "status",
            "id": 100500
        }
    ]
}

Параметры ответа

successinteger Результат выполнения запроса

errorstring Текст ошибки, который возвращается, если success=false

datalist[object] Список объектов с результатами выполнения запроса successboolean Результат выполнения запроса, который вернулся в пакете данных dataobject Результат выполнения запроса idnumber Уникальный идентификатор сообщения в системе клиента typestring Тип сообщения: sms, viber, rcs statusstring Текущий статус сообщения (см. Справочник статусов сообщений)

Примеры ответа

Успешный

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": {
                "id":10500,
                "type": "viber",
                "status": "READ"
            }
        }
    ]
}

Доступ запрещен

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": false,
    "error": "Access denied"
}