Skip to content

Получение телефонных номеров занесенных в черный список

Метод get.blacklist_phone_numbers
Описание Получение телефонных номеров занесенных в черный список
Кому доступен Агент, Клиент

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"

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

Название Тип Фильтрация Сортировка Описание
id number да да Уникальный идентификатор номера телефона в черном списке
phone_number string да да Номер телефона
add_user_name string да да Имя пользователя, добавившего телефонный номер в черный список
add_comment string да да Комментарий, оставленный при добавлении номера телефона в черный список
add_date_time iso8601 да да Дата и время добавления номера телефона в черный список.YYYY-MM-DD hh:mm:ss

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.blacklist_phone_numbers",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

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

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "data": [
          {
              "id": "number",
              "phone_number": "string",
              "add_user_name": "string",
              "add_comment": "string",
              "add_date_time": "iso8601"
          }
        ],
        "metadata": "object"
    }
}

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

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