Pular para o conteúdo principal

Enviar botão OTP

Método#

/send-button-otp#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-button-otp

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Atenção

Envios de botões atualmente se encontram disponíveis, para mais detalhes acesse o tópico Funcionamento dos Botões

Conceituação#

Neste método você poderá enviar mensagens de texto com botão para copiar um valor.

image


Atributos#

Obrigatórios#

AtributosTipoDescrição
phonestringTelefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara
messagestringTexto a ser enviado
codestringValor que será copiado quando o botão for clicado

Opcionais#

AtributosTipoDescrição
imagestringURL ou Base64 da imagem que irá acompanhar o botão

Request Body#

{
"phone": "551199999999",
"message": "Texto da mensagem",
"code": "Valor a ser copiado"
}
{
"phone": "551199999999",
"message": "Texto da mensagem",
"code": "Valor a ser copiado",
"image": "URL da imagem"
}

Response#

200#

AtributosTipoDescrição
zaapIdstringid no z-api
messageIdstringid no whatsapp
idstringAdicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId

Exemplo

{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio deste tópico.

415#

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"


Webhook Response#

Link para a response do webhook (ao receber)

Webhook


Code#