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

Visualizar todos os aceites enviados através do Aceite via WhatsApp

GET /api/v2/acceptance_term/whatsapps/?page=number

📘

Requisição para a visualização de parte dos metadados do Aceite via WhatsApp na Clicksign. Essa é uma requisição GETpara /api/v2/acceptance_term/whatsapps?page=number, sendo number o número da página.

GET /api/v2/acceptance_term/whatsapps?page=number&access_token=`{{access_token}}` HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Acceptances: atributos do Aceite via Whatsapp

Atributo Descrição Exemplo

key

Chave do Aceite via WhatsApp

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

name

Título do aceite

"Alteração de plano de internet"

sender_name

Nome do destinatário

Nome do destinatário

sender_phone

Número de telefone do destinatário

"55999078674"

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 aceite:
enqueued, sent, completed, canceled, refused, expired e error

"processing"

signer_phone

Número do destinatário

"55999078674"

signer_name

Nome do destinatário

"Fernando Sacchet"

sent_at

Data de envio do aceite para o WhatsApp do destinatário

"2022-07-11T11:21:28.207-03:00"

Page_infos: atributos de Listagem das páginas

total_pagesQuantidade total de páginas1
current_pageNúmero da página que está sendo visualizada.1
next_pageNúmero da próxima página que será visualizada.null
prev_pageNúmero da página anterior.null
first_page?Determina se é a primeira página da listagem.true
last_page?Determina se é a última página da listagem.true
❗️

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.

Exemplo completo

Request

GET /api/v2/acceptance_term/whatsapps?page=1&access_token=`{{access_token}}` HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Body

{
	"acceptances": [
		{
			"key": "27817cd0-bed4-4df4-a89a-52fb99c0fa69",
			"name": "plano internet",
			"sender_name": "Implementação Observer",
			"sender_phone": "55999078674",
			"content": "o valor do plano subiu",
			"status": "sent",
			"signer_phone": "55999078674",
			"signer_name": "Alice example",
			"sent_at": "2022-07-12T14:52:34.653-03:00"
		}
	],
	"page_infos": {
		"total_pages": 1,
		"current_page": 1,
		"next_page": null,
		"prev_page": null,
		"first_page?": true,
		"last_page?": true
	}
}