Consultar detalhes do modelo de envelope

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

Descrição da interface

Consultar as propriedades detalhadas de um "modelo de envelope" pré-configurado na interface (incluindo estrutura de arquivo, papéis dos participantes e chaves de identificação de todos os controles predefinidos (Key)).

Parâmetros de solicitação

Nome do parâmetro

Tipo

Obrigatório

Descrição

envelopeTemplateId

string

true

ID do modelo de envelope

queryComponents

boolean

false

Se deve consultar as informações dos controles. Padrão: false

true-Sim

false-Não

Exemplo de solicitação

 {
 	"envelopeTemplateId":"dc4be9641a3145bea97809018d7a9180",
 	"queryComponents":true
 }

Parâmetros de resposta

Nome do parâmetro					Tipo	Descrição
code					int	Código do negócio, 0 indica sucesso, valores diferentes de 0 indicam erro.
message					string	Informações do negócio Verifique o erro com base no code; não dependa da correspondência da message, pois a message pode ser alterada.
data					object	Dados do negócio
	envelopeTemplateId				string	ID do modelo de envelope
	envelopeTemplateName				string	Nome do modelo de fluxo
	envelopeTemplateStatus				int	Status de disponibilidade do modelo de fluxo 1-Ativado 0-Desativado
	digitalSignature				boolean	Ativar assinatura digital true-Ativado false-Desativado
	signFiles				array	Informações do arquivo
		documentId			string	ID do arquivo
		fileName			string	Nome do arquivo
	participants				array	Parte participante
		participantId			string	ID da parte participante
		participantSetMode			string	Requisitos de participação (método de designação do participante) presetSigner-Especificar ao usar um modelo (definido por quem utiliza o modelo) dedicateSigner-Membro fixo (codificado no modelo, não podendo ser alterado) sender-Iniciador
		participantInfos			object	Parte participante individual
			userEmail		string	E-mail do signatário
			phoneNumber		object	Número de telefone, vazio por padrão Parâmetro obrigatório quando for necessária notificação por SMS; countryCode e number devem ser informados
				countryCode	string	Código internacional do país/região, sem necessidade de informar “+”
				number	string	Sem validação de formato, com limite máximo de 13 caracteres
			userName		string	Nome pessoal
			deliveryMethod		string	Método de notificação auto - enviar notificação por e-mail ao informar o userEmail, enviar notificação por SMS ao informar o phoneNumber none - não enviar notificações de mensagem email - enviar notificação por e-mail sms - enviar notificação por SMS WhatsApp - enviar notificação via WhatsApp
			customizeSettings		object	Configuração personalizada
				customizeMessage	string	Mensagem exclusiva Limite de caracteres: 1000
				notificationLanguage	string	Idioma da notificação, padrão é inglês en-US Inglês zh-CN Chinês simplificado zh-Hant Chinês tradicional ja Japonês es-MX Espanhol pt-PT Português th-TH Tailandês id-ID Indonésio vi-VN Vietnamita ms-MY Malaio fil-PH Filipino de-DE Alemão fr-FR Francês ru-RU Russo it-IT Italiano ko-KR Coreano
		signOrder			int	Ordem de assinatura 1-255 Participantes diferentes podem ser repetidos
		willingnessAuthModes			string	Método de intenção do signatário, separado por vírgulas em inglês noAuth-Sem verificação accessCode-Verificação por senha de assinatura sms-Verificação OTP por SMS idVerification-Verificação de documento de identidade emailAuth-Verificação OTP por e-mail digitalId-Verificação de identidade digital whatsappAuth-Verificação OTP por WhatsApp
			accessCode		object	Configuração da senha de assinatura, obrigatório quando authModes=accessCode
				accessCode	string	Conteúdo da senha, não diferencia maiúsculas de minúsculas, pode conter letras e números, limite de comprimento 45
				promptInfo	string	Mensagem de dica para a senha de acesso, não pode conter a senha de acesso, limite de comprimento 30, obrigatório quando authModes=1.
			sms		object	Validação OTP por SMS, obrigatório quando authModes=sms
				countryCode	string	Código internacional do país/região, não é necessário enviar o “+”
				number	string	Sem validação de formato, apenas limite máximo de comprimento de 13 caracteres
			idVerification		object	Configuração de verificação de documento de identidade, obrigatório quando authModes=idVerification
				name	string	Nome completo conforme consta no documento de identidade do signatário, comprimento máximo de 100 caracteres
			emailAuth		object	Validação OTP por e-mail, obrigatório quando authModes=emailAuth
				authEmail	string	Endereço de e-mail de verificação de identidade do signatário
			digitalId		array	Verificação de identidade eletrônica, obrigatório quando authModes=digitalId
				authApp	string	Aplicativo usado para verificação de identidade eletrônica singpass - Autenticação de identidade usando Singpass iamsmart - Autenticação usando IAM Smart
				idNumber	string	Número do documento de identificação do signatário a ser verificado
			whatsappAuth		object	Validação OTP do WhatsApp, obrigatório quando authModes=whatsappAuth
				countryCode	string	Código internacional do país/região, não é necessário enviar o “+”
				number	string	Sem validação de formato, apenas limite máximo de 13 caracteres
		components			object	Informações do controle
	copiers				array	Configurar cópia
		copierId			string	ID do participante
		editable			boolean	Se permite alteração na criação
		CCInfos			object	Informações da cópia
			userEmail		string	E-mail
			userName		string	Nome pessoal
			customizeSettings		object	Configuração personalizada
				notificationSettings	object	Configuração personalizada de notificações
				notificationLanguage	string	Idioma da notificação, padrão em inglês en-US Inglês zh-CN Chinês Simplificado zh-Hant Chinês Tradicional ja Japonês ES-MX Espanhol
	attachments				array	Informações do anexo
		editable			boolean	Permitir modificação na criação
		fileKey			string	filekey do anexo
		fileName			string	Nome do anexo
		downloadUrl			string	Link de download do PDF do rascunho do documento, válido por 60 minutos.
components					array	Lista de controles
	documentId				string	Chave do arquivo do controle
	componentId				string	ID do controle
	componentKey				string	Chave do controle (identificador do controle preenchido pelo usuário ao configurar o modelo de arquivo)
	componentName				string	Nome do controle
	componentType				string	Tipo de controle 1, Texto 2, Número 3, Data 6, Área de assinatura padrão 8, Texto multilinha 9, Caixa de seleção 10, Opção única 11, Imagem 14, Controle de lista suspensa 15, Controle de caixa de seleção 20, Área de carimbo 21, Área de aprovação 22, Data de assinatura 23, E-mail 100, Renminbi
	componentDefaultValue				string	Valor padrão do controle
	componentPosition				object	Posição do controle
		componentPositionX			float	Coordenada horizontal da posição do controle
		componentPositionY			float	Coordenada vertical da posição do controle
		componentPageNum			int	Número da página do controle
	componentSize				object	Dimensões do controle
		componentWidth			int	Largura do controle (distância das margens esquerda e direita do retângulo, em px)
		componentHeight			int	Altura do controle (distância das margens superior e inferior do retângulo, em px)
	componentTextFormat				object	Estilo de caracteres do controle
		font			int	Fonte de preenchimento, padrão 1, 1-Songti, 2-Xin Songti, 4-Heiti, 5-Kaiti
		fontSize			float	Tamanho da fonte de preenchimento, padrão 12-Xiao Si 42-Chu Hao 36-Xiao Chu 26-Yi Hao 24-Xiao Yi 22-Er Hao 19-Xiao Er 16-San Hao 15-Xiao San 14-Si Hao 12-Xiao Si 10.5-Wu Hao 9-Xiao Wu
		textColor			string	Cor da fonte, padrão #000000 preto
		bold			boolean	Negrito, padrão false true-Sim false-Não
		italic			boolean	É itálico, padrão false true-Sim false-Não
		horizontalAlignment			string	Alinhamento horizontal, padrão 1-alinhamento à esquerda LEFT-Alinhamento à esquerda CENTER-Alinhamento centralizado RIGHT-Alinhamento à direita
		verticalAlignment			string	Alinhamento vertical, padrão 1-alinhamento superior (aplica-se a texto de várias linhas) TOP-Alinhamento superior MIDDLE-Alinhamento centralizado BOTTOM-Alinhamento inferior
		textLineSpacing			float	Espaçamento entre linhas, padrão 1.0 Suporta até uma casa decimal, valor máximo 2.0 (aplica-se a texto de várias linhas)
	required				boolean	É obrigatório true-Obrigatório false-Opcional
	componentMaxLength				string	Comprimento máximo de preenchimento do controle (número de caracteres em chinês)
	componentSpecialAttribute				object	Propriedades específicas do controle
		numberFormat			string	Formato numérico (controle numérico) Inteiro: 0 Uma casa decimal: 0.0 Duas casas decimais: 0.00
		dateFormat			string	Formato de data (controle de data)
		imageType			string	Tipo de imagem (controle de imagem) IDCard_widthwise Cartão de Identidade Horizontal Travar Proporção IDCard_longitudinal Cartão de Identidade Vertical Travar Proporção other Outros Não Travar Proporção
		options			array	Opções (controle de seleção suspensa, controle de opção única, controle de múltipla escolha)
			optionOrder		int	Ordem das opções
			optionContent		string	Conteúdo da opção
			selected		boolean	Se está selecionado por padrão
			optionPositionX		float	Coordenada X do elemento filho na borda do controle pai
			optionPositionY		float	Coordenada Y do elemento filho na borda do controle pai
			optionWidth		float	Largura do elemento filho
			optionHeight		float	Altura do elemento filho
	signField				object	Propriedades da área de carimbo e assinatura padrão
		fieldStyle			int32	Estilo da área de carimbo e assinatura 1-Área de carimbo e assinatura em página única 2-Área de carimbo e assinatura na costura
		sizeRule			int	Tamanho do carimbo 1-Aplica carimbo com tamanho real 2-Tamanho personalizado (ajustado à largura e altura da área de assinatura)
		movable			boolean	true-Pode ser movido durante a assinatura false-Não pode ser movido durante a assinatura
	stampField				object	Propriedades da área do carimbo
		fieldStyle			int	Estilo da área de carimbo e assinatura 1-Área de carimbo e assinatura em página única 2-Área de carimbo e assinatura na costura
		sizeRule			int	Especificações do carimbo 1-Usar as especificações reais do carimbo 2-Especificações personalizadas (adaptadas à largura e altura da área de assinatura)
		movable			boolean	true-Pode ser movido durante a assinatura false-Não pode ser movido durante a assinatura
	signDateField				object	Propriedades da data de assinatura
		dateFormat			string	Formato da data: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	Propriedades da área de aprovação
		allowedOptions			array	Opções de aprovação do signatário, aplicável quando fieldType é approval. Padrão: ["approve", "decline"] approve-Aprovar decline-recusar

Exemplo de resposta

{
  "code": "0",
  "data": {
    "envelopeTemplateName": "test",
    "signFiles": [
      {
        "fileDownloadUrl": "https://******",
        "fileName": "***.pdf",
        "documentId": "$eac****-d6f8-4b6b-bafe-******$3328404894"
      }
    ],
    "attachments": [],
    "digitalSignature": false,
    "envelopeTemplateStatus": 1,
    "independentComponents": [],
    "envelopeCategoryId": null,
    "envelopeTemplateId": "dc4be9641a3145bea97809018d7a9180",
    "participants": [
      {
        "participantFlag": "",
        "idVerification": null,
        "components": [
          {
            "componentType": "10",
            "componentId": "556b60f7bd324428908b41f3bbec8c54",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 485.42538,
              "componentPositionX": 35.96627,
              "componentPageNum": "1"
            },
            "componentSpecialAttribute": {
              "options": [
                {
                  "optionContent": "***",
                  "optionHeight": 32.923893,
                  "optionOrder": 0,
                  "optionPositionY": 85.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项二",
                  "optionHeight": 15.0,
                  "optionOrder": 1,
                  "optionPositionY": 60.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项三",
                  "optionHeight": 15.0,
                  "optionOrder": 2,
                  "optionPositionY": 35.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项四",
                  "optionHeight": 15.0,
                  "optionOrder": 3,
                  "optionPositionY": 10.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                }
              ],
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 128,
              "componentWidth": 144
            },
            "signDateField": null,
            "required": true,
            "stampField": null,
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "单选1",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          },
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "****",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "42750b92c7a***05134dd5342",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "presetSigner",
        "emailAuth": null
      },
      {
        "participantFlag": "***",
        "idVerification": null,
        "components": [
          {
            "componentType": "20",
            "componentId": "7c401b43cdc94b61a7813aa58ac82bbf",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 327.15793,
              "componentPositionX": 109.17395,
              "componentPageNum": "2"
            },
            "componentSpecialAttribute": {
              "options": null,
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 150,
              "componentWidth": 150
            },
            "signDateField": null,
            "required": true,
            "stampField": {
              "movable": false,
              "sizeRule": 1,
              "fieldStyle": 1
            },
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "图章区",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          }
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "***",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "b055dfce00c5******40cdabb23822ea4",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "dedicateSigner",
        "emailAuth": null
      }
    ],
    "copiers": []
  },
  "message": "SUCCESS"
}