Skip to main content
POST
Texto do botão: o WhatsApp exibe o botão com um texto predefinido no idioma do usuário, já que o texto deste botão não pode ser personalizado. Você só pode configurar a mensagem que o acompanha no campo text.

​
Boas Práticas

Privacidade: Sempre explique por que você precisa das informações de contato do usuário. Seja transparente sobre como os dados serão usados.

​
Casos de Uso

  • Cadastrar um novo cliente
  • Coletar dados para dar seguimento a uma solicitação
  • Confirmar a identidade do usuário antes de continuar um processo
  • Atualizar as informações de contato de um cliente existente

Autorizações

​
Authorization
string
header
obrigatório

Basic authentication using Base64 encoded clientId:clientSecret

Parâmetros de caminho

​
botId
string
obrigatório

The unique identifier of the bot

Corpo

application/json

Message payload. The structure varies based on the message type.

​
type
enum<string>
obrigatório

Type of message to send

Opções disponíveis:
text
Exemplo:

"text"

​
userId
string
obrigatório

Unique identifier of the user receiving the message. Accepts either a phone number in E.164 format without the leading '+' (e.g. '593999999999') or a BSUID (Business-Scoped User ID, e.g. 'US.13491208655302741918') for users who have enabled phone number privacy in WhatsApp.

Exemplo:

"593999999999"

​
text
string
obrigatório

Text content of the message

Exemplo:

"Hello, this is a text message"

​
botId
string

Unique identifier of the bot sending the message

Exemplo:

"BOT_ID"

Resposta

Message sent successfully

​
success
boolean
Exemplo:

true

​
messageId
string
Exemplo:

"msg_123456789"