TemplateToPost

Данные сообщения для отправки методом PostTemplate.

message TemplateToPost {
    required string FromBoxId = 1;
    required string ToBoxId = 2;
    required string MessageFromBoxId = 3;
    required string MessageToBoxId = 4;
    optional string MessageToDepartmentId = 5;
    repeated TemplateDocumentAttachment DocumentAttachments = 6;
    optional LockMode LockMode = 7 [default = None];
    optional string FromDepartmentId = 8;
    optional string ToDepartmentId = 9;
    optional string MessageProxyBoxId = 10;
    optional string MessageProxyDepartmentId = 11;
    optional bool IsReusable = 12 [default = false];
}

  • FromBoxId — идентификатор ящика отправителя сообщения.

  • ToBoxId — идентификатор ящика получателя сообщения. Должен отличаться от идентификатора ящика отправителя.

  • MessageFromBoxId — идентификатор ящика отправителя документов, созданных на основе шаблонов.

  • MessageToBoxId — идентификатор ящика получателя документов, созданных на основе шаблонов.

  • MessageToDepartmentId — идентификатор подразделения получателя документов, созданных на основе шаблонов.

  • DocumentAttachments — список документов любых типов, представленных структурой TemplateDocumentAttachment.

  • LockMode — режим блокировки сообщения с шаблонами, принимает значение из перечисления LockMode.

  • FromDepartmentId — идентификатор подразделения отправителя сообщения.

  • ToDepartmentId — идентификатор подразделения получателя, в которое будут отправлены все шаблоны из сообщения. Если отсутствует, то шаблоны будут отправлены в головное подразделение.

  • MessageProxyBoxId — идентификатор ящика промежуточного получателя документов, созданных на основе шаблонов.

  • MessageProxyDepartmentId — идентификатор подразделения промежуточного получателя документов, созданных на основе шаблонов.

  • IsReusable — признак того, что шаблон можно использовать больше одного раза.

При отправке шаблона в роуминг нельзя указать промежуточного получателя и подразделения отправителя или получателя. Шаблоны с заполненными полями FromDepartmentId, ToDepartmentId, MessageProxyBoxId и MessageProxyDepartmentId в роуминг не отправляются.

Шаблон, отправленный методом PostTemplate, можно получить с помощью метода GetMessage (V6).

См. также

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