MessageValidationError

Информация об ошибках, найденных при проверке возможности отправки сообщения методом CanPostMessage.

message MessageValidationError {
    required MessageValidationErrorSeverity Severity = 1;
    required string UserMessage = 2;
    required string ApiMessage = 3;
    optional string CustomDocumentId = 4;
    optional string BoxId = 5;
    optional string DepartmentId = 6;
}

enum MessageValidationErrorSeverity {
    Unknown = 0;
    Error = 1;
    Warning = 2;
}

  • Severity — уровень критичности, принимает значение из перечисления MessageValidationErrorSeverity:

    • Unknown — неизвестное значение: клиент использует устаревшую версию SDK и не может интерпретировать ответ;

    • Error — сообщение с указанными параметрами отправить нельзя;

    • Warning — сообщение с указанными параметрами можно отправить, но есть ограничения или особенности.

  • UserMessage — удобочитаемый текст ошибки или предупреждения.

  • ApiMessage — текст ошибки или предупреждения.

  • CustomDocumentId — идентификатор документа во внешней системе, к которому относится ошибка. Соответствует значению из входных параметров структуры DocumentAttachmentPrototype. Может быть пустым в случае, если ошибка относится не к документу.

  • BoxId — идентификатор ящика, к которому относится ошибка или предупреждение. Может быть пустым.

  • DepartmentId — идентификатор подразделения, к которому относится ошибка или предупреждение. Может быть пустым.

См. также

Структура используется: