RSign (versão prévia)
O RSign® é uma plataforma segura e legalmente vinculativa de assinaturas e que simplifica os fluxos de trabalho de documentos. Esse conector permite que os usuários automatizem o envio de solicitações de assinatura, acompanhem o status do envelope em tempo real e recuperem documentos assinados e certificados de assinatura concluídos. Ele aumenta a eficiência dos negócios digitalizando a execução de documentos e garantindo transações digitais seguras e rastreáveis.
Esse conector está disponível nos seguintes produtos e regiões:
| Serviço | Classe | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte ao RSign |
| URL | https://rsign.com/contact/questions |
| support@rpost.com |
| Metadados do conector | |
|---|---|
| Publicador | RPost US Inc |
| Publicador | RPost US Inc |
| Site da Web | https://rpost.com/ |
| Política de privacidade | https://rpost.com/legal-notices/privacy-notice |
| Categorias | Conteúdo e arquivos; Produtividade |
Visão geral do conector personalizado RSign
Nome do conector:Descrição do RSign: O RSign® é uma plataforma de gerenciamento de transações digitais e assinatura para fluxos de trabalho de documentos seguros, legalmente vinculantes e simplificados. Editor: RPost
1. Funcionalidades do conector
O conector RSign® fornece acesso a funções de gerenciamento de documentos e assinaturas, permitindo que os usuários integrem fluxos de trabalho RSign diretamente em suas soluções do Power Platform (Power Automate, Power Apps e Aplicativos Lógicos).
Ações-chave
Atualmente, o conector dá suporte às seguintes operações primárias:
-
Obter AuthToken: Autentica o usuário com base nas credenciais RSign® e recupera um token necessário (
AuthToken) necessário para todas as chamadas à API subsequentes. - Enviar Envelope usando um modelo: Envia um documento para assinatura eletrônico usando um modelo RSign® pré-configurado, mapeando funções de modelo para destinatários específicos.
- Enviar Envelope usando uma regra: Envia um documento para assinatura eletrônico usando uma regra RSign® pré-configurada, permitindo que documentos sejam fornecidos como dados Base64 no corpo da solicitação.
-
Recuperar informações de modelo: Busca detalhes sobre um modelo ou regra RSign® específico, incluindo documentos definidos e funções de destinatário (
RoleID). - Recuperar o status do envelope: Recupera o status de uma solicitação de assinatura eletrônico usando o Código do Envelope.
- Recuperar documentos de envelope: Baixa os documentos associados a um Código envelope (documentos assinados originais e/ou finais).
2. Configuração de autenticação
O conector RSign® usa um esquema de autenticação personalizado que requer uma chamada bem-sucedida para a ação Get AuthToken antes de executar qualquer outra ação.
Ação de autenticação (Get AuthToken)
Essa ação requer as seguintes credenciais, que devem ser obtidas da plataforma RSign®:
| Nome do parâmetro | Tipo | DESCRIÇÃO | Visibilidade |
|---|---|---|---|
ReferenceKey |
cadeia | A Chave de Referência associada à sua conta do RPost®. | Importante |
EmailId |
cadeia | O endereço de email da sua conta RSign®. | Importante |
Password |
senha | A senha da sua conta do RSign®. | Importante |
Usando o AuthToken
A Get AuthToken ação retorna um AuthToken corpo de resposta. Esse token deve então ser passado em chamadas de API subsequentes para todas as outras ações com suporte.
Nota: O AuthToken tem um tempo de expiração (AuthTokenExpires) e deve ser gerenciado dentro do fluxo ou da lógica do aplicativo para garantir que um novo token seja usado quando o existente expirar.
3. Pré-requisitos
Para usar com êxito esse conector personalizado RSign®, os usuários devem atender aos seguintes requisitos:
- Licença RSign® válida: Os usuários devem ter uma licença de usuário RSign® ativa e válida.
-
Acesso à API: A conta RSign® associada às credenciais fornecidas deve ter o recurso de Acesso à API habilitado e pago. Esse recurso é necessário para gerar e
ReferenceKeyutilizar com êxito o conector RSign®.
Se você não atender a esses requisitos no momento ou não tiver certeza sobre a configuração atual da conta RSign®, entre em contato com o representante do RPost®.
4. Notas importantes para integração
Uso de modelo e regra
-
Código do modelo/código de regra: Ambas as
Send Envelopeações exigem umTemplateCode(ou Código de Regra) que identifica o documento pré-configurado e os campos de assinatura no RSign®. -
Mapeamento de função: Ao enviar um envelope, a
TemplateRoleRecipientMappingmatriz deve ser preenchida. ORoleIDdestinatário deve ser recuperado primeiro usando a açãoRetrieve Template Information. Isso garante que os destinatários sejam mapeados corretamente para os campos de assinatura definidos no modelo.
Tratamento de documentos
-
Enviar Envelope usando uma regra: Essa ação exige que o conteúdo do documento seja passado como uma cadeia de caracteres codificada em Base64 (
DocumentBase64Data). -
Recuperar documentos de envelope: Os documentos são retornados dentro do corpo da resposta como cadeias de caracteres Base64 (
ByteArray). O fluxo de consumo deve decodificar essa cadeia de caracteres para salvar o arquivo.
Tratamento de erros
Todas as ações retornam informações de status no corpo da resposta, incluindo:
-
StatusCode(Inteiro) -
StatusMessage(cadeia de caracteres) -
Message(cadeia de caracteres)
Os usuários devem implementar a verificação de erros com base na execução bem-sucedida da StatusCode operação.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Enviar Envelope usando um modelo |
Envia uma solicitação de eSign para destinatários selecionados usando o modelo RSign indicado. |
| Enviar Envelope usando uma regra |
Envia uma solicitação eSign para destinatários selecionados usando a regra RSign indicada. |
|
Obter Auth |
Retorna um AuthToken a ser usado em todas as outras ações com suporte do RSign. |
| Recuperar documentos de envelope |
Recupera a parte de documentos de um Envelope com base em seu código envelope. Ele recuperará os documentos originais e/ou os Documentos Assinados Finais, dependendo do status do Envelope. |
| Recuperar informações do modelo |
Recupera as informações sobre um modelo ou regra com base em seu código. Entre as informações retornadas está o nome do modelo, documentos e funções definidos. |
| Recuperar status do envelope |
Recupera o status de um Envelope com base em seu código envelope. Você pode selecionar um relatório detalhado ou resumido. |
Enviar Envelope usando um modelo
Envia uma solicitação de eSign para destinatários selecionados usando o modelo RSign indicado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Token de autenticação
|
AuthToken | True | string |
AuthToken recuperado da ação "Get AuthToken". |
|
TemplateCode
|
TemplateCode | True | string |
ID do modelo a ser usado. |
|
Chave do aplicativo
|
AppKey | string |
Identificador exclusivo de um sistema usando o conector. Solicite-o ao Suporte do RPost®. |
|
|
RoleID
|
RoleID | True | string |
ID da função para o destinatário. Recuperado da ação "Recuperar Informações do Modelo". |
|
RecipientEmail
|
RecipientEmail | True | string |
Endereço de email do destinatário. |
|
RecipientName
|
RecipientName | True | string |
Nome do destinatário. |
|
Telemóvel
|
Mobile | string |
Número de celular do destinatário. Se o modelo não exigir, deixe em branco. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código do envelope
|
EnvelopeCode | string |
ID do envelope. |
|
Mensagem de transparência alterada
|
TransparencyChangedMessage | string |
Mensagem de transparência alterada. |
|
Mensagem de API baseada em linguagem
|
LanguageBasedApiMessge | string |
Mensagem de API baseada em linguagem. |
|
ID do destinatário do pré-arquivo
|
PrefillRecipientId | string |
ID do destinatário de pré-preenchimento. |
|
Página de Navegação pós-envio
|
PostSendingNavigationPage | string |
Site para o qual o destinatário será redirecionado assim que terminar de assinar o envelope. |
|
A interface do usuário do novo signatário está habilitada
|
IsNewSignerUIEnabled | boolean |
A interface do usuário do novo signatário está habilitada. |
|
Código de status
|
StatusCode | integer |
Código de status de resposta. |
|
Mensagem de status
|
StatusMessage | string |
Mensagem de status de resposta. |
|
Message
|
Message | string |
Descrição do status da resposta. |
|
Envelope Id
|
EnvelopeId | string |
ID interna do envelope gerado. |
|
Assinar URL do Documento
|
SignDoumentUrl | string |
URL global para assinatura do envelope. |
|
Lista de Destinatários
|
RecipientList | array of object |
Detalhes dos destinatários |
|
Nome do destinatário
|
RecipientList.RecipientName | string |
Nome da parte do destinatário do envelope atual. |
|
Email do destinatário
|
RecipientList.RecipientEmail | string |
Endereço de email da parte do destinatário do envelope atual. |
|
Pedido
|
RecipientList.Order | integer |
Ordem na qual o destinatário precisa acessar para concluir o envelope. |
|
Tipo
|
RecipientList.Type | string |
Tipo de parte do destinatário do envelope atual. Os valores possíveis são: Signer e Prefill. |
|
Modo de Entrega
|
RecipientList.DeliveryMode | integer |
Indica o canal pelo qual a solicitação de assinatura e o código de acesso foram enviados ao destinatário. |
|
Código de discagem
|
RecipientList.DialCode | string |
Código de discagem do país para onde a solicitação de assinatura e o código de acesso foram enviados. |
|
Código do país
|
RecipientList.CountryCode | string |
Código do país para onde a solicitação de assinatura e o código de acesso foram enviados. |
|
Número do Celular
|
RecipientList.Mobile | string |
Número de celular do destinatário. |
|
Modo Móvel
|
RecipientList.MobileMode | integer |
Indica o canal móvel pelo qual a solicitação de assinatura e o código de acesso foram enviados ao destinatário. |
|
URL de assinatura
|
RecipientList.SigningUrl | string |
URL a ser usada pelo destinatário para acessar e assinar o envelope. |
|
Lista suspensa de código de discagem
|
DialCodeDropdownList | string |
Lista suspensa de código de discagem. |
|
Habilitar mensagem para o celular
|
EnableMessageToMobile | string |
Habilite a mensagem para o celular. |
Enviar Envelope usando uma regra
Envia uma solicitação eSign para destinatários selecionados usando a regra RSign indicada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Token de autenticação
|
AuthToken | True | string |
AuthToken recuperado da ação "Get AuthToken". |
|
TemplateCode
|
TemplateCode | True | string |
ID da regra a ser usada. |
|
Nome
|
Name | True | string |
Nome do documento. Inclua a extensão (exemplo: Agreement.docx). |
|
DocumentBase64Data
|
DocumentBase64Data | True | string |
Documento a ser enviado no formato Base64. |
|
Chave do aplicativo
|
AppKey | string |
Identificador exclusivo de um sistema usando o conector. Solicite-o ao Suporte do RPost®. |
|
|
RoleID
|
RoleID | True | string |
ID da função para o destinatário. Recuperado da ação "Recuperar Informações do Modelo". |
|
RecipientEmail
|
RecipientEmail | True | string |
Endereço de email do destinatário. |
|
RecipientName
|
RecipientName | True | string |
Nome do destinatário. |
|
Telemóvel
|
Mobile | string |
Número de celular do destinatário. Se a regra não exigir, deixe em branco. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código do envelope
|
EnvelopeCode | string |
ID do envelope. |
|
Mensagem de transparência alterada
|
TransparencyChangedMessage | string |
Mensagem de transparência alterada. |
|
Mensagem de API baseada em linguagem
|
LanguageBasedApiMessge | string |
Mensagem de API baseada em linguagem. |
|
ID do destinatário do pré-arquivo
|
PrefillRecipientId | string |
ID do destinatário de pré-preenchimento. |
|
Página de Navegação pós-envio
|
PostSendingNavigationPage | string |
Site para o qual o destinatário será redirecionado assim que terminar de assinar o envelope. |
|
A interface do usuário do novo signatário está habilitada
|
IsNewSignerUIEnabled | boolean |
A interface do usuário do novo signatário está habilitada. |
|
Código de status
|
StatusCode | integer |
Código de status de resposta. |
|
Mensagem de status
|
StatusMessage | string |
Mensagem de status de resposta. |
|
Message
|
Message | string |
Descrição do status da resposta. |
|
Envelope Id
|
EnvelopeId | string |
ID interna do envelope gerado. |
|
Assinar URL do Documento
|
SignDoumentUrl | string |
URL global para assinatura do envelope. |
|
Lista de Destinatários
|
RecipientList | array of object |
Detalhes dos destinatários |
|
Nome do destinatário
|
RecipientList.RecipientName | string |
Nome do destinatário. |
|
Email do destinatário
|
RecipientList.RecipientEmail | string |
Endereço de email do destinatário. |
|
Pedido
|
RecipientList.Order | integer |
Ordem na qual o destinatário precisa acessar para concluir o envelope. |
|
Tipo
|
RecipientList.Type | string |
Tipo de parte do destinatário do envelope atual. Os valores possíveis são: Signer e Prefill. |
|
Modo de Entrega
|
RecipientList.DeliveryMode | integer |
Indica o canal pelo qual a solicitação de assinatura e o código de acesso foram enviados ao destinatário. |
|
Código de discagem
|
RecipientList.DialCode | string |
Código de discagem do país para onde a solicitação de assinatura e o código de acesso foram enviados. |
|
Código do país
|
RecipientList.CountryCode | string |
Código do país para onde a solicitação de assinatura e o código de acesso foram enviados. |
|
Número do Celular
|
RecipientList.Mobile | string |
Número de celular do destinatário. |
|
Modo Móvel
|
RecipientList.MobileMode | integer |
Indica o canal móvel pelo qual a solicitação de assinatura e o código de acesso foram enviados ao destinatário. |
|
Url de Assinatura
|
RecipientList.SigningUrl | string |
URL a ser usada pelo destinatário para acessar e assinar o envelope. |
|
Lista suspensa de código de discagem
|
DialCodeDropdownList | string |
Lista suspensa de código de discagem. |
|
Habilitar mensagem para o celular
|
EnableMessageToMobile | string |
Habilite a mensagem para o celular. |
Obter AuthToken
Retorna um AuthToken a ser usado em todas as outras ações com suporte do RSign.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ReferenceKey
|
ReferenceKey | True | string |
Identificador exclusivo da sua conta da Empresa. |
|
EmailId
|
EmailId | True | string |
Endereço de email da sua conta do RSign. |
|
Senha
|
Password | True | password |
Senha da sua conta do RSign. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Mensagem de autenticação
|
AuthMessage | string |
Mensagem de status de resposta. |
|
Token de autenticação
|
AuthToken | string |
Token de autenticação a ser usado em outras ações do RSign. |
|
Atualizar Token
|
RefreshToken | string |
Atualizar Token. |
|
O token de atualização expira
|
RefreshTokenExpires | string |
Data em que o Token de Atualização atual expirará. |
|
O token de autenticação expira
|
AuthTokenExpires | string |
Data em que o Token de Autenticação atual expirará. |
|
Email Id
|
EmailId | string |
Email do usuário autenticado. |
|
API Id
|
ApiId | string |
ID da API. |
Recuperar documentos de envelope
Recupera a parte de documentos de um Envelope com base em seu código envelope. Ele recuperará os documentos originais e/ou os Documentos Assinados Finais, dependendo do status do Envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Código do envelope
|
EnvelopeCode | True | string |
Código do envelope a ser recuperado. |
|
Token de autenticação
|
AuthToken | True | string |
AuthToken recuperado da ação "Get AuthToken". |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
Status | boolean |
Sinalizador de êxito de status. |
|
Código de status
|
StatusCode | integer |
Código de status de resposta. |
|
Message
|
Message | string |
Descrição do status da resposta. |
|
Mensagem de status
|
StatusMessage | string |
Mensagem de status de resposta. |
|
Código do envelope
|
Data.EnvelopeCode | string |
Código de envelope passado como parâmetro. |
|
Lista de documentos
|
Data.DocumentList | array of object |
Lista de documentos. |
|
Tipo de documento
|
Data.DocumentList.DocumentType | string |
Tipo do anexo. |
|
Nome do arquivo
|
Data.DocumentList.FileName | string |
Nome do arquivo. |
|
DESCRIÇÃO
|
Data.DocumentList.Description | string |
Descrição do documento. |
|
Matriz de bytes
|
Data.DocumentList.ByteArray | string |
Arquivo no formato Base64. |
|
Informações adicionais
|
Data.DocumentList.AdditionalInfo | string |
Informações adicionais. |
|
Descrição do anexo
|
Data.DocumentList.AttachmentDescription | string |
Descrição informativa do conteúdo do arquivo. |
|
Ler-me
|
Data.ReadMe | string |
Arquivo de Texto no formato Base64 que indica o nome do documento assinado e o arquivo original. |
|
Zip combinado
|
Data.CombinedZip | string |
Arquivo zip contendo todos os documentos do envelope. |
|
Contagem total
|
TotalCount | integer |
Contagem total. |
|
Existem uploads de anexo
|
IsAttachmentUploadsExist | string |
Os uploads de anexo existem. |
Recuperar informações do modelo
Recupera as informações sobre um modelo ou regra com base em seu código. Entre as informações retornadas está o nome do modelo, documentos e funções definidos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Código do modelo
|
TemplateCode | True | string |
Código do modelo a ser recuperado. |
|
Token de autenticação
|
AuthToken | True | string |
AuthToken recuperado da ação "Get AuthToken". |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de status
|
StatusCode | integer |
Código de status de resposta. |
|
Mensagem de status
|
StatusMessage | string |
Mensagem de status de resposta. |
|
Message
|
Message | string |
Descrição do status da resposta. |
|
ID do modelo
|
TemplateId | string |
ID do modelo. |
|
ID do modelo
|
TemplateBasicInfo.TemplateId | string |
ID do modelo. |
|
Código do modelo
|
TemplateBasicInfo.TemplateCode | integer |
Código de modelo a ser usado em outras ações. |
|
Email do Usuário
|
TemplateBasicInfo.UserEmail | string |
Email do proprietário do modelo. |
|
Nome do modelo
|
TemplateBasicInfo.TemplateName | string |
Nome do modelo. |
|
Descrição do modelo
|
TemplateBasicInfo.TemplateDescription | string |
Descrição do modelo. |
|
Está estático
|
TemplateBasicInfo.IsStatic | string |
Indica se o modelo pode ser modificado ou não. |
|
Data de vencimento
|
TemplateBasicInfo.ExpiryDate | string |
Data em que o modelo expira. |
|
Data de criação
|
TemplateBasicInfo.CreatedDate | string |
Data em que o modelo foi criado. |
|
Data da última modificação
|
TemplateBasicInfo.LastModifiedDate | string |
Data em que o modelo foi modificado pela última vez. |
|
Assunto
|
TemplateBasicInfo.Subject | string |
Assunto do modelo de email. |
|
Corpo
|
TemplateBasicInfo.Body | string |
Corpo do modelo de email. Codificado em HTML. |
|
Nome do Tipo
|
TemplateBasicInfo.TypeName | string |
Tipo de modelo (valores possíveis: Modelo, Regra). |
|
Lista de documentos
|
TemplateBasicInfo.DocumentList | array of object |
Lista de documentos. |
|
ID do documento
|
TemplateBasicInfo.DocumentList.DocumentId | string |
ID da parte do documento do modelo. |
|
Nome do documento
|
TemplateBasicInfo.DocumentList.DocumentName | string |
Nome da parte do documento do modelo. |
|
Pedido
|
TemplateBasicInfo.DocumentList.Order | integer |
Ordem da parte do documento do modelo em sua lista de documentos. |
|
Detalhes do conteúdo do documento
|
TemplateBasicInfo.DocumentList.documentContentDetails | array of object |
Detalhes do conteúdo do documento. |
|
ID de Controle
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlID | string |
ID interna do controle usado no documento. |
|
Nome do controle
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlName | string |
Nome do controle usado no documento. |
|
ID do Html de Controle
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID | string |
ID HTML do controle usado no documento. |
|
Nome de Grupo
|
TemplateBasicInfo.DocumentList.documentContentDetails.GroupName | string |
Nome do grupo que contém o controle. |
|
Etiqueta
|
TemplateBasicInfo.DocumentList.documentContentDetails.Label | string |
Nome do controle a ser exibido no documento. |
|
Página Não
|
TemplateBasicInfo.DocumentList.documentContentDetails.PageNo | integer |
Página no documento no qual o controle está localizado. |
|
Obrigatório
|
TemplateBasicInfo.DocumentList.documentContentDetails.Required | boolean |
Se o controle é necessário ou não. |
|
Valor de controle
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue | string |
Valor pré-preenchido do controle. |
|
ID da função
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleId | string |
ID da função que precisa preencher o controle. |
|
Nome da Função
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleName | string |
Nome da função que precisa preencher o controle. |
|
Selecionar opções de controle
|
TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions | array of string |
Selecione Opções de Controle. |
|
Lista de funções de modelo
|
TemplateBasicInfo.TemplateRoleList | array of object |
Lista de destinatários. |
|
ID de Função
|
TemplateBasicInfo.TemplateRoleList.RoleID | string |
ID da parte da função deste modelo. |
|
Nome da Função
|
TemplateBasicInfo.TemplateRoleList.RoleName | string |
Nome da parte da função deste modelo. |
|
Pedido
|
TemplateBasicInfo.TemplateRoleList.Order | integer |
Ordem na qual a função (destinatário) precisa concluir o modelo. |
|
Email do destinatário
|
TemplateBasicInfo.TemplateRoleList.RecipientEmail | string |
Email pré-preenchido da parte do destinatário deste modelo. |
|
Nome do destinatário
|
TemplateBasicInfo.TemplateRoleList.RecipientName | string |
Nome pré-preenchido da parte do destinatário deste modelo. |
|
ID do tipo de destinatário
|
TemplateBasicInfo.TemplateRoleList.RecipientTypeID | string |
ID interna do tipo de destinatário. |
|
ID do destinatário
|
TemplateBasicInfo.TemplateRoleList.RecipientID | string |
ID da parte do destinatário deste modelo. |
|
Tipo de destinatário
|
TemplateBasicInfo.TemplateRoleList.RecipientType | string |
Tipo de destinatário. |
|
Tipo de Signatário cc
|
TemplateBasicInfo.TemplateRoleList.CcSignerType | string |
Tipo de destinatário CC. |
|
Informações de cultura
|
TemplateBasicInfo.TemplateRoleList.CultureInfo | string |
É o idioma de serviço do usuário no momento da criação do modelo/regra. |
|
Modo de Entrega
|
TemplateBasicInfo.TemplateRoleList.DeliveryMode | integer |
Indica o canal pelo qual a solicitação de assinatura e o código de acesso foram enviados ao destinatário. |
|
Código de discagem
|
TemplateBasicInfo.TemplateRoleList.DialCode | string |
Código de discagem do país para onde a solicitação de assinatura e o código de acesso foram enviados. |
|
Código do país
|
TemplateBasicInfo.TemplateRoleList.CountryCode | string |
Código do país para onde a solicitação de assinatura e o código de acesso foram enviados. |
|
Número do Celular
|
TemplateBasicInfo.TemplateRoleList.Mobile | string |
Número de celular do destinatário. |
|
Modo Móvel
|
TemplateBasicInfo.TemplateRoleList.MobileMode | integer |
Indica o canal móvel pelo qual a solicitação de assinatura e o código de acesso foram enviados ao destinatário. |
|
Endereço de Email
|
TemplateBasicInfo.TemplateRoleList.EmailAddress | string |
Endereço de email do destinatário. |
|
Habilitar mensagem para o celular
|
TemplateBasicInfo.EnableMessageToMobile | boolean |
Habilite a mensagem para o celular. |
|
Data de expiração do link estático
|
TemplateBasicInfo.StaticLinkExpiryDate | string |
Data de expiração do link estático. |
|
Lista de modelos
|
TemplateList | string |
Lista de modelos. |
Recuperar status do envelope
Recupera o status de um Envelope com base em seu código envelope. Você pode selecionar um relatório detalhado ou resumido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Token de autenticação
|
AuthToken | True | string |
AuthToken recuperado da ação "Get AuthToken". |
|
EnvelopeCode
|
EnvelopeCode | True | string |
Código do envelope. |
|
DetailOrSummary
|
DetailOrSummary | True | string |
Selecione o tipo de relatório desejado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
Status | boolean |
Estado do pedido. |
|
Código de status
|
StatusCode | integer |
Código de status de resposta. |
|
Message
|
Message | string |
Descrição do status da resposta. |
|
Mensagem de status
|
StatusMessage | string |
Mensagem de status de resposta. |
|
Lista de dados do envelope
|
Data | array of object | |
|
Código do envelope
|
Data.EnvelopeCode | string |
ID do envelope. |
|
Envelope ID
|
Data.EnvelopeID | string |
ID interna do envelope. |
|
Assunto
|
Data.Subject | string |
Assunto do email do envelope. |
|
Envelope Status
|
Data.Status | string |
Status do Envelope solicitado. |
|
IsEnvelopeComplete
|
Data.IsEnvelopeComplete | boolean |
Indica se o envelope foi concluído. |
|
Data de envio
|
Data.SentDate | string |
Data em que o envelope foi enviado. |
|
DataDaÚltimaModificação
|
Data.LastModifiedDate | string |
Data da Última Modificação. |
|
SenderName
|
Data.SenderName | string |
Nome do remetente. |
|
SenderEmail
|
Data.SenderEmail | string |
Email do remetente. |
|
Detalhes do destinatário
|
Data.RecipientDetails | array of object | |
|
ID do destinatário
|
Data.RecipientDetails.RecipientID | string |
ID da parte do destinatário do envelope atual. |
|
ID do tipo de destinatário
|
Data.RecipientDetails.RecipientTypeID | string |
Digite a ID da parte do destinatário do envelope atual. |
|
Tipo de destinatário
|
Data.RecipientDetails.RecipientType | string |
Tipo de parte do destinatário do envelope atual. Os valores possíveis são: Signer e Prefill. |
|
Nome do destinatário
|
Data.RecipientDetails.RecipientName | string |
Nome do destinatário. |
|
Email
|
Data.RecipientDetails.Email | string |
Endereço de email do destinatário. |
|
Pedido
|
Data.RecipientDetails.Order | integer |
Ordem na qual o destinatário precisa acessar para concluir o envelope. |
|
StatusID
|
Data.RecipientDetails.StatusId | string |
ID de status. |
|
Status de Assinatura
|
Data.RecipientDetails.SigningStatus | string |
Status da assinatura do destinatário do envelope. |
|
Data da última modificação
|
Data.RecipientDetails.LastModifiedDate | string |
Data da Última Modificação. |
|
Código de referência
|
Data.ReferenceCode | string |
Parte do código de referência do envelope atual. |
|
Email de referência
|
Data.ReferenceEmail | string |
Parte do email de referência do envelope atual. |
|
TotalCount
|
TotalCount | integer |
Quantidade total de envelopes que correspondem aos critérios solicitados. |
|
IsAttachmentUploadsExist
|
IsAttachmentUploadsExist | string |
Os uploads de anexo existem. |