Перейти к содержимому
HallifyРазработчикамПоиск по документации
Открыть Hallify
Разделы

Коммуникации с гостями

Передать подписанное входящее сообщение провайдера

POST/guest-communication-providers/{providerId}/events/inbound

Проверяет событие провайдера, устраняет повторы его идентификатора и добавляет входящее сообщение в соответствующий диалог заведения. Профиль Hallify HMAC guest-provider использует HMAC-SHA256. Каноническое сообщение: RFC3339 + "." + JSON.stringify(разобранный DTO). Передайте x-hallify-timestamp в формате RFC3339; допустимое расхождение — ±300 секунд. Формат x-hallify-signature: base64url; сравнение выполняется за постоянное время. Используйте выданный секрет как текст UTF-8. Content-Type: application/json. Некорректная или просроченная подпись: 401 GUEST_PROVIDER_WEBHOOK_UNAUTHORIZED. Сам по себе повтор подписи не отклоняется; повторы определяются идентификаторами сообщения и события провайдера.

Авторизация

x-hallify-signature: <HALLIFY_SIGNATURE>

Подпись HMAC-SHA256. Точный протокол каждой операции указан в метаданных x-hallify-hmac и её описании.

Руководство по подключению

Параметры

providerIdПуть · Обязательно

UUID Hallify. До чтения или изменения ресурса проверяется его принадлежность всем родительским арендаторам и агрегатам маршрута.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}
x-hallify-timestampЗаголовок · Обязательно

Время в формате RFC3339; допустимое расхождение часов — ±300 секунд.

string
Полное определение
{
  "type": "string",
  "example": "example"
}

Тело запроса

Обязательно

Идентификаторы события и сообщения провайдера, контакт отправителя, необязательная тема, текст и время события: подписанное тело входящего сообщения.

application/json

GuestProviderInboundMessageDto
Полное определение
{
  "$ref": "#/components/schemas/GuestProviderInboundMessageDto"
}

Ответы

200Возвращает найденный диалог и признак нового применения или повтора события провайдера.
GuestProviderWebhooksInboundResultDto
Полное определение
{
  "$ref": "#/components/schemas/GuestProviderWebhooksInboundResultDto"
}
Пример ответа · 200 · application/json
{
  "accepted": true,
  "messageId": "6656e43a-a70a-4ac5-8f2c-e049d62f80c7",
  "conversationId": "d6993a6a-84c6-4c36-8812-5d181ae025cd",
  "duplicate": true
}
400Некорректный идентификатор провайдера или тело входящего сообщения.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401Провайдер недоступен либо его HMAC-подпись недействительна или просрочена.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}
503Не удалось расшифровать секрет подписи провайдера.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Схемы

GuestProviderInboundMessageDto

Проверяет событие провайдера, устраняет повторы его идентификатора и добавляет входящее сообщение в соответствующий диалог заведения.

externalEventIdОбязательно

Непрозрачный идентификатор externalEventId; клиент не должен предполагать формат UUID. Ограничения: максимальная длина 191.

string
Полное определение
{
  "type": "string",
  "maxLength": 191,
  "description": "Непрозрачный идентификатор `externalEventId`; клиент не должен предполагать формат UUID. Ограничения: максимальная длина 191.",
  "example": "Synthetic example"
}
externalMessageIdОбязательно

Непрозрачный идентификатор externalMessageId; клиент не должен предполагать формат UUID. Ограничения: максимальная длина 191.

string
Полное определение
{
  "type": "string",
  "maxLength": 191,
  "description": "Непрозрачный идентификатор `externalMessageId`; клиент не должен предполагать формат UUID. Ограничения: максимальная длина 191.",
  "example": "Synthetic example"
}
contactValueОбязательно

Контактное значение, трактуемое согласно соседним полям типа, вида, единицы или правил входящего сообщения провайдера. Максимальная длина — 254 символа.

string
Полное определение
{
  "type": "string",
  "maxLength": 254,
  "description": "Контактное значение, трактуемое согласно соседним полям типа, вида, единицы или правил входящего сообщения провайдера. Максимальная длина — 254 символа.",
  "example": "Synthetic example"
}
subjectНеобязательно

Тема входящего сообщения провайдера. Максимальная длина — 255 символов.

string
Полное определение
{
  "type": "string",
  "maxLength": 255,
  "description": "Тема входящего сообщения провайдера. Максимальная длина — 255 символов.",
  "example": "Synthetic example"
}
bodyОбязательно

Текст входящего сообщения провайдера, написанный человеком. Длина от 1 до 5000 символов.

string
Полное определение
{
  "type": "string",
  "minLength": 1,
  "maxLength": 5000,
  "description": "Текст входящего сообщения провайдера, написанный человеком. Длина от 1 до 5000 символов.",
  "example": "Synthetic example"
}
occurredAtОбязательно

Время occurredAt в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Время `occurredAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
  "example": "2026-01-15T12:00:00.000Z"
}
Полное определение
{
  "type": "object",
  "properties": {
    "externalEventId": {
      "type": "string",
      "maxLength": 191,
      "description": "Непрозрачный идентификатор `externalEventId`; клиент не должен предполагать формат UUID. Ограничения: максимальная длина 191.",
      "example": "Synthetic example"
    },
    "externalMessageId": {
      "type": "string",
      "maxLength": 191,
      "description": "Непрозрачный идентификатор `externalMessageId`; клиент не должен предполагать формат UUID. Ограничения: максимальная длина 191.",
      "example": "Synthetic example"
    },
    "contactValue": {
      "type": "string",
      "maxLength": 254,
      "description": "Контактное значение, трактуемое согласно соседним полям типа, вида, единицы или правил входящего сообщения провайдера. Максимальная длина — 254 символа.",
      "example": "Synthetic example"
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "Тема входящего сообщения провайдера. Максимальная длина — 255 символов.",
      "example": "Synthetic example"
    },
    "body": {
      "type": "string",
      "minLength": 1,
      "maxLength": 5000,
      "description": "Текст входящего сообщения провайдера, написанный человеком. Длина от 1 до 5000 символов.",
      "example": "Synthetic example"
    },
    "occurredAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `occurredAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-01-15T12:00:00.000Z"
    }
  },
  "required": [
    "externalEventId",
    "externalMessageId",
    "contactValue",
    "body",
    "occurredAt"
  ],
  "description": "Проверяет событие провайдера, устраняет повторы его идентификатора и добавляет входящее сообщение в соответствующий диалог заведения.",
  "example": {
    "externalEventId": "Synthetic example",
    "externalMessageId": "Synthetic example",
    "contactValue": "Synthetic example",
    "body": "Synthetic example",
    "occurredAt": "2026-01-15T12:00:00.000Z"
  }
}
GuestProviderWebhooksInboundResultDto

Возвращает найденный диалог и признак нового применения или повтора события провайдера.

acceptedОбязательно

Допустимые значения accepted: true.

boolean
Полное определение
{
  "type": "boolean",
  "enum": [
    true
  ],
  "description": "Допустимые значения `accepted`: true.",
  "example": true
}
messageIdОбязательно

UUID Hallify для messageId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `messageId`.",
  "example": "6656e43a-a70a-4ac5-8f2c-e049d62f80c7"
}
conversationIdОбязательно

UUID Hallify для conversationId.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `conversationId`.",
  "example": "d6993a6a-84c6-4c36-8812-5d181ae025cd"
}
duplicateОбязательно

Было ли переданное событие уже принято и обработано как повтор.

boolean
Полное определение
{
  "type": "boolean",
  "description": "Было ли переданное событие уже принято и обработано как повтор.",
  "example": true
}
Полное определение
{
  "type": "object",
  "required": [
    "accepted",
    "messageId",
    "conversationId",
    "duplicate"
  ],
  "properties": {
    "accepted": {
      "type": "boolean",
      "enum": [
        true
      ],
      "description": "Допустимые значения `accepted`: true.",
      "example": true
    },
    "messageId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `messageId`.",
      "example": "6656e43a-a70a-4ac5-8f2c-e049d62f80c7"
    },
    "conversationId": {
      "type": "string",
      "format": "uuid",
      "description": "UUID Hallify для `conversationId`.",
      "example": "d6993a6a-84c6-4c36-8812-5d181ae025cd"
    },
    "duplicate": {
      "type": "boolean",
      "description": "Было ли переданное событие уже принято и обработано как повтор.",
      "example": true
    }
  },
  "description": "Возвращает найденный диалог и признак нового применения или повтора события провайдера.",
  "example": {
    "accepted": true,
    "messageId": "6656e43a-a70a-4ac5-8f2c-e049d62f80c7",
    "conversationId": "d6993a6a-84c6-4c36-8812-5d181ae025cd",
    "duplicate": true
  }
}
TranslatedErrorDto

Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.

statusCodeОбязательно

HTTP-статус, повторённый из ответа.

integer
Полное определение
{
  "type": "integer",
  "description": "HTTP-статус, повторённый из ответа.",
  "example": 400
}
errorОбязательно

Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.

string
Полное определение
{
  "type": "string",
  "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
  "example": "errors.request.invalid"
}
codeОбязательно

Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями.

string
Полное определение
{
  "type": "string",
  "example": "HTTP_BAD_REQUEST",
  "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
}
messageОбязательно

Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе.

string
Полное определение
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
}
translationKeyОбязательно

Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте.

string
Полное определение
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
}
translationValuesНеобязательно

Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.

object
Полное определение
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
  "example": {
    "exampleKey": "example"
  }
}
validationErrorsНеобязательно

Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.

array
Полное определение
{
  "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ValidationErrorDto"
  },
  "example": [
    {
      "field": "email",
      "translationKey": "validation:isEmail",
      "code": "isEmail",
      "message": "validation:isEmail"
    }
  ]
}
detailsНеобязательно

Необязательные сведения о доменных препятствиях или ошибках валидации.

oneOf
Полное определение
{
  "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "example": [
    "example"
  ]
}
Полное определение
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer",
      "description": "HTTP-статус, повторённый из ответа.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": [
            "example"
          ]
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/JsonValue"
          },
          "example": {
            "exampleKey": "example"
          }
        }
      ],
      "example": [
        "example"
      ]
    }
  },
  "required": [
    "statusCode",
    "error",
    "code",
    "message",
    "translationKey"
  ],
  "description": "Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}
ValidationErrorDto

Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.

fieldОбязательно

Публичный путь поля. Вложенные свойства и индексы массива разделены точками.

string
Полное определение
{
  "type": "string",
  "example": "email",
  "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
}
translationKeyОбязательно

Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers.

string
Полное определение
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
}
codeОбязательно

Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы.

string
Полное определение
{
  "type": "string",
  "example": "isEmail",
  "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
}
messageОбязательно

Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются.

string
Полное определение
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
}
translationValuesНеобязательно

Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.

object
Полное определение
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
  "example": {
    "exampleKey": "example"
  }
}
Полное определение
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}
JsonValue

Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.

Полное определение
{
  "oneOf": [
    {
      "type": "string",
      "nullable": true,
      "example": "example"
    },
    {
      "type": "number",
      "example": 0
    },
    {
      "type": "boolean",
      "example": true
    },
    {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": [
        "example"
      ]
    },
    {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "example": {
        "exampleKey": "example"
      }
    }
  ],
  "description": "Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.",
  "example": "example"
}

Hallify использует обязательные cookies и опциональную аналитику.

Обязательные cookies поддерживают вход, язык и тему. Аналитика выключена, пока вы явно ее не разрешите.