SendTemplateButtons#
Temporariamente indisponível. Não está sendo exibido no telefone do destinatário.
Esse método é utilizado para enviar mensagens com botões interativos de uma lista de modelos para um chat pessoal ou em grupo. A mensagem será adicionada à fila de envio. A mensagem na fila será armazenada por 24 horas e será enviada imediatamente após a autorização do telefone. A velocidade de envio das mensagens na fila é regulada pelo parâmetro Intervalo de Envio de Mensagens.
Requisição#
Para enviar a mensagem, é necessário fazer uma solicitação para o seguinte endereço:
POST https://api.green-api.com/waInstance{{idInstance}}/sendTemplateButtons/{{apiTokenInstance}}
Para obter os parâmetros de solicitação idInstance
e apiTokenInstance
, consulte a seção Antes de começar.
Recursos ao trabalhar com botões#
- Os botões de link são compatíveis com os botões numéricos, mas não são compatíveis com os botões de resposta;
- Os botões com número de telefone são compatíveis com os botões de link, mas não são compatíveis com os botões de resposta;
- Os botões de resposta rápida não são compatíveis com os botões numéricos e botões de link.
Parâmetros de solicitação#
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
chatId | string | Sim | ID do chat |
message | string | Sim | Texto da mensagem. Emojis são suportados 😃 |
footer | string | Não | Rodapé da mensagem. Útil para destacar visualmente o texto relacionado aos botões |
templateButtons | array | Sim | Botões interativos da mensagem |
quotedMessageId | string | Não | ID da mensagem a ser citada. Se fornecido, a mensagem será enviada com citação da mensagem especificada no chat |
archiveChat | boolean | Não | Arquiva o chat para o qual a mensagem é enviada. Aceita os valores: true |
Campos do array templateButtons
Parâmetro | Tipo | Descrição |
---|---|---|
index | integer | Identificador do botão |
urlButton | object | Botão com link |
callButton | object | Botão de chamada |
quickReplyButton | object | Botão de resposta rápida |
Campos do objeto urlButton
Parâmetro | Tipo | Descrição |
---|---|---|
displayText | string | Texto do link |
url | string | Link da web |
Campos do objeto callButton
Parâmetro | Tipo | Descrição |
---|---|---|
displayText | string | Texto do link |
phoneNumber | string | Número de telefone |
Campos do objeto quickReplyButton
Parâmetro | Tipo | Descrição |
---|---|---|
displayText | string | Texto no botão |
id | string | Identificador do botão |
O comprimento máximo de uma mensagem de texto é 4096 caracteres
Exemplo de corpo de solicitação para envio de mensagem em um chat pessoal:
{
"chatId": "11001234567@c.us",
"message": "Olá",
"footer": "Que tipo de ação você vai escolher?",
"templateButtons": [
{"index": 1, "urlButton": {"displayText": "⭐ Avalie-nos no GitHub!", "url": "https://github.com/green-api/docs"}},
{"index": 2, "callButton": {"displayText": "Ligue para nós", "phoneNumber": "+1 (234) 5678-901"}},
{"index": 3, "quickReplyButton": {"displayText": "Botão simples", "id": "plainButtonId"}}
]
}
Resposta#
Parâmetros de Resposta#
Campo | Tipo | Descrição |
---|---|---|
idMessage | string | Identificador da mensagem enviada |
Exemplo de Corpo da Resposta#
{
"idMessage": "3EB0C767D097B7C7C030"
}
Exemplo de Visualização para o Receptor#
Botão de Chamada de Volta
Botão de Link
Botão de Resposta Rápida
Erros em SendTemplateButtons#
Consulte os erros comuns a todos os métodos em Erros Comuns
Possíveis Erros
Ao usar o método SendTemplateButtons, as mensagens podem não ser exibidas na versão web, desktop e móvel do aplicativo. A capacidade de enviar mensagens com botões é implementada por nós de forma de baixo nível. O cliente oficial do WhatsApp Web não oferece a funcionalidade de envio de botões. Em grande parte, a estabilidade do método SendTemplateButtons não depende de nós, pois o WhatsApp está sempre fazendo alterações em sua funcionalidade.
Recomendamos sempre duplicar os botões com mensagens normais.
Por exemplo, use números para determinar a escolha.
Escolha uma ação:
1 - ação 1
2 - ação 2
3 - ação 3
Exemplo de curl#
curl --location --request POST 'https://api.green-api.com/waInstance{{idInstance}}/SendTemplateButtons/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"chatId": "11001234567@c.us",
"message": "Olá",
"footer": "Que tipo de ação você escolherá?",
"templateButtons": [
{"index": 1, "urlButton": {"displayText": "⭐ Avalie-nos no GitHub!", "url": "https://github.com/green-api/docs"}},
{"index": 2, "callButton": {"displayText": "Ligue para nós", "phoneNumber": "+55 21 988800001"}},
{"index": 3, "quickReplyButton": {"displayText": "Botão simples", "id": "plainButtonId"}}
]
}'