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 GET para /api/v3/acceptance_term/whatsapps/:id, sendo :id a 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

AtributoDescriçãoExemplo
idChave única do Aceite via WhatsApp"27817cd0-bed4-4df4-a89a-52fb99c0fa69"
typeTipo do recurso no padrão JSON:API"acceptance_term_whatsapps"
titleNome/Título do aceite"Alteração Plano Internet"
sender_nameNome do remetente que se identificou para o destinatário. Derivado automaticamente de sender_name_option."Fernando (Clicksign)"
sender_name_optionOpçã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_phoneTelefone do remetente para contato"11999078674"
messageConteúdo do aceite"Eu, Fulano declaro que fui informado..."
statusStatus do objeto de aceite: enqueued, sent, completed, canceled"sent"
status_flowFluxo atual do status do aceite"waiting_acceptance"
signer_phoneTelefone do destinatário que recebeu o aceite em seu WhatsApp"55999078674"
signer_nameNome do destinatário que recebeu o aceite em seu WhatsApp"Fernando Sacchet"
sent_atData em que a primeira mensagem do aceite foi enviada para o destinatário"2025-11-27T14:52:34.653Z"
createdData de criação do objeto de aceite"2025-11-27T14:52:34.653Z"
modifiedData 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

StatusDescrição
enqueuedAceite criado e aguardando envio via WhatsApp.
refusedAceite recusado.
expiredAceite expirado.
errorAceite com erro.
sentAceite enviado via WhatsApp para o destinatário.
completedAceite confirmado pelo destinatário.
canceledAceite cancelado.

Erros comuns

Status HTTPCódigoDescrição
404Not FoundAceite não encontrado ou não pertence à conta autenticada.
❗️

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.