Esta seção da documentação descreve detalhadamente os campos utilizados nas requisições e respostas da API, juntamente com as regras de negócio associadas a cada um deles. Aqui, você encontrará informações sobre:
- Definições dos campos: Nome, tipo de dado e formato esperado.
- Validações aplicadas: Regras obrigatórias, valores permitidos e limites de tamanho.
- Dependências e relações: Campos que dependem de outros ou influenciam o comportamento da API.
- Comportamento padrão: Valores atribuídos automaticamente e tratamento de dados opcionais.
Campos e Regras de Negócio:
Descrição dos Campos
| Campo | Descrição | Tipo |
|---|---|---|
| title | Nome/título do Aceite para identificação interna. | string |
| sender_name_option | Opção que define a composição do nome do remetente na mensagem. | string |
| sender_phone | Telefone de contato do remetente (mínimo 10 dígitos). | string |
| message | Texto descritivo contendo o termo de aceite a ser enviado. | string |
| signer_phone | Telefone do destinatário que receberá a mensagem no WhatsApp. | string |
| signer_name | Nome do destinatário que irá realizar o aceite. | string |
| status | Representa o estado atual do fluxo de aceite. | string |
| sender_name | Nome final do remetente, gerado automaticamente pelo sistema. | string |
Regras de Negócio para os campos
| Campo | Regras de Negócio |
|---|---|
| title | Limite máximo padrão de 255 caracteres. |
| sender_name_option | Valores aceitos: user_name, account_name ou user_and_account_name. |
| sender_phone | Deve conter apenas números, incluindo DDD. Opcional. |
| message | Limite máximo de 1500 caracteres. Aceita quebras de linha. |
| signer_phone | Obrigatório. Deve ser um número válido com WhatsApp ativo. |
| signer_name | Limite máximo de 200 caracteres. |
| status | Fluxo: enqueued -> sent -> (completed / refused). Outros estados: error, expired, canceled. |
| sender_name | Este campo é ReadOnly. Ele é montado com base no sender_name_option e dados da conta. |
Regras dos campos para a Criação
| Campo | Obrigatório | Disponível | Valor Padrão |
|---|---|---|---|
| title | SIM | SIM | - |
| sender_name_option | SIM | SIM | - |
| sender_phone | NÃO | SIM | null |
| message | SIM | SIM | - |
| signer_phone | SIM | SIM | - |
| signer_name | SIM | SIM | - |
Regras dos campos para a Atualização
| Campo | Obrigatório | Disponível |
|---|---|---|
| status | NÃO | Apenas para transição para canceled. |
❓Precisa de ajuda? Entre em contato com o Suporte
💰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