Criando um Aceite via WhatsApp

POST /api/v2/acceptance_term/whatsapps

📘

Requisição para a criação do Aceite via Whatsapp na Clicksign. Esta é uma requisição POSTpara /api/v2/acceptance_term/whatsapps. No body, deverão ser enviados os atributos do aceite.

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

Atributos para criação do Aceite via WhatsApp

Atributo

Descrição

Exemplo

name Obrigatório

Nome/título do Aceite.

A soma dos caracteres do campo name e content não pode ultrapassar 1500.

Se o campo name possui 50 caracteres, o limite no campo content será de 1450 caracteres, por exemplo.

"Alteração Plano Internet"

sender_name Obrigatório

Nome do remetente que irá se identificar para o destinatário.

Pode ser informado: user_name, account_name ou user_and_account_name.

Ao informar: "user_name": "Fernando" "account_name": "Clicksign" "user_and_account_name": "Fernando (Clicksign)"

sender_phone

Telefone do remetente para contato.

"11999078674"

content Obrigatório

Conteúdo do aceite.

A soma dos caracteres do campo name e content não pode ultrapassar 1500.

Se o campo name possui 50 caracteres, o limite no campo content será de 1450 caracteres, por exemplo.

"Eu, {{nome_destinatario}} declaro que fui informado sobre a mudança de plano e aumento de valor na mensalidade para R$: 129,99."

signer_phone Obrigatório

Telefone do destinatário que irá receber o aceite em seu WhatsApp.

"55999078674"

signer_name Obrigatório

Nome do destinatário que irá receber o aceite em seu WhatsApp.

"Fernando Spacchet"

❗️

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

POST /api/v2/acceptance_term/whatsapps?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json
{
    "acceptance_term": {
        "name": "plano internet",
        "sender_name": "user_name",
        "sender_phone": "55999078674",
        "content": "o valor do plano subiu",
        "signer_phone": "55999078674",
        "signer_name": "Alice example"
    }
}

Response

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
🚧

Veja em Visualizar Aceite via WhatsApp a explicação detalhada do JSON de retorno dos destinatários.

Body
{
    "acceptance_term": {
        "key": "037f797b-b472-4258-b0a2-261f7c86e218",
        "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": null
    }
}




❓Precisa de ajuda? [email protected]

💰Dúvida sobre planos e preços? Veja o comparativo

🔍Não sabe qual versão está usando? Descubra a sua versão

📚Respostas rápidas? Visite nosso FAQ