Управление клиентами агентов

Если, вы не Агент, то вам методы недоступны.

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

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

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

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
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"

Создание клиента агента

Метод create.customers
Описание Создание клиента агента
Кому доступен Партнёр

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
name string да Название клиента
description string нет Описание к клиенту
tariff_plan_id number да Уникальный идентификатор тарифного плана. Список доступных тарифных планов можно получить с помощью метода "get.partner_tariffs"
email string да Адрес электронной почты клиента
password string да Минимальная длина 8 символов Пароль для клиента
monthly_base_limit number нет Общий месячный лимит. Значение задаётся в деньгах.
monthly_base_notify_limit number нет Пороговое значение общего месячного лимита при достижению которого отправляется уведомление на электронный адрес указанный в параметре "monthly_base_notify_email"
monthly_base_notify_emails array да Максимум 5 адресов Адреса электронной почты для получения уведомлений о достижении общего месячного лимита
monthly_calls_limit number нет Месячный лимит по звонкам. Значение задаётся в количестве звонков.
monthly_calls_notify_limit number нет Пороговое значение месячного лимита по звонкам при достижению которого отправляется уведомление на электронный адрес указанный в параметре "monthly_calls_notify_email"
monthly_calls_notify_emails array да Максимум 5 адресов Адреса электронной почты для получения уведомлений о достижении месячного лимита по звонкам
daily_calls_limit number нет Дневной лимит по звонкам. Значение задаётся в количестве звонков.
daily_calls_notify_limit number нет Пороговое значение дневного лимита по звонкам при достижению которого отправляется уведомление на электронный адрес указанный в параметре "daily_calls_notify_email"
daily_calls_notify_emails array да Максимум 5 адресов Адреса электронной почты для получения уведомлений о достижении дневного лимита по звонкам

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

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

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"create.customers",
  "params":{
    "access_token":"string",
    "name":"string",
    "description":"string",
    "tariff_plan_id":"number",
    "email":"string",
    "password":"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"
    ]
  }
}

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

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

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

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

Редактирование параметров клиента агента

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

Возможно частичное обновление. Если обновляется массив данных, то переданный массив будет полностью заменять существующий.

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор клиента
name string да Название клиента
description string нет Описание к клиенту
monthly_base_limit number нет Общий месячный лимит. Значение задаётся в деньгах.
monthly_base_notify_limit number нет Пороговое значение общего месячного лимита при достижению которого отправляется уведомление на электронный адрес указанный в параметре "monthly_base_notify_email"
monthly_base_notify_emails array да Максимум 5 адресов Адреса электронной почты для получения уведомлений о достижении общего месячного лимита
monthly_calls_limit number нет Месячный лимит по звонкам. Значение задаётся в количестве звонков.
monthly_calls_notify_limit number нет Пороговое значение месячного лимита по звонкам при достижению которого отправляется уведомление на электронный адрес указанный в параметре "monthly_calls_notify_email"
monthly_calls_notify_emails array да Максимум 5 адресов Адреса электронной почты для получения уведомлений о достижении месячного лимита по звонкам
daily_calls_limit number нет Дневной лимит по звонкам. Значение задаётся в количестве звонков.
daily_calls_notify_limit number нет Пороговое значение дневного лимита по звонкам при достижению которого отправляется уведомление на электронный адрес указанный в параметре "daily_calls_notify_email"
daily_calls_notify_emails array да Максимум 5 адресов Адреса электронной почты для получения уведомлений о достижении дневного лимита по звонкам

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"update.customers",
  "params":{
    "access_token":"string",
    "id":"number",
    "name":"string",
    "description":"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"
    ]
  }
}

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

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

  }
}

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

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

Изменение статуса клиента агента

Метод update.customer_status
Описание Изменение статуса клиента агента
Кому доступен Партнёр

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
customer_id number да Уникальный идентификатор клиента
status enum да active, archive, manual_lock Новый статус.

Активировать можно только клиента который находятся в статусе "waiting".

Заблокировать возможно только клиента который находится в статусе "active".

Архивировать можно только клиента который находится в статусе "manual_lock"

Разблокировать можно только клиента который находится в статусе "manual_lock"

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"update.customer_status",
  "params":{
    "access_token":"string",
    "customer_id":"number",
    "status":"enum"
  }
}

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

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

  }
}

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

Текст Код Мнемоника Описание
An attempt was made to use a status that is not correct in this state -32602 invalid_state Указанный статус некорректен для клиента в текущем состоянии

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

Смена тарифного плана у клиента агента

Метод update.customer_tariff_plans
Описание Смена тарифного плана у клиента агента
Кому доступен Партнёр

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
customer_id number да Уникальный идентификатор клиента
tariff_plan_id number да Уникальный идентификатор тарифного плана. Список доступных тарифных планов можно получить с помощью метода "get.tariff_plans"

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"update.customer_tariff_plans",
  "params":{
    "access_token":"string",
    "customer_id":"number",
    "tariff_plan_id":"number"
  }
}

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

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

  }
}

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

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

Получение доступных тарифных планов агента

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

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

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

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

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

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.tariff_plans",
  "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"
      }
    ]
  }
}

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

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

Получение списка пользователей клиента для API запросов

Метод get.customer_users
Описание Получение списка пользователей клиента из под которых можно совершать API запросы к клиентским API методам
Кому доступен Партнёр

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

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

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

Название Тип Фильтрация Сортировка Описание
id number да Уникальный идентификатор пользователя
Используется как user_id во всех клиентских методах
login string Логин пользователя
description string Описание пользователя
name string да да Имя пользователя
customer_id number да да Уникальный идентификатор клиента

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.customer_users",
  "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",
        "login":"string",
        "customer_id":"number"
      }
    ]
  }
}

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

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

Нам интересно ваше мнение о CoMagic.
Пожалуйста, оставьте контакты для связи с менеджером
ФИО*:
E-mail*:
Телефон*:
* - Обязательные для заполнения поля