Загрузка офлайн заявок

Метод	`upload.offline_messages`
Описание	Загрузка офлайн заявок
Кому доступен	Агент, Клиент
Необходимые компоненты для работы с методом	Data API, Загрузка офлайн-заявок из внешней системы
Максимальное количество заявок в одном запросе	500 шт

Параметры, обязательные для заполнения:
- visitor_session_id, campaign_id или site_id (если указанны несколько параметров, то данные должны быть консистентные)
- phone или email

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

Название	Тип	Обязательный	Допустимые значения	Описание
`access_token`	string	да		Ключ сессии аутентификации
`user_id`	number	нет		Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`offline_messages`	array	да		Список офлайн заявок. Максимально 500
`date_time`	iso8601	да	YYYY-MM-DD hh:mm:ss	Дата и время создания заявки. Не может быть в будущем. Должна быть больше чем у переданной сессии посетителя. Если параметр не передан, то проставится время вызова
`name`	string	нет		Имя посетителя
`phone`	string	да, если не указан `email`		Телефон посетителя в формате E164
`email`	string	да, если не указан `phone`		Email посетителя
`message`	string	нет		Сообщение посетителя
`visitor_session_id`	number	да, если не указан `campaign_id` или `site_id`		Уникальный идентификатор сессии посетителя полученной из CoMagic. Для получения ID необходимо использовать метод JS API Comagic.getSessionId()
`campaign_id`	number	да, если не указан `visitor_session_id` или `site_id`		Уникальный идентификатор рекламной кампании в CoMagic. Для получения campaign_id можно использовать метод Data API "get.campaigns". Если передается `"campaign_id": -1`, то обязательно указывать `site_id`.
`source_id`	number	нет		Уникальный идентификатор источника. Возможно передать только неудаленный источник в разрезе клиента. Если передан `visitor_session_id`, то определим `source_id` по параметрам сессии.
`site_id`	number	да, если не указан `campaign_id` или `visitor_session_id`		Уникальный идентификатор сайта.
`form_name`	string	нет		Имя пользовательской JS Формы.
`ext_id`	string	нет		Уникальный идентификатор заявки в вашей системе
`user_fields`	array	нет		Пользовательские поля проставленные у заявки. Перед тем как передать, нужно создать пользовательское поле через метод "create.offline_message_user_field"

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

Копировать

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "upload.offline_messages",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "offline_messages": [
      {
        "date_time": "iso8601",
        "name": "string",
        "phone": "string",
        "email": "string",
        "message": "string",
        "visitor_session_id": "number",
        "campaign_id": "number",
        "source_id": "number",
        "site_id": "number",
        "form_name": "string",
        "ext_id": "string",
        "user_fields": [
          {
            "ext_id": "string",
            "value": "string"
          },
          {
            "ext_id": "string",
            "value": "string"
          }
        ]
      }
    ]
  }
}

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

Копировать

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "data": [
      {
        "id": "number"
      }
    ],
    "metadata": "object"
  }
}

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

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