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

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

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

📘

Requisição de Aceite via WhatsApp

Requisição para visualizar parte dos metadados do Aceite via WhatsApp na Clicksign.

Esta é uma requisição GET para o endpoint:
/api/v2/acceptance_term/whatsapps?page=number, onde number representa 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


AtributoDescriçãoExemplo
keyChave única do aceite via WhatsApp"27817cd0-bed4-4df4-a89a-52fb99c0fa69"
nameTítulo do aceite"Alteração de plano de internet"
sender_nameNome de quem enviou o aceite"Clicksign API"
sender_phoneNúmero de telefone do remetente"55999078674"
contentConteúdo da mensagem de aceite"Eu, {{nome_destinatario}}, declaro que fui informado sobre a mudança de plano e aumento de valor na mensalidade para R$: 129,99."
statusStatus do aceite (enqueued, sent, completed, canceled, refused, expired, error)"sent"
signer_phoneTelefone do destinatário (quem assina"55999078674"
signer_nameNome do destinatário (quem assina)"Fernando Sacchet"
sent_atData de envio do aceite via WhatsApp"2022-07-11T11:21:28.207-03:00"

📄 Page_infos: Atributos da Paginação

AtributoDescriçãoExemplo
total_pagesQuantidade total de páginas1
current_pagePágina atual da listagem1
next_pagePróxima página (caso exista)null
prev_pagePágina anterior (caso exista)null
first_page?Indica se é a primeira páginatrue
last_page?Indica se é a última páginatrue

❗️

Se a requisição falhar

Sempre verifique o corpo da resposta (body). Ele indicará o motivo da falha.

Consulte mais detalhes em Mensagens de erro.


🧪 Exemplo de Requisição e Resposta

📤 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
  }
}