Visualizar Aceite via WhatsApp
Requisição para a visualização dos metadados do Aceite via WhatsApp na Clicksign.
Visualizar Aceite via WhatsApp V3
Esta é uma requisição
GETpara/api/v3/acceptance_term/whatsapps/:id, sendo:ida chave do Aceite via WhatsApp.
GET /api/v3/acceptance_term/whatsapps/:id HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: {{access_token}}
O retorno segue o padrão JSON:API com os atributos do Aceite via WhatsApp.
Atributos do Aceite via WhatsApp
| Atributo | Descrição | Exemplo |
|---|---|---|
id | Chave única do Aceite via WhatsApp | "27817cd0-bed4-4df4-a89a-52fb99c0fa69" |
type | Tipo do recurso no padrão JSON:API | "acceptance_term_whatsapps" |
title | Nome/Título do aceite | "Alteração Plano Internet" |
sender_name | Nome do remetente que se identificou para o destinatário. Derivado automaticamente de sender_name_option. | "Fernando (Clicksign)" |
sender_name_option | Opção utilizada para definir o nome do remetente. Valores possíveis: user_name, account_name ou user_and_account_name | "user_and_account_name" |
sender_phone | Telefone do remetente para contato | "11999078674" |
message | Conteúdo do aceite | "Eu, Fulano declaro que fui informado..." |
status | Status do objeto de aceite: enqueued, sent, completed, canceled | "sent" |
status_flow | Fluxo atual do status do aceite | "waiting_acceptance" |
signer_phone | Telefone do destinatário que recebeu o aceite em seu WhatsApp | "55999078674" |
signer_name | Nome do destinatário que recebeu o aceite em seu WhatsApp | "Fernando Sacchet" |
sent_at | Data em que a primeira mensagem do aceite foi enviada para o destinatário | "2025-11-27T14:52:34.653Z" |
created | Data de criação do objeto de aceite | "2025-11-27T14:52:34.653Z" |
modified | Data da última modificação do objeto de aceite | "2025-11-27T14:55:00.000Z" |
Exemplo completo
Request
GET /api/v3/acceptance_term/whatsapps/ccb3a81d-aaff-4813-9eae-acdc643ed0fa HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: {{access_token}}Response
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json; charset=utf-8{
"data": {
"id": "ccb3a81d-aaff-4813-9eae-acdc643ed0fa",
"type": "acceptance_term_whatsapps",
"attributes": {
"title": "Alteração Plano Internet",
"sender_name": "Jones (Clicksign)",
"sender_phone": "82999078674",
"sender_name_option": "user_and_account_name",
"message": "Eu, Fernando Sacchet declaro que fui informado sobre a mudança de plano e aumento de valor na mensalidade para R$: 129,99.",
"signer_phone": "55999078674",
"signer_name": "Fernando Sacchet",
"status": "sent",
"status_flow": "waiting_acceptance",
"sent_at": "2025-11-27T11:21:28.207Z",
"created": "2025-11-27T11:06:29.996Z",
"modified": "2025-11-27T11:21:28.207Z"
}
}
}Status do Aceite
| Status | Descrição |
|---|---|
enqueued | Aceite criado e aguardando envio via WhatsApp. |
refused | Aceite recusado. |
expired | Aceite expirado. |
error | Aceite com erro. |
sent | Aceite enviado via WhatsApp para o destinatário. |
completed | Aceite confirmado pelo destinatário. |
canceled | Aceite cancelado. |
Erros comuns
| Status HTTP | Código | Descrição |
|---|---|---|
| 404 | Not Found | Aceite não encontrado ou não pertence à conta autenticada. |
Se a requisição para a Clicksign falharSempre 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.
Updated 11 days ago