These docs are for v1.0. Click to read the latest docs for v3.0.

Visualizar Aceite via WhatsApp

GET /api/v2/acceptance_term/whatsapps/:key

📘

Requisição para a visualização dos metadados do Aceite via Whatsapp na Clicksign. Esta é uma requisiçãoGET para /api/v2/acceptance_term/whatsapps/:key, sendo :key a chave do Aceite via Whatsapp.

GET /api/v2/acceptance_term/whatsapps/:key/?access_token{{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json
👍

Dividimos o retorno da requisição em blocos para facilitar o seu entendimento.
Os blocos são:
Acceptance - Messages

Acceptance: atributos do Aceite via Whatsapp

Atributo

Descrição

Exemplo

key

Chave do Aceite via Whatsapp

"27817cd0-bed4-4df4-a89a-52fb99c0fa69"

name

Nome/Título do aceite

"Alteração Plano Internet"

sender_name

Nome do remetente que irá se identificar para o destinatário.
Pode ser informado: user_name, account_name ou user_and_account_name

Ao informar:
"user_name": "Fernando"
"account_name": "Clicksign"
"user_and_account_name": "Fernando (Clicksign)"

sender_phone

Telefone do remetente para contato

"11999078674"

content

Conteúdo do aceite

"Eu, {{nome_destinatario}} declaro que fui informado sobre a mudança de plano e aumento de valor na mensalidade para R$: 129,99."

status

Status do objeto de aceite: enqueued, sent, completed, canceled, refused, expired, error

"processing"

signer_phone

Telefone do destinatário que irá receber o aceito em seu WhatsApp

"55999078674"

signer_name

Nome do destinatário que irá receber o aceito em seu WhatsApp

"Fernando Sacchet"

sent_at

Data em que a primeira mensagem do aceite foi enviada para o destinatário

"2022-07-12T14:52:34.653-03:00"

created_at

Data de criação do objeto de aceite

"2022-07-12T14:52:34.653-03:00"

messages

Armazena as interações realizadas entre o destinatário e a Clicksign no WhatsApp

Listado na tabela abaixo

Messages: atributos da listagem de mensagens trocadas no Aceite via Whatsapp

AtributoDescriçãoExemplo
message_idChave para rastreabilidade do registro"SM02656784ba0949b48f85f98d1f508442"
messageMensagem enviada ou recebida no WhatsApp do destinatário"Olá Fernando Sacchet!\n\n O Remetente Jones (Clicksign) enviou Termo para Alteração de Plano Internet para você analisar e a Clicksign foi contratada para registrar o seu aceite. Toque em Visualizar para ter acesso ao conteúdo.\n\n Lembre-se que o processo de aceite precisa ser finalizado em até 24 horas para não expirar.\n\n Ao visualizar, você confirma que é Fernando Sacchet, concorda com os Termos de Uso da Clicksign e declara estar ciente da Política de Privacidade.\n\n Termos de Uso 👉 https://www.clicksign.com/termos\n\n Política de Privacidade 👉 https://www.clicksign.com/politica-de-privacidade"
profile_nameNome do destinatário/remetente no WhatsApp"Fernando Sacchet"
error_messageNome do destinatário/remetente no WhatsApp"Fernando Sacchet"
error_messageMensagem de erro caso o envio falhenull
directionDireção do envio da mensagem, se a mensagem foi enviada ou recebida"sent"
created_atData de criação do evento"2022-07-11T11:21:28.207-03:00"
{
"acceptance": {
		"key": "ccb3a81d-aaff-4813-9eae-acdc643ed0fa",
		"name": "Alteração Plano Internet",
		"sender_name": "Jones (Clicksign)",
		"sender_phone": "82999078674",
		"content": "Eu, Fernando Sacchet declaro que fui informado sobre a mudança de plano e aumento de valor na mensalidade para R$: 129,99.",
		"status": "sent",
		"signer_phone": "55999078674",
		"signer_name": "Fernando Sacche",
		"sent_at": "2022-07-11T11:21:28.207-03:00",
		"created_at": "2022-07-11T11:06:29.996-03:00",
		"messages": [
			{
				"message_id": "SM02656784ba0949b48f85f98d1f508442",
				"message": "Olá *Fernando Sacchet*!\n\n O Remetente *Jones (Clicksign)* enviou *Termo para Alteração de Plano Internet* para você analisar e a Clicksign foi contratada para registrar o seu aceite. Toque em Visualizar para ter acesso ao conteúdo.\n\n Lembre-se que o processo de aceite precisa ser finalizado em até *24 horas* para não expirar.\n\n Ao visualizar, você confirma que é *Fernando Sacchet*, concorda com os Termos de Uso da Clicksign e declara estar ciente da Política de Privacidade.\n\n Termos de Uso 👉 https://www.clicksign.com/termos\n\n Política de Privacidade 👉 https://www.clicksign.com/politica-de-privacidade",
				"profile_name": "Fernando Sacchet",
				"error_message": null,
				"direction": "sent",
				"created_at": "2022-07-11T11:21:28.207-03:00"
			}
		]
	}
}
❗️

Se a requisição para a Clicksign falhar

Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.