Etiqueta de OGM
O Conector de Sinais de OGM ajuda as organizações a se conectarem e automatizarem como se preparam, assinam, agem e gerenciam contratos.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | 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 | Sinal global de OGM |
| URL | https://www.gmosign.com/ |
| Metadados do conector | |
|---|---|
| Publicador | GMO GlobalSign Holdings K.K. |
| Site | https://secure.gmosign.com/ |
| Política de privacidade | https://www.gmogshd.com/privacy |
| Categorias | Conteúdo e arquivos; Produtividade |
Informações do Conector GMOSign
"GMOSign" é um serviço de contratação eletrônica de primeira classe.
O "conector de sinal de OGM" ajuda as organizações a se conectarem e automatizarem o fluxo de contratação (preparar, assinar e gerenciar contratos) em "Sinal de OGM".
Pré-requisitos
Para usar esse conector, você precisa de uma conta de Sinal de OGM válida com a opção de API habilitada.
Entre em contato com o Suporte do GMOSign para obter mais detalhes, pois o aplicativo necessário será diferente dependendo do método de uso.
Como obter credenciais
A ID do cliente e a chave privada da API serão as credenciais do conector.
Para obter as credenciais, entre em contato com o suporte do GMO Sin e assine planos de API para o PowerAutomate.
Introdução ao conector
Visite a Central de Ajuda do GMOSign para obter os detalhes do Conector do Power Automate.
Operações com suporte
Solicitação de assinatura usando um modelo existente –> Criar uma solicitação de assinatura usando um modelo existente disponível no acccount de Sinal de OGM.
Solicitação de assinatura carregando novos documentos –> Crie uma solicitação de assinatura carregando novos documentos.
Criar Envelope Hook –> Criar um gancho para os envelopes solicitados para obter o status de assinatura.
Obter os Documentos Assinados –> Obter os documentos assinados disponíveis na conta de Sinal de OGM usando a ID dos documentos.
Problemas e limitações conhecidos
A partir de agora, não há problemas conhecidos com esse conector.
Erros e soluções comuns
Verifique se há problemas e soluções para entrar em contato conosco .
perguntas frequentes
Visite a Central de Ajuda do GMOSign
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| ID do cliente | secureString | ID do cliente | Verdade |
| Chave secreta | secureString | Chave secreta da API | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Enviar um novo envelope usando um modelo especificado |
Envie um novo envelope usando um modelo especificado. |
| Obter documentos de envelope |
Obter documentos de envelope. |
| Registrar um documento de envelope |
Registre um novo documento de envelope. |
| Registrar um documento de envelope para tamanho enorme |
Registre um novo documento de envelope. |
| Solicitar uma assinatura de envelope |
Solicite uma assinatura de envelope. |
Enviar um novo envelope usando um modelo especificado
Envie um novo envelope usando um modelo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Modelo
|
templateId | True | string |
ID do modelo |
|
Nome do envelope
|
envelope_name | True | string | |
|
Nome do remetente
|
sender_name | string | ||
|
Nome do departamento do remetente
|
sender_post_name | string | ||
|
Notificação de conclusão da assinatura
|
is_compliation_mail | integer |
enviar um email de notificação de conclusão para o remetente |
|
|
Trigger
|
is_web_hook | True | integer |
Disparar um gatilho do PowerAutomate na conclusão da assinatura |
|
Email enviando destino de notificação de erro
|
bounced_note_mail | string | ||
|
ordem de aprovação
|
order_no | string | ||
|
Aprovador
|
name | string | ||
|
Afiliação do aprovador
|
post_name | string | ||
|
Email
|
string | |||
|
comentário de aprovação
|
work_flow_comment | string | ||
|
tipo de signatário
|
signer_type | True | integer | |
|
Uso de modelo
|
use_template | integer |
Se deve usar o signatário registrado no modelo |
|
|
Ordem dos signatários
|
order_no | string | ||
|
Tipo de assinatura
|
sign_type | True | integer | |
|
Nome do signatário
|
name | string | ||
|
Afiliação do signatário
|
organize_name | string | ||
|
Email
|
string | |||
|
Comments
|
comment | string | ||
|
Código de acesso
|
access_code | string | ||
|
autoridade de alteração
|
is_signer_change | integer |
Permitir que o destinatário altere o signatário? |
|
|
Imagem anexada
|
is_attached_file | integer |
Permitir que o signatário anexe uma imagem de sinal? |
|
|
Enviar email
|
is_send_mail | integer |
Enviar um email de solicitação de assinatura para o signatário |
|
|
Idioma do email
|
language | string | ||
|
Tipo de Pagamento
|
payment_type | integer |
Selecionar um tipo de pagamento |
|
|
Fee(JPN Yen)
|
amount | string | ||
|
Description
|
description | string | ||
|
Início do ano de pagamento
|
subscription_start_year | string | ||
|
Iniciar mês de pagamento
|
subscription_start_month | string | ||
|
Dia de início do pagamento
|
subscription_start_date | string | ||
|
Receptor
|
name | string | ||
|
Afiliação do receptor
|
organize_name | string | ||
|
Email
|
string | |||
|
Comennts
|
comment | string | ||
|
Idioma do email
|
language | string | ||
|
Nome do item de mesclagem
|
name | string | ||
|
Valor do item de mesclagem
|
value | string |
Retornos
- Corpo
- SendEnvelopeResponse
Obter documentos de envelope
Obter documentos de envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Retornos
- Corpo
- GetDocumentsResponse
Registrar um documento de envelope
Registre um novo documento de envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Documento
|
document | True | binary |
Os arquivos foram extraídos do SharePoint ou do OneDrive. |
|
Documentar o código
|
document_code | string | ||
|
Sinalizador de reutilização
|
reuse_flag | integer | ||
|
Observações
|
remarks | string |
Retornos
- Corpo
- RegisterDocumentResponse
Registrar um documento de envelope para tamanho enorme
Registre um novo documento de envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Caminho do arquivo
|
file_path | True | string |
Caminho do arquivo após "/input/" do nome do arquivo no servidor SFTP. No AWS S3, a configuração é "s3://(nome do bucket)/(nome de usuário)/input/(nome do arquivo)". |
|
Documentar o código
|
document_code | string | ||
|
Sinalizador de reutilização
|
reuse_flag | integer | ||
|
Observações
|
remarks | string |
Retornos
Solicitar uma assinatura de envelope
Solicite uma assinatura de envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do envelope
|
envelope_name | True | string | |
|
Nome do remetente
|
sender_name | string | ||
|
Nome da postagem do remetente
|
sender_post_name | string | ||
|
Enviar email de compilação
|
is_compilation_mail | integer | ||
|
Enviar gancho da Web
|
is_web_hook | integer | ||
|
Email de anotação saltado
|
bounced_note_mail | string | ||
|
Documentar o código
|
document_code | True | string | |
|
Nome do documento
|
document_name | True | string | |
|
Início do ponto de texto x
|
fill_text_point_start_x | integer |
Se você inserir o texto de preenchimento, ele será necessário e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Início do ponto de texto y
|
fill_text_point_start_y | integer |
Se você inserir o texto de preenchimento, ele será necessário e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de texto final x
|
fill_text_point_end_x | integer |
Se você inserir o texto de preenchimento, ele será necessário e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de texto final y
|
fill_text_point_end_y | integer |
Se você inserir o texto de preenchimento, ele será necessário e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Página não
|
page_no | integer |
Se você inserir o texto de preenchimento, ele será necessário. |
|
|
Tamanho da fonte
|
font_size | double | ||
|
Preencher texto
|
fill_text | string |
Se você inserir o texto de preenchimento, ele será necessário. |
|
|
Início do ponto de texto x
|
date_text_point_start_x | integer |
Se você inserir texto de data, ele será necessário e somente inteiros de 0 a 100 serão permitidos. |
|
|
Início do ponto de texto y
|
date_text_point_start_y | integer |
Se você inserir texto de data, ele será necessário e somente inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de texto final x
|
date_text_point_end_x | integer |
Se você inserir texto de data, ele será necessário e somente inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de texto final y
|
date_text_point_end_y | integer |
Se você inserir texto de data, ele será necessário e somente inteiros de 0 a 100 serão permitidos. |
|
|
Página não
|
page_no | integer |
Se você inserir o texto data, ele será necessário. |
|
|
Tamanho da fonte
|
font_size | double | ||
|
Texto da data
|
date_text | string |
Se você inserir o texto data, ele será necessário. É necessário inserir no formato "YYYYmmdd". |
|
|
Tipo de caixa de seleção
|
check_box_type | string | ||
|
Início do ponto de seleção x
|
check_box_point_start_x | integer |
Se você inserir a caixa de seleção, ela será necessária e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Caixa de seleção ponto inicial y
|
check_box_point_start_y | integer |
Se você inserir a caixa de seleção, ela será necessária e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Caixa de seleção ponto de extremidade x
|
check_box_point_end_x | integer |
Se você inserir a caixa de seleção, ela será necessária e somente números inteiros de 0 a 100 serão permitidos |
|
|
Caixa de seleção ponto final y
|
check_box_point_end_y | integer |
Se você inserir a caixa de seleção, ela será necessária e somente números inteiros de 0 a 100 serão permitidos |
|
|
Página não
|
page_no | integer |
Se você inserir a caixa de seleção, ela será necessária. |
|
|
Ordem não
|
order_no | string |
Se você entrar na lista de signatários da casa, ela será necessária. |
|
|
Ou assinar
|
is_or_sign | integer | ||
|
Tipo de sinal
|
sign_type | integer |
Se você entrar na lista de signatários da casa, ela será necessária. |
|
|
Email
|
string |
Se você entrar na lista de signatários da casa, ela será necessária. |
||
|
Comment
|
comment | string | ||
|
Código de acesso
|
access_code | string |
Se você definir sign_type "Tipo de selo do contrato", ele será opcional. |
|
|
Alteração do signatário
|
is_signer_change | integer |
Se você definir sign_type "Tipo de selo do contrato", ele será opcional. |
|
|
Arquivo anexado
|
is_attached_file | integer |
Ele só está disponível quando você se inscreveu para a "opção de anexo de imagem" e é opcional. |
|
|
Uso de verificação de formato de licença de drivers
|
is_drivers_license_format_check_use | integer |
Ele está disponível e opcional somente quando você se inscreveu para a "opção de anexo de imagem" e definido para o tipo de sinal "Tipo de selo de contrato". Não pode ser especificado por documento. Ele não pode ser usado combinado com a alteração do Signatário e se você definir para o tipo de solicitação "Verificação de documento, não enviar". |
|
|
Enviar email
|
is_send_mail | integer | ||
|
Enviar email de compilação
|
is_compilation_mail | integer | ||
|
Linguagem
|
language | string |
Se você não inserir isso, aplique o conjunto de idiomas para a conta de origem. |
|
|
Signatário não
|
signer_no | string |
Se você inserir na lista de documentos de envelope do signatário da casa, ele será necessário e inserirá o mesmo texto que o Email deste e o signatário correspondente da casa. |
|
|
Documentar o código
|
document_code | string |
Se você inserir na lista de documentos de envelope do signatário da casa, ela será necessária. |
|
|
Tipo de solicitação
|
request_type | string |
Se você inserir na lista de documentos de envelope do signatário da casa, ela será necessária. |
|
|
Arquivo anexado do documento
|
is_document_attached_file | integer | ||
|
Início do ponto de assinatura x
|
signing_text_point_start_x | integer |
Se você inserir pontos de assinatura, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de assinatura y
|
signing_text_point_start_y | integer |
Se você inserir pontos de assinatura, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de assinatura final x
|
signing_text_point_end_x | integer |
Se você inserir pontos de assinatura, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de assinatura final y
|
signing_text_point_end_y | integer |
Se você inserir pontos de assinatura, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página não
|
page_no | integer |
Se você inserir pontos de assinatura, ele será necessário |
|
|
Etiqueta
|
tag | string | ||
|
Obrigatório
|
is_required | string | ||
|
Início do ponto de texto x
|
free_text_point_start_x | integer |
Se você inserir o ponto de texto gratuito, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de texto y
|
free_text_point_start_y | integer |
Se você inserir o ponto de texto gratuito, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final x
|
free_text_point_end_x | integer |
Se você inserir o ponto de texto gratuito, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final y
|
free_text_point_end_y | integer |
Se você inserir o ponto de texto gratuito, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Página não
|
page_no | integer |
Se você inserir o ponto de texto gratuito, ele será necessário |
|
|
Tamanho da fonte
|
font_size | double | ||
|
Texto do espaço reservado
|
placeholder_text | string | ||
|
Etiqueta
|
tag | string | ||
|
Obrigatório
|
is_required | string | ||
|
Início do ponto de texto x
|
date_text_point_start_x | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de texto y
|
date_text_point_start_y | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final x
|
date_text_point_end_x | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final y
|
date_text_point_end_y | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Página não
|
page_no | integer |
Se você inserir o ponto de texto Data, ele será necessário |
|
|
Tamanho da fonte
|
font_size | double | ||
|
Texto do espaço reservado
|
placeholder_text | string | ||
|
Etiqueta
|
tag | string | ||
|
Tipo de caixa de seleção
|
check_box_type | string |
Se você inserir o ponto de caixa de seleção, ele será necessário |
|
|
Início do ponto de seleção x
|
check_box_point_start_x | integer |
Se você inserir o ponto de caixa de seleção, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Caixa de seleção ponto inicial y
|
check_box_point_start_y | integer |
Se você inserir o ponto de caixa de seleção, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Caixa de seleção ponto de extremidade x
|
check_box_point_end_x | integer |
Somente inteiros de 0 a 100 são permitidos |
|
|
Caixa de seleção ponto final y
|
check_box_point_end_y | integer |
Se você inserir o ponto de caixa de seleção, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Página não
|
page_no | integer |
Se você inserir o ponto de caixa de seleção, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ordem não
|
order_no | string | ||
|
Ou assinar
|
is_or_sign | integer | ||
|
Tipo de sinal
|
sign_type | integer |
Se você inserir a lista de signatários do parceiro, ela será necessária. |
|
|
Nome do signatário
|
name | string |
Se você inserir a lista de signatários do parceiro, ela será necessária. |
|
|
Organizar nome
|
organize_name | string | ||
|
Email
|
string |
Seu endereço de email ou número de telefone (é possível se você usar a opção de envio de SMS) é necessário. |
||
|
Número de telefone
|
phone_number | string |
Seu endereço de email ou número de telefone (é possível se você usar a opção de envio de SMS) é necessário. |
|
|
Data da licença do telefone
|
phone_permit_date | string | ||
|
attendant_email
|
attendant_email | string |
Se você definir o tipo de sinal "Assinatura pessoalmente", ele será necessário. |
|
|
Comment
|
comment | string | ||
|
Código de acesso
|
access_code | string |
Se você definir o tipo de sinal " Assinatura pessoalmente, tipo de selo de contrato", ele será designado. |
|
|
Alteração do signatário
|
is_signer_change | integer | ||
|
Arquivo anexado
|
is_attached_file | integer |
Ele só está disponível quando você se inscreveu para a "opção de anexo de imagem". Se houver uma especificação em unidades de documento, ela terá precedência. (Se você definir o tipo de sinal " Assinatura pessoalmente" e o tipo de solicitação "Verificação de documento", ele será considerado "1".) |
|
|
Uso de verificação de formato de licença de drivers
|
is_drivers_license_format_check_use | integer |
Ele está disponível e opcional somente quando você se inscreveu para a "opção de anexo de imagem" e definido para o tipo de sinal "Tipo de selo de contrato". Não pode ser especificado por documento. Ele não pode ser usado combinado com a alteração do Signatário e se você definir para o tipo de solicitação "Verificação de documento, não enviar". |
|
|
Enviar email
|
is_send_mail | integer | ||
|
Enviar email de compilação
|
is_compilation_mail | integer | ||
|
Linguagem
|
language | string |
Se você não inserir isso, aplique o conjunto de idiomas para a conta de origem. |
|
|
Tipo de Pagamento
|
payment_type | integer |
Ele só está disponível quando você se inscreveu para a "opção de pagamento" e é opcional. |
|
|
Fee(JPN Yen)
|
amount | string |
Se você definir o tipo de pagamento "Cada vez, regularmente", ele será necessário. |
|
|
Description
|
description | string | ||
|
Início do ano de pagamento
|
subscription_start_year | string |
Se você definir o tipo de pagamento "Regularmente", ele será necessário. |
|
|
Iniciar mês de pagamento
|
subscription_start_month | string |
Se você definir o tipo de pagamento "Regularmente", ele será necessário. |
|
|
Dia de início do pagamento
|
subscription_sale_date | string |
Se você definir o tipo de pagamento "Regularmente", ele será necessário. |
|
|
Signatário não
|
signer_no | string |
Se você inserir a lista de documentos do signatário do parceiro, ela será necessária e inserirá o mesmo texto que o número de email ou telefone deste e do signatário do Parceiro correspondente. |
|
|
Documentar o código
|
document_code | string |
Se você inserir a lista de documentos do signatário do parceiro, ela será necessária |
|
|
Tipo de solicitação
|
request_type | string |
Se você inserir a lista de documentos do signatário do parceiro, ela será necessária |
|
|
Arquivo anexado do documento
|
is_document_attached_file | integer | ||
|
Início do ponto de assinatura x
|
signing_text_point_start_x | integer |
Se você inserir pontos de assinatura, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de assinatura y
|
signing_text_point_start_y | integer |
Se você inserir pontos de assinatura, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de assinatura final x
|
signing_text_point_end_x | integer |
Se você inserir pontos de assinatura, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de assinatura final y
|
signing_text_point_end_y | integer |
Se você inserir pontos de assinatura, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página não
|
page_no | integer |
Se você inserir pontos de assinatura, ele será necessário |
|
|
Etiqueta
|
tag | string | ||
|
Obrigatório
|
is_required | string | ||
|
Início do ponto de texto x
|
free_text_point_start_x | integer |
Se você inserir o ponto de texto gratuito, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de texto y
|
free_text_point_start_y | integer |
Se você inserir o ponto de texto gratuito, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final x
|
free_text_point_end_x | integer |
Se você inserir o ponto de texto gratuito, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final y
|
free_text_point_end_y | integer |
Se você inserir o ponto de texto gratuito, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Página não
|
page_no | integer |
Se você inserir o ponto de texto gratuito, ele será necessário |
|
|
Tamanho da fonte
|
font_size | double | ||
|
Texto do espaço reservado
|
placeholder_text | string | ||
|
Etiqueta
|
tag | string | ||
|
Obrigatório
|
is_required | string |
Se você inserir o ponto de texto Data, ele será necessário |
|
|
Início do ponto de texto x
|
date_text_point_start_x | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de texto y
|
date_text_point_start_y | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final x
|
date_text_point_end_x | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final y
|
date_text_point_end_y | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Página não
|
page_no | integer |
Se você inserir o ponto de texto Data, ele será necessário |
|
|
Tamanho da fonte
|
font_size | double | ||
|
Texto do espaço reservado
|
placeholder_text | string | ||
|
Etiqueta
|
tag | string | ||
|
Tipo de caixa de seleção
|
check_box_type | string |
Se você inserir o ponto de caixa de seleção, ele será necessário |
|
|
Início do ponto de seleção x
|
check_box_point_start_x | integer |
Se você inserir o ponto de caixa de seleção, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Caixa de seleção ponto inicial y
|
check_box_point_start_y | integer |
Se você inserir o ponto de caixa de seleção, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Caixa de seleção ponto de extremidade x
|
check_box_point_end_x | integer |
Somente inteiros de 0 a 100 são permitidos |
|
|
Caixa de seleção ponto final y
|
check_box_point_end_y | integer |
Se você inserir o ponto de caixa de seleção, ele será necessário e somente números inteiros de 0 a 100 serão permitidos |
|
|
Página não
|
page_no | integer |
Se você inserir o ponto de caixa de seleção, ele será necessário |
|
|
ID da pasta
|
folder_id | integer | ||
|
Ordem não
|
order_no | integer |
Se você designar um aprovador, ele será necessário. |
|
|
Nome
|
name | string |
Se você designar um aprovador, ele será necessário. |
|
|
Nome da postagem
|
post_name | string | ||
|
Email
|
string |
Se você designar um aprovador, ele será necessário. |
||
|
Comentário de fluxo de trabalho
|
workflow_comment | string | ||
|
Nome
|
name | string |
Se você designar um destinatário, ele será necessário. |
|
|
Organizar nome
|
organize_name | string | ||
|
Email
|
string |
Se você designar um destinatário, seu endereço de email ou número de telefone SMS (é possível se você usar a opção de envio de SMS) será necessário. |
||
|
Número de telefone
|
phone_number | string |
Se você designar um destinatário, seu endereço de email ou número de telefone SMS (é possível se você usar a opção de envio de SMS) será necessário. |
|
|
Data da licença do telefone
|
phone_permit_date | string | ||
|
Comment
|
comment | string | ||
|
Linguagem
|
language | string |
Se você não inserir isso, aplique o conjunto de idiomas para a conta de origem. |
Retornos
- Corpo
- RequestSignatureResponse
Gatilhos
| Quando um status de envelope é alterado (Conectar) |
Dispara um novo fluxo quando um status de envelope é alterado. |
Quando um status de envelope é alterado (Conectar)
Dispara um novo fluxo quando um status de envelope é alterado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Título da conexão
|
name | True | string |
Retornos
- Corpo
- WebhookEnvelopeResponse
Definições
WebhookEnvelopeResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de documentos
|
document_list | array of object | |
|
ID do documento
|
document_list.documentId | string | |
|
Nome do documento
|
document_list.document_name | string | |
|
Nome do envelope
|
envelope_name | string | |
|
ID da transação de envelope
|
envelope_xid | string |
GetDocumentsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documento baixado
|
downloadedDocument | byte |
RegisterDocumentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
status da resposta |
|
Resultado
|
result | string |
resultado da resposta |
|
Message
|
message | string |
mensagem de resposta |
|
DocumentCode
|
document_code | string |
código do documento |
RegisterDocumentForHugeSizeResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
status da resposta |
|
Resultado
|
result | string |
resultado da resposta |
|
Message
|
message | string |
mensagem de resposta |
|
DocumentCode
|
document_code | string |
código do documento |
RequestSignatureResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
status da resposta |
|
Resultado
|
result | string |
resultado da resposta |
|
Message
|
message | string |
mensagem de resposta |
|
Envelope TransactionID
|
envelope_xid | string |
envelope_xid |
|
Lista de documentos
|
document_list | array of document |
SendEnvelopeResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da transação de envelope
|
envelope_xid | string |
ID da transação de envelope |
|
Status do envelope
|
envelope_status | string |
O status do envelope. |
|
Lista de documentos
|
document_list | array of document | |
|
Lista de signatários
|
signer_list | array of resSigner |
documento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do documento
|
document_name | string | |
|
ID do documento
|
control_number | string |
resSigner
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Ordem do signatário
|
order_no | string | |
|
Nome do signatário
|
name | string | |
|
Afiliação do signatário
|
organize_name | string | |
|
Email
|
string | ||
|
Tel.
|
phone_number | string | |
|
ID do signatário do envelope
|
envelope_signer_id | string | |
|
Token do signatário do envelope
|
envelope_sign_token | string | |
|
Status do sinal
|
sign_status | string |