Ответ на ошибочный пакет
Если провайдер не может обработать запрос, он отправляет в ответ пакет 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.
| Параметр | Тип | Характер | Описание |
|---|---|---|---|
code | String | Обязательный | Код ответа платформы.
Возможные значения: 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 | Некорректный формат кода ящика входящих сообщений. |