Управление адресной книгой

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

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

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

Название Тип Обязательный Описание
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 да да Фамилия Имя Отчество
emails array Максимум 10 адресов да Адрес электронной почты контакта.
phone_numbers array Максимум 10 номеров да Список номеров контакта
Персональный менеджер
personal_manager_id number да Уникальный идентификатор персонального менеджера
personal_manager_full_name string да Фамилия Имя Отчество персонального менеджера
Организация
organization_id number да Уникальный идентификатор организации
organization_name string да Название организации
Группы в которых состоит контакт
groups array да Список групп в которых состоит контакт
group_id number Уникальный идентификатор группы
group_name string Название группы

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.contacts",
  "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",
        "last_name":"string",
        "first_name":"string",
        "patronymic":"string",
        "full_name":"string",
        "emails":[
          "email"
        ],
        "groups":[
          {
            "group_id":"number",
            "group_name":"string"
          }
        ],
        "phone_numbers":[
          "number"
        ],
        "personal_manager_id":"number",
        "personal_manager_full_name":"string",
        "organization_name":"string",
        "organization_id":"number"
      }
    ]
  }
}

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

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

Удаление контакта из адресной книге

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

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

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

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

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

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

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

  }
}

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

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

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

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

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
first_name string нет Имя контакта
last_name string да Фамилия контакта
patronymic string нет Отчество контакта
emails array нет Максимум 10 адресов Адрес электронной почты контакта.
E-mail должен быть уникальным в списке.
phone_numbers array да Максимум 10 номеров Список номеров контакта в формате E164
Номер должен быть уникальным в списке.
personal_manager_id number нет Персональный менеджер - это сотрудник, отвечающий за работу с клиентом. При создании сценария "Переадресация на персонального менеджера" звонки клиентов будут поступать персональным менеджерам без дополнительных настроек списка номеров вызывающего абонента и списка телефонов сотрудников. Для получения списка сотрудников используется метод "get.employees"
organization_id number нет Уникальный идентификатор организации. Для получения списка организаций см. метод "get.contact_organizations".
groups array нет Список уникальных идентификаторов групп в которых состоит контакт, см. метод "get.group_contacts"

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

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

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

{
  "jsonrpc":"2.0",
  "method":"create.contacts",
  "id":"number",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "last_name":"string",
    "first_name":"string",
    "patronymic":"string",
    "emails":[
      "email"
    ],
    "groups":[
      "group_id"
    ],
    "phone_numbers":[
      "number"
    ],
    "personal_manager_id":"number",
    "organization_id":"number"
  }
}

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

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

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

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

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

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

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

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

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор контакта в адресной книге
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
first_name string нет Имя контакта
last_name string да Фамилия контакта
patronymic string нет Отчество контакта
emails array нет Максимум 10 адресов Адрес электронной почты контакта.
E-mail должен быть уникальным в списке.
phone_numbers array да Максимум 10 номеров Список номеров контакта в формате E164
Номер должен быть уникальным в списке.
personal_manager_id number нет Персональный менеджер - это сотрудник, отвечающий за работу с клиентом. При создании сценария "Переадресация на персонального менеджера" звонки клиентов будут поступать персональным менеджерам без дополнительных настроек списка номеров вызывающего абонента и списка телефонов сотрудников. Для получения списка сотрудников используется метод "get.employees"
organization_id number нет Уникальный идентификатор организации. Для получения списка организаций см. метод см. метод "get.contact_organizations".
groups array нет Список уникальных идентификаторов групп в которых состоит контакт, см. метод "get.group_contacts".

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

{
  "jsonrpc":"2.0",
  "method":"update.contacts",
  "id":"number",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number",
    "last_name":"string",
    "first_name":"string",
    "patronymic":"string",
    "emails":[
      "email"
    ],
    "groups":[
      "group_id"
    ],
    "phone_numbers":[
      "number"
    ],
    "personal_manager_id":"number",
    "organization_id":"number"
  }
}

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

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

  }
}

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

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

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

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

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

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

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

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

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

{
  "jsonrpc":"2.0",
  "method":"create.group_contacts",
  "id":"number",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "name":"string",
    "members":[
      "contact_id"
    ]
  }
}

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

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

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

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

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

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

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

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

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

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

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

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

  }
}

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

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

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

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

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

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор группы контактов адресной книги
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
name string да Название группы контактов
members array нет Список уникальных идентификаторов контактов, которые входят в группу. Список контактов можно получить с помощью метода "get.contacts".

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

{
  "jsonrpc":"2.0",
  "method":"update.group_contacts",
  "id":"number",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number",
    "name":"string",
    "members":[
      "contact_id"
    ]
  }
}

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

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

  }
}

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

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

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

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

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

Название Тип Обязательный Описание
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 да Признак, что группа системная и ее нельзя удалить
Список контактов входящих в группу
members array да Список уникальных идентификаторов контактов, которые входят в группу.
contact_id number Уникальный идентификатор контакта, см. метод "get.contacts"
contact_full_name string Фамилия Имя Отчество контакта

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.group_contacts",
  "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",
        "members":[
          {
            "contacts_id":"number",
            "contact_full_name":"string"
          }
        ]
      }
    ]
  }
}

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

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

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

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

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

Название Тип Обязательный Описание
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.contact_organizations",
  "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.contact_organizations
Описание Создание организации контакта
Кому доступен Агент, Клиент

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  }
}

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

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

Удаление организации контакта

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

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

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

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

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

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

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

  }
}

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

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

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