Skip to content

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

Метод create.phone_number_to_blacklist
Описание Добавление номера телефона в черный список и ее этапов
Кому доступен Агент, Клиент

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
phone_number string да Номер телефона
add_comment string нет Комментарий, оставленный при добавлении номера телефона в черный список

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

Название Тип Обязательный Описание
id number да Уникальный идентификатор номера телефона в черном списке
phone_number string да Номер телефона который был добавлен в черный список

JSON структура запроса

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "create.phone_number_to_blacklist",
    "params": {
        "access_token":"string",
        "user_id":"number",
        "phone_number": "string",
        "add_comment": "string"
    }
}

JSON структура ответа

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "data": {
            "id": "number",
            "phone_number": "string"
        },
        "metadata": "object"
    }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом create"