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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  }
}

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

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

Удаление тега

Метод delete.tags
Описание Удаление тега
Кому доступен Партнёр, Клиент

Нельзя удалять системные теги - теги у которых лаг "is_system" = true

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

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

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

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

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

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

  }
}

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

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

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

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

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

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

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

Название Тип Фильтрация Сортировка Описание
id number да Уникальный идентификатор тега
name string да да Название тега
is_system boolean Признак, того что тег системный и не может быть удален

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

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

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

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

Проставление тега продажа на обращение

Метод set.tag_sales
Описание Проставление тега продажа на обращение
Кому доступен Партнёр, Клиент

Метод доступен для использования, если у сайта активна опция "Учитывать продажи"

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
communication_id number да Уникальный идентификатор обращения. По данному идентификатору можно получить детализированную информацию используя следующие методы "get.communications_report", "get.chats_report ", "get.goals_report", "get.offline_messages_report ", "get.calls_report"
communication_type enum да chat, call, goal, offline_message Тип обращения.
date_time iso8601 да YYYY-MM-DD hh:mm:ss Дата и время сделки
Не должна быть раньше даты обращения
transaction_value number да Стоимость сделки
comment string нет Максимальная длина 255 символов Комментарий к сделке

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

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

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"set.tag_sales",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "communication_id":"number",
    "communication_type":"enum",
    "date_time":"iso8601",
    "transaction_value":"number",
    "comment":"string"
  }
}

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

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

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

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

Проставление тега на обращение

Метод set.tag_communications
Описание Проставление тега на обращение
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
communication_id number да Уникальный идентификатор обращения. По данному идентификатору можно получить детализированную информацию используя следующие методы "get.communications_report", "get.chats_report ", "get.goals_report", "get.offline_messages_report ", "get.calls_report"
communication_type enum да chat, call, goal, offline_message Тип обращения.
tag_id number да Уникальный идентификатор тега, см. метод "get.tags"

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"set.tag_communications",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "communication_id":"number",
    "communication_type":"enum",
    "tag_id":"number"
  }
}

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

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

  }
}

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

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

Снятие тега с обращения

Метод unset.tag_communications
Описание Снятие тега с обращения (так же используется для снятия тега продажа)
Кому доступен Партнёр, Клиент

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
communication_id number да Уникальный идентификатор обращения. По данному идентификатору можно получить детализированную информацию используя следующие методы "get.communications_report", "get.chats_report ", "get.goals_report", "get.offline_messages_report ", "get.calls_report"
communication_type enum да chat, call, goal, offline_message Тип обращения.
tag_id number да Уникальный идентификатор тега, см. метод "get.tags"

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"unset.tag_communications",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "communication_id":"number",
    "communication_type":"enum",
    "tag_id":"number"
  }
}

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

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

  }
}

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

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

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