Создание новой беседы

Создание беседы в HelpDesk vivaCRM требует указания source_id.

Метод запроса

POST /api/v1/accounts/{account_id}/conversations

Авторизация

• userApiKey

• agentBotApiKey

Заголовки авторизации

api_access_token (string, обязательный) Заголовок

Этот токен можно получить на странице профиля или через консоль rails. Предоставляет доступ к конечным точкам в зависимости от уровня разрешений пользователя. Этот токен может быть сохранен внешней системой при создании пользователя через API для выполнения действий от имени пользователя.

Параметры пути

account_id (integer, обязательный) Числовой ID аккаунта

Тело запроса

application/json

Обязательные параметры

source_id (string, обязательный) ID источника беседы Пример: "1234567890"

inbox_id (integer, обязательный) ID входящих сообщений, в котором создается беседа Разрешенные типы входящих: Website, Phone, Api, Email Пример: 1

Необязательные параметры

contact_id (integer) ID контакта, для которого создается беседа Пример: 1

additional_attributes (object) Позволяет указать атрибуты, такие как информация о браузере Пример:

{
  "browser": "Chrome",
  "browser_version": "89.0.4389.82",
  "os": "Windows",
  "os_version": "10"
}

custom_attributes (object) Объект для сохранения пользовательских атрибутов беседы, принимает ключ и значение пользовательских атрибутов Пример:

{
  "attribute_key": "attribute_value",
  "priority_conversation_number": 3
}

status (enum<string>) Указывает статус беседы: ожидающая, открытая или закрытая Доступные варианты: open, resolved, pending Пример: "open"

assignee_id (integer) ID агента для назначения беседы агенту Пример: 1

team_id (integer) ID команды для назначения беседы команде Пример: 1

snoozed_until (string<date-time>) Дата и время отложения Пример: "2030-07-21T17:32:28Z"

message (object) Первоначальное сообщение, которое будет отправлено в беседу

Ответ

200 - Успешно

application/json

id (number) ID беседы

account_id (number) ID аккаунта

inbox_id (number) ID входящих сообщений

Пример запроса

curl --request POST \
  --url https://helpdesk.vivacrm.ru/api/v1/accounts/{account_id}/conversations \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '{
  "source_id": "1234567890",
  "inbox_id": 1,
  "contact_id": 1,
  "additional_attributes": {
    "browser": "Chrome",
    "browser_version": "89.0.4389.82",
    "os": "Windows",
    "os_version": "10"
  },
  "custom_attributes": {
    "attribute_key": "attribute_value",
    "priority_conversation_number": 3
  },
  "status": "open",
  "assignee_id": 1,
  "team_id": 1,
  "snoozed_until": "2030-07-21T17:32:28Z",
  "message": {
    "content": "Здравствуйте, как я могу вам помочь?",
    "template_params": {
      "name": "sample_issue_resolution",
      "category": "UTILITY",
      "language": "ru_RU",
      "processed_params": {
        "1": "HelpDesk vivaCRM"
      }
    }
  }
}'

Коды ответов

• 200 - Беседа успешно создана

• 403 - Доступ запрещен

• 400 - Неверный запрос