Skip to content

Получение клиентов агента

Получение клиентов агента

Метод get.customers
Описание Получение клиентов агента
Кому доступен Партнёр

Архивные клиенты не отображаются в списке

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

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

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

Название Тип Допустимые значения Фильтрация Сортировка Описание
id number да Уникальный идентификатор клиента
name string да Название клиента
description string Описание к клиенту
creation_date_time iso8601 YYYY-MM-DD hh:mm:ss да Дата и время создания клиента
status enum
  • waiting
  • active
  • manual_lock
  • limit_lock
  • debt_lock
 да да Статус клиента
status_change_date_time iso8601 YYYY-MM-DD hh:mm:ss Дата и время изменения статуса
monthly_base_limit number Общий месячный лимит. Значение задаётся в деньгах.
monthly_base_notify_limit number Пороговое значение общего месячного лимита при достижению которого отправляется уведомление на электронный адрес указанный в параметре "monthly_base_notify_email"
monthly_base_notify_emails array Адреса электронной почты для получения уведомлений о достижении общего месячного лимита
monthly_calls_limit number Месячный лимит по звонкам. Значение задаётся в количестве звонков.
monthly_calls_notify_limit number Пороговое значение месячного лимита по звонкам при достижению которого отправляется уведомление на электронный адрес указанный в параметре "monthly_calls_notify_email"
monthly_calls_notify_emails array Адреса электронной почты для получения уведомлений о достижении месячного лимита по звонкам
daily_calls_limit number Дневной лимит по звонкам. Значение задаётся в количестве звонков.
daily_calls_notify_limit number Пороговое значение дневного лимита по звонкам при достижению которого отправляется уведомление на электронный адрес указанный в параметре "daily_calls_notify_email"
daily_calls_notify_emails array Адреса электронной почты для получения уведомлений о достижении дневного лимита по звонкам
Список сайтов клиента
sites array Список сайтов клиента
site_id number Уникальный индентификатор сайта
site_domain_name string Доменное имя сайта
Тарифный план
tariff_plan_id number да Уникальный идентификатор тарифного плана
tariff_plan_name string да Название тарифного плана

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

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

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

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "name":"string",
        "description":"string",
        "creation_date_time":"iso8601",
        "status":"enum",
        "status_change_date_time":"iso8601",
        "tariff_plan_id":"number",
        "tariff_plan_name":"string",
        "monthly_base_limit":"number",
        "monthly_base_notify_limit":"number",
        "monthly_base_notify_emails":[
          "item"
        ],
        "monthly_calls_limit":"number",
        "monthly_calls_notify_limit":"number",
        "monthly_calls_notify_emails":[
          "item"
        ],
        "daily_calls_limit":"number",
        "daily_calls_notify_limit":"number",
        "daily_calls_notify_emails":[
          "item"
        ],
        "sites":[
          {
            "site_domain_name":"string",
            "site_id":"number"
          }
        ]
      }
    ]
  }
}

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

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