Управление сотрудниками

Получение списка сотрудников

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

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

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

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

Название Тип Допустимые значения Фильтрация Сортировка Описание
id number да Уникальный идентификатор сотрудника
first_name string да да Имя сотрудника
last_name string да да Фамилия сотрудника
patronymic string да Отчество сотрудника
full_name string да да Фамилия Имя Отчество
email string да Адрес электронной почты сотрудника
call_recording enum
  • all - для всех звонков;
  • in - только для входящих;
  • out - только для исходящих;
  • off - отключена
да Статус записи разговоров
calls_available boolean true, false да да Доступность для звонков
schedule_id number да Уникальный идентификатор графика активности
schedule_name string да Название графика активности
Тренер
coach object да Тренер для сотрудника
coach_full_name string Ф.И.О тренера
coach_id number Уникальный идентификатор тренера
Выбирается из списка сотрудников
coach_always_enabled boolean true, false При активации опции все входящие звонки сотрудника будут дублироваться его тренеру.
Группы сотрудника
groups array да Группы вкоторых состоит сотрудник
group_id number Уникальный идентификатор группы
group_name string Название группы
Телефоны
phone_numbers array 10 штук да Список телефонов сотрудника.
Список номеров должен быть отсортирован по приоритету.
phone_number string Номер телефона сотрудника. Формат номера может быть с донабором, к примеру "74955140578...2345", поэтому у номера не формат E164
Если указан SIP, то не делаем связки, а просто добавляем как номер типа ТФОП, т.е. как обычный номер
channels_count number От 1 до 150 Значение по умолчанию "1". Количество линий на телефоне
dial_time number От 1 до 100 Значение по умолчанию "60". Время дозвона по телефону. Значение в секундах.
status enum active, inactive Значение по умолчанию "active". Статус номера.
Внутренний номер
extension object да Внутренний номер и его настройки
extension_phone_number string Максимальная длина 4 Внутренний номер
extension_voice_mail_enabled boolean В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящему абоненту будет предложено оставить голосовое сообщение.
extension_queue_enabled boolean В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер.
Сотрудник является оператором чата
operator object Оператор рабочего места
operator_login string Логин оператора для входа в приложение «Рабочее место оператора»
operator_position_id number Уникальный идентификатор должности оператора в подписи
operator_position_name string Название должности оператора в подписи
operator_offline_message_enabled boolean Разрешено ли обрабатывать заявки
operator_invite_to_chat_enabled boolean Разрешено ли приглашать в чат
operator_chat_enabled boolean Разрешено ли участвовать в чатах с посетителями
operator_chats_available boolean true, false Доступность для чатов
Сайт
operator_sites array Список уникальных идентификаторов и адресов сайтов для которых доступен оператор
site_id number Уникальный идентификатор сайта
site_domain_name string Адрес сайта в интернете. Без указания протокола - "http://" или "https://".

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.employees",
  "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":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "first_name":"string",
        "last_name":"string",
        "patronymic":"string",
        "full_name":"string",
        "email":"string",
        "groups":[
          {
            "group_id":"number",
            "group_name":"string"
          }
        ],
        "call_recording":"enum",
        "calls_available":"boolean",
        "schedule_id":"number",
        "schedule_name":"string",
        "coach":{
          "coach_id":"number",
          "coach_full_name":"string",
          "coach_always_enabled":"boolean"
        },
        "phone_numbers":[
          {
            "phone_number":"string",
            "channels_count":"number",
            "dial_time":"number",
            "status":"enum"
          }
        ],
        "extension":{
          "extension_phone_number":"string",
          "extension_voice_mail_enabled":"boolean",
          "extension_queue_enabled":"boolean"
        },
        "operator":{
          "operator_login":"string",
          "operator_position_id":"number",
          "operator_position_name":"string",
          "operator_offline_message_enabled":"boolean",
          "operator_invite_to_chat_enabled":"boolean",
          "operator_chat_enabled":"boolean",
          "operator_chats_available":"boolean",
          "operator_sites":[
            {
              "site_id":"number",
              "site_domain_name":"string"
            }
          ]
        }
      }
    ]
  }
}

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

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

Создание сотрудника

Метод create.employees
Описание Создание сотрудника
Кому доступен Агент, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
first_name string нет Имя сотрудника
last_name string да Фамилия сотрудника
patronymic string нет Отчество сотрудника
email string нет Адрес электронной почты сотрудника
call_recording enum нет
  • all - для всех звонков;
  • in - только для входящих;
  • out - только для исходящих;
  • off - отключена
Значение по умолчанию "all". Статус записи разговоров
Зависит от компонента "recording"
schedule_id number нет График активности
calls_available boolean нет true, false Значение по умолчанию "true". Доступность для звонков
Тренер
coach object нет Тренер для сотрудника
Зависит от компонента "trainer"
coach_always_enabled boolean нет true, false По умолчанию "false". При активации опции все входящие звонки сотрудника будут дублироваться его тренеру.
Значение "true" возможно установить если задан параметр "coach_id".
coach_id number да Уникальный идентификатор тренера
Группы в которых состоит сотрудник
groups array нет Список уникальных идентификаторов групп в которых состоит сотрудник.
Телефоны
phone_numbers array да 10 штук Список телефонов сотрудника
Важно понимать, что при создании нового сотрудника номер уже может существовать у другого сотрудника и если номеру переданы новые параметры, то они будут так же обновлены уже существующему номеру
phone_number number да Номер телефона сотрудника. Формат номера может быть с донабором, к примеру "74955140578...2345", поэтому у номера не формат E164
Если указан SIP, то не делаем связки, а просто добавляем как номер типа ТФОП, т.е. как обычный номер
channels_count number нет От 1 до 150 Значение по умолчанию "1". Количество линий на телефоне.
dial_time number нет От 1 до 100 Значение по умолчанию "60". Время дозвона по телефону. Значение в секундах.
status enum нет active, inactive Значение по умолчанию "active". Статус номера.
Внутренний номер
extension object нет Внутренний номер сотрудника
extension_phone_number number да Максимальная длина 4 Внутренний номер
extension_voice_mail_enabled boolean нет true, false Значение по умолчанию "false".
В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящему абоненту будет предложено оставить голосовое сообщение.
extension_queue_enabled boolean нет true, false Значение по умолчанию "false".
В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер.
Является ли сотрудник чатом
operator object нет Оператор рабочего места
Зависит от компонента "consultant"
operator_login string да Логин сотрудника для входа в приложение «Рабочее место оператора»
operator_password string да Минимальная длина 8 Пароль сотрудника для входа в приложение «Рабочее место оператора»
operator_position_id number нет Должность сотрудника в подписи
operator_offline_message_enabled boolean нет true, false Значение по умолчанию "false". Разрешено ли обрабатывать заявки
operator_invite_to_chat_enabled boolean нет true, false Значение по умолчанию "false". Разрешено ли приглашать в чат
operator_chat_enabled boolean нет true, false Значение по умолчанию "true". Разрешено ли участвовать в чатах с посетителями
operator_sites array нет Список уникальных идентификаторов сайтов для которых доступен сотрудник.

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

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

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"create.employees",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "first_name":"string",
    "last_name":"string",
    "patronymic":"string",
    "email":"string",
    "groups":[
      "group_id"
    ],
    "call_recording":"enum",
    "calls_available":"boolean",
    "schedule_id":"number",
    "coach":{
      "coach_always_enabled":"boolean",
      "coach_id":"number"
    },
    "phone_numbers":[
      {
        "phone_number":"number",
        "channels_count":"number",
        "dial_time":"number",
        "status":"enum"
      }
    ],
    "extension":{
      "extension_phone_number":"number",
      "extension_voice_mail_enabled":"boolean",
      "extension_queue_enabled":"boolean"
    },
    "operator":{
      "operator_login":"string",
      "operator_password":"string",
      "operator_position_id":"number",
      "operator_offline_message_enabled":"boolean",
      "operator_invite_to_chat_enabled":"boolean",
      "operator_chat_enabled":"boolean",
      "operator_sites":[
        "site_id"
      ]
    }
  }
}

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

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

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

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

Удаление сотрудника

Метод delete.employees
Описание Удаление сотрудника
Кому доступен Агент, Клиента

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор сотрудника
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"delete.employees",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number"
  }
}

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

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

  }
}

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

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

Редактирование сотрудника

Метод update.employees
Описание Создание сотрудника
Кому доступен Агент, Клиент

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

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор сотрудника
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
first_name string нет Имя сотрудника
last_name string да Фамилия сотрудника
patronymic string нет Отчество сотрудника
email string нет Адрес электронной почты сотрудника
call_recording enum нет
  • all - для всех звонков;
  • in - только для входящих;
  • out - только для исходящих;
  • off - отключена
Статус записи разговоров
Зависит от компонента "recording"
schedule_id number нет График активности
calls_available boolean нет true, false Доступность для звонков
Тренер
coach object нет Тренер для сотрудника
Зависит от компонента "trainer"
coach_always_enabled boolean нет true, false При активации опции все входящие звонки сотрудника будут дублироваться его тренеру.
Значение "true" возможно установить если задан параметр "coach_id".
coach_id number нет Уникальный идентификатор тренера
Группы в которых состоит сотрудник
groups array нет Список уникальных идентификаторов групп в которых состоит сотрудник
Телефоны
phone_numbers array да 10 штук Список телефонов сотрудника
Важно понимать, что при создании нового сотрудника номер уже может существовать у другого сотрудника и если номеру переданы новые параметры, то они будут так же обновлены уже существующему номеру
phone_number number да Номер телефона сотрудника
channels_count number нет От 1 до 150 Количество линий на телефоне
dial_time number нет От 1 до 100 Время дозвона по телефону
status enum нет active, inactive Статус номера.
Внутренний номер
extension object нет Внутренний номер сотрудника
extension_phone_number number да Максимальная длина 4 Внутренний номер
extension_voice_mail_enabled boolean да true, false В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящему абоненту будет предложено оставить голосовое сообщение.
extension_queue_enabled boolean да true, false В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер.
Является ли сотрудник чатом
operator object нет Оператор рабочего места
Зависит от компонента "consultant"
operator_login string да Логин сотрудника для входа в приложение «Рабочее место оператора»
operator_password string да Минимальная длина 8 Пароль сотрудника для входа в приложение «Рабочее место оператора»
operator_position_id number нет Должность сотрудника в подписи
operator_offline_message_enabled boolean нет true, false Разрешено ли обрабатывать заявки
operator_invite_to_chat_enabled boolean нет true, false Разрешено ли приглашать в чат
operator_chat_enabled boolean нет true, false Разрешено ли участвовать в чатах с посетителями
operator_sites array нет Список уникальных идентификаторов сайтов для которых доступен сотрудник.

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"update.employees",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "first_name":"string",
    "last_name":"string",
    "patronymic":"string",
    "email":"string",
    "groups":[
      "group_id"
    ],
    "call_recording":"enum",
    "calls_available":"boolean",
    "schedule_id":"number",
    "coach":{
      "coach_always_enabled":"boolean",
      "coach_id":"number"
    },
    "phone_numbers":[
      {
        "phone_number":"number",
        "channels_count":"number",
        "dial_time":"number",
        "status":"enum"
      }
    ],
    "extension":{
      "extension_phone_number":"number",
      "extension_voice_mail_enabled":"boolean",
      "extension_queue_enabled":"boolean"
    },
    "operator":{
      "operator_login":"string",
      "operator_password":"string",
      "operator_position_id":"number",
      "operator_offline_message_enabled":"boolean",
      "operator_invite_to_chat_enabled":"boolean",
      "operator_chat_enabled":"boolean",
      "operator_sites":[
        "site_id"
      ]
    }
  }
}

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

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

  }
}

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

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

Создание группы сотрудников

Метод create.group_employees
Описание Создание группы сотрудников
Кому доступен Агент, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
name string да Название группы
Список сотрудников в группе
members array нет Список уникальных идентификаторов сотрудников, которые состоят в группе
Настройка внутреннего номера группы
group_phone_number number нет Максимальная длина 4 Внутренний номер группы
Зависит от компонента "va"
queue_enabled boolean нет Значение по умолчанию "false". В случае, если все номера, указанные для этой группы сотрудников, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер.
Зависит от компонента "va"
channels_count number нет От 1 до 199 Значение по умолчанию 1.
Количество одновременных линий при обзвоне
Зависит от компонента "va"

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

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

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"create.group_employees",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "name":"string",
    "members":[
      "employee_id"
    ],
    "group_phone_number":"number",
    "queue_enabled":"boolean",
    "channels_count":"number"
  }
}

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

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

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

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

Удаление группы сотрудников

Метод delete.group_employees
Описание Удаление группы сотрудников
Кому доступен Агент, Клиент

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор группы
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"delete.group_employees",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number"
  }
}

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

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

  }
}

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

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

Редактирование группы сотрудников

Метод update.group_employees
Описание Удаление группы сотрудников
Кому доступен Агент, Клиент

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

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор группы
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
name string да Название группы
Список сотрудников в группе
members array нет Список уникальных идентификаторов сотрудников, которые состоят в группе
Настройки внутреннего номера группы
group_phone_number number нет Максимальная длина 4 Внутренний номер группы
Зависит от компонента "va"
queue_enabled boolean нет Значение по умолчанию "false". В случае, если все номера, указанные для этой группы сотрудников, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер.
Зависит от компонента "va"
channels_count number да От 1 до 199 Количество одновременных линий при обзвоне
Зависит от компонента "va"

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"update.group_employees",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number",
    "name":"string",
    "members":[
      "employe_id"
    ],
    "group_phone_number":"number",
    "queue_enabled":"boolean",
    "channels_count":"number"
  }
}

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

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

  }
}

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

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

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

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

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

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

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

Название Тип Допустимые значения Фильтрация Сортировка Описание
id number да Уникальный идентификатор группы
name string да да Название группы
Список сотрудников в группе
members array Список уникальных идентификаторов сотрудников, которые состоят в группе
employee_id number Уникальный идентификатор сотрудника
employee_full_name string Ф.И.О. сотрудника
Список номеров сотрудников в группе и их доступность
phone_numbers array да Список городских, мобильных и sip номеров сотрудников, которые входят в группу, с указанием их доступности и приоритетом обзвона. Приоритет обзвона номеров определяется положением номера в списке. Обзвон указанного списка номеров в группе возможен по внутреннему номеру группы (см. параметр "group_phone_number"). Для изменения приоритета и доступности номера в группе см. метод "update.group_employees_numbers"
employee_phone_number number Номер телефона сотрудника
employee_phone_number_id number Уникальный идентификатор номера сотрудника в группе
employee_full_name string Ф.И.О. сотрудника
employee_id number Уникальный идентификатор сотрудника
available boolean Доступность номера в группе
Настройка внутреннего номмера группы
group_phone_number number Максимальная длина 4 да да Внутренний номер группы
queue_enabled boolean да Значение по умолчанию "false". В случае, если все номера, указанные для этой группы сотрудников, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер.
channels_count number От 1 до 199 да Количество одновременных линий при обзвоне

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.group_employees",
  "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":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "name":"string",
        "members":[
          {
            "employee_id":"number",
            "employee_full_name":"string"
          }
        ],
        "phone_number":[
          {
            "employee_phone_number":"number",
            "employee_phone_number_id":"number",
            "employee_full_name":"string",
            "employee_id":"number",
            "available":"boolean"
          }
        ],
        "group_phone_number":"number",
        "queue_enabled":"boolean",
        "channels_count":"number"
      }
    ]
  }
}

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

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

Изменение приоритета и доступности номера сотрудника в группе сотрудников

Метод update.group_employees_numbers
Описание Изменение приоритета и доступности номера сотрудника в группе сотрудников
Кому доступен Агент, Клиент

Если номер не передан в списке номеров, то и данные по номеру не обновляются.

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор группы
user_id number да Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Список номеров сотрудников в группе и их доступность
phone_numbers array да Список городских, мобильных и sip номеров сотрудников, которые входят в группу, с указанием их доступности и приоритетом обзвона. Приоритет обзвона номеров определяется положением номера в списке. Обзвон указанного списка номеров в группе возможен по внутреннему номеру группы (см. параметр "group_phone_number").
Нужно передавать все номера
employee_phone_number_id number да Уникальный идентификатор номера сотрудника в группе
available boolean да Доступность номера в группе

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"update.group_employees_numbers",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number",
    "phone_numbers":[
      {
        "employe_phone_number_id":"number",
        "available":"boolean"
      }
    ]
  }
}

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

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

  }
}

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

Текст ошибки Мнемоника Код Описание
Invalid parameter value invalid_parameter_value -32602 Если переданы не все номера в массиве phone_numbers

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

Получение списка должностей сотрудников

Метод get.employee_positions
Описание Получение списка должностей сотрудников
Кому доступен Агент, Клиент

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

Название Тип Обязательный Описание
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.employee_positions",
  "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":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "name":"string"
      }
    ]
  }
}

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

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

Добавление должности сотрудника

Метод create.employee_positions
Описание Добавление должности сотрудника
Кому доступен Агент, Клиент

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
name string да Название должности

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

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

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"create.employee_positions",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "name":"string"
  }
}

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

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

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

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

Редактирование должности сотрудника

Метод update.employee_positions
Описание Редактирование должности сотрудника
Кому доступен Агент, Клиент

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
name string да Название должности
id number да Уникальный идентификатор должности

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"update.employee_positions",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "id":"number",
    "name":"string"
  }
}

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

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

  }
}

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

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

Удаление должности сотрудника

Метод delete.employee_positions
Описание Удаление должности сотрудника
Кому доступен Агент, Клиент

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор должности сотрудника
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"delete.employee_positions",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number"
  }
}

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

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

  }
}

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

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

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