Получение списка подписей по их типу (by-apikey)

Метод, описанный в этой статье, предназначен только для SME.

Данный метод позволяет получить все подписи, которые были созданы в личном кабинете edna.

URL-адрес подключения

Для отправки сообщения выполняется POST-запрос на URL-адрес: https://im.edna.ru/api/im-subject/by-apikey

Формат запроса

В теле запроса передается тип подписи. Тип подписи, который может быть передан в запросе: WHATSAPP, VIBER.

{
    "imType": "WHATSAPP",
}

Формат ответа

В ответ на запрос возвращается JSON-объект, содержащий информацию по статусу подписи.

[
    {
        "id": 112,
        "subject": "SUBJECT_WA",
        "clientComment": null,
        "createdAt": null,
        "updatedAt": null,
        "status": "ACTIVE",
        "statusComment": null,
        "phone": "79000000000",
        "test": false,
        "imType": "WHATSAPP"
    }
]

Если в личном кабинете существует несколько подписей, будет возвращен массив данных с полной информацией о них.

[
    {
        "id": 112,
        "subject": "SUBJECT_WA",
        "clientComment": null,
        "createdAt": null,
        "updatedAt": null,
        "status": "ACTIVE",
        "statusComment": null,
        "phone": "79000000000",
        "test": false,
        "imType": "WHATSAPP"
    },
    {
        "id": 113,
        "subject": "SUBJECT2_WA",
        "clientComment": null,
        "createdAt": null,
        "updatedAt": null,
        "status": "BLOCKED",
        "statusComment": null,
        "phone": "79000000001",
        "test": false,
        "imType": "WHATSAPP"
    }
]

Если у клиента нет подписи запрашиваемого типа, в ответе будет передан пустой массив.

[ ]

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