Для AI-агентов: markdown этой страницы — /docs-content/mail/conversions.md индекс документации — /llms.txt

Создание объектов из письма

Создание объектов портала на основе входящего письма: задача, событие, чат, пост и привязка к делу CRM. Созданное дело CRM можно удалить.

Битрикс24 API: mail.message.create*, mail.message.removecrmactivity Скоуп: mail

Создать задачу из письма

POST /v1/mail/messages/:id/task

Создаёт задачу из письма. Идентификатор письма берётся из пути, тело запроса задаёт только поля задачи и может быть пустым.

Параметры

Параметр В Тип Обяз. Описание
id path integer да Идентификатор письма, из которого создаётся задача. Список: GET /v1/mail/messages

Поля запроса (body)

Поле Тип Обяз. Описание
title string нет Заголовок задачи. По умолчанию — тема письма
responsibleId integer нет Идентификатор ответственного. Список: GET /v1/users. По умолчанию — текущий пользователь
description string нет Описание задачи

Примеры

curl — личный ключ

Terminal 
curl -X POST \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Обработать запрос клиента"}' \
  https://vibecode.bitrix24.tech/v1/mail/messages/123/task

curl — OAuth-приложение

Terminal 
curl -X POST \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Обработать запрос клиента"}' \
  https://vibecode.bitrix24.tech/v1/mail/messages/123/task

JavaScript — личный ключ

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/mail/messages/123/task',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ title: 'Обработать запрос клиента' }),
  }
)
const body = await res.json()
if (!body.success) throw new Error(body.error.code)
console.log(`Задача создана: ${body.data.taskId}`)

JavaScript — OAuth-приложение

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/mail/messages/123/task',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ title: 'Обработать запрос клиента' }),
  }
)

Поля ответа

Поле Тип Описание
success boolean true при успешном создании
data.success boolean Внутренний признак успеха операции
data.taskId integer Идентификатор созданной задачи
data.messageId integer Идентификатор письма, из которого создана задача

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

JSON 
{
  "success": true,
  "data": {
    "success": true,
    "taskId": 4567,
    "messageId": 123
  }
}

Пример ответа при ошибке

400 — письмо не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Ошибка при валидации объекта запроса",
    "validation": [
      {
        "message": "Сообщение удалено или перемещено в другую папку"
      }
    ]
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Нечисловой или отрицательный :id в пути — сообщение id must be a positive integer
400 INVALID_PARAMS Письмо удалено или перемещено в другую папку. Причина — в массиве validation
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный или просроченный ключ
401 KEY_INACTIVE Ключ деактивирован
401 KEY_EXPIRED Срок действия ключа истёк
401 TOKEN_MISSING Ключ не привязан к порталу Битрикс24
403 SCOPE_DENIED Ключу не хватает скоупа mail
422 BITRIX_ERROR Прочие ошибки Битрикс24
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Задача заполняется только заголовком, ответственным, описанием и привязкой к письму. Если на портале настроены обязательные пользовательские поля задач, создание завершается ошибкой.

Смотрите также