Добавление номера в черный список

Метод blacklist-create предназначен для добавления номеров в черный список.

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

Параметр	Тип	Обязательный	Описание
category	string	Да	Категория черного списка. Допустимые значения: sms_promo sms_service viber *
phone	string	Да	Номер телефона в международном формате
comment	string	Нет	Комментарий

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

{
    "api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
    "action": "blacklist-create",
    "data": {
        "category": "sms_promo",
        "phone": "+79401234567",
        "comment": "Клиент отказался от получения рекламных сообщений"
    }
}

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

Параметр	Тип	Описание
id	string	Идентификатор записи
created	datetime	Дата и время создания в формате ISO 8601
updated	datetime	Дата и время обновления в формате ISO 8601
category	string	Категория
phone	integer	Номер телефона
comment	integer	Комментарий. Параметр передается только если был указан при добавлении записи

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

{
    "success": true,
    "data": {
        "id": "5d59b4c6-19b6-47b4-ba19-0a25ab599f80",
        "created": "2024-01-31T15:10:04+03:00",
        "updated": "2024-01-31T15:10:04+03:00",
        "category": "sms_promo",
        "phone": "+79401234567",
        "comment": "Клиент отказался от получения рекламных сообщений"
    }
}

Возможные ошибки

Ошибка	Описание
BLACKLIST-CREATE-CATEGORY-REQUIRED	Не указан параметр category
BLACKLIST-CREATE-CATEGORY-INVALID-TYPE	Параметр category имеет недопустимый тип
BLACKLIST-CREATE-CATEGORY-NOT-SUPPORTED	Параметр category имеет недопустимое значение
BLACKLIST-CREATE-PHONE-REQUIRED	Не указан параметр phone
BLACKLIST-CREATE-PHONE-INVALID-TYPE	Параметр phone имеет недопустимый тип
BLACKLIST-CREATE-PHONE-INVALID-FORMAT	Параметр phone не соответствует формату
BLACKLIST-CREATE-PHONE-DUPLICATE	Номер телефона уже существует в данной категории
BLACKLIST-CREATE-COMMENT-INVALID-TYPE	Параметр comment имеет недопустимый тип
BLACKLIST-CREATE-COMMENT-INVALID-FORMAT	Параметр comment не соответствует формату