Visualizar todos os aceites enviados através do Aceite via WhatsApp
GET /api/v2/acceptance_term/whatsapps/?page=number
Requisição de Aceite via WhatsAppRequisiçã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
, ondenumber
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
Atributo | Descrição | Exemplo |
---|---|---|
key | Chave única do aceite via WhatsApp | "27817cd0-bed4-4df4-a89a-52fb99c0fa69" |
name | Título do aceite | "Alteração de plano de internet" |
sender_name | Nome de quem enviou o aceite | "Clicksign API" |
sender_phone | Número de telefone do remetente | "55999078674" |
content | Conteú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." |
status | Status do aceite (enqueued , sent , completed , canceled , refused , expired , error ) | "sent" |
signer_phone | Telefone do destinatário (quem assina | "55999078674" |
signer_name | Nome do destinatário (quem assina) | "Fernando Sacchet" |
sent_at | Data de envio do aceite via WhatsApp | "2022-07-11T11:21:28.207-03:00" |
📄 Page_infos: Atributos da Paginação
Atributo | Descrição | Exemplo |
---|---|---|
total_pages | Quantidade total de páginas | 1 |
current_page | Página atual da listagem | 1 |
next_page | Próxima página (caso exista) | null |
prev_page | Página anterior (caso exista) | null |
first_page? | Indica se é a primeira página | true |
last_page? | Indica se é a última página | true |
Se a requisição falharSempre 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
}
}
Updated about 1 month ago