Перейти к основному содержимому

Ответ на ошибочный пакет

Если провайдер не может обработать запрос, он отправляет в ответ пакет errorResponse с кодом ошибки.

Структура пакета​

<errorResponse>
<header/>
<payload>
<code>string</code>
</payload>
</errorResponse>
Полная XML-схема пакета errorResponse
<xsd:schema>
<xsd:element name="errorResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="header" type="xsd:string"/>
<xsd:element name="payload">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="code">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="error-syntax"/>
<xsd:enumeration value="error-system"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>

Параметры пакета​

к сведению

Все параметры в таблице входят в объект payload.

ПараметрТипХарактерОписание
codeStringОбязательныйКод ответа платформы.
Возможные значения:
error-syntax — ошибка синтаксиса.
error-system — сбой системы.

Пример пакета​

<errorResponse>
<header/>
<payload>
<code>error-system</code>
</payload>
</errorResponse>

Коды ответов платформы при невозможности обработки запроса​

КодОписание
okПакет успешно обработан.
error-syntaxОшибка синтаксиса.
error-authОшибка аутентификации.
error-permissionОшибка прав доступа.
error-systemСистемная ошибка.
error-account-lockedАккаунт заблокирован.
error-out-message-client-id-formatНекорректный формат параметра clientId исходящего сообщения.
error-out-message-client-id-duplicateПараметр clientId исходящего сообщения не уникален в рамках пакета.
error-out-message-provider-id-formatНекорректный формат providerId исходящего сообщения.
error-out-message-provider-id-duplicateПараметр providerId исходящего сообщения не уникален в рамках пакета.
error-in-message-inbox-code-not-specifiedКод ящика входящих сообщений не указан.
error-in-message-inbox-code-formatНекорректный формат кода ящика входящих сообщений.