Enviar carrosel
#
Método#
/send-carouselPOST
https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-carousel
#
HeaderKey | Value |
---|---|
Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Atenção
Envios de botões que acompanham o carrosel atualmente se encontram disponíveis, porém possui alguns fatores decisivos para o funcionamento. Para mais detalhes acesse o tópico Funcionamento dos Botões
#
ConceituaçãoNeste método você poderá enviar mensagens de carrosel com imagens, texto e com botões de ação. A partir dos botões de ação, você conseguirá redirecionar para links, fazer chamadas, e também dar respostas padrões.
#
Atributos#
ObrigatóriosAtributos | Tipo | Descrição |
---|---|---|
phone | string | Telefone (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 |
message | string | Texto a ser enviado |
carousel | carouselCard[] | Array de objetos com cartões do carrosel |
#
carouselCardAtributos | Tipo | Descrição |
---|---|---|
text | string | Texto do cartão |
image | string | Imagem do cartão |
#
Opcionais carouselCardAtributos | Tipo | Descrição |
---|---|---|
buttons | buttonActions[] | Array de objetos do tipo buttonActions |
#
buttonActionsAtributos | Tipo | Descrição |
---|---|---|
type | string | Tipos de botão a ser enviados (CALL, URL, REPLY) |
phone | string | Número atribuído ao botão caso seja do tipo CALL |
url | string | Link atribuído ao botão caso seja do tipo URL. |
label | string | Texto para o botão |
#
Opcionais buttonActionsAtributos | Tipo | Descrição |
---|---|---|
id | string | Identificador do botão |
#
OpcionaisAtributos | Tipo | Descrição |
---|---|---|
delayMessage | number | Nesse atributo um delay é adicionado na mensagem. Você pode decidir entre um range de 1~15 sec, significa quantos segundos ele vai esperar para enviar a próxima mensagem. (Ex "delayMessage": 5, ). O delay default caso não seja informado é de 1~3 sec |
#
Request Body#
Response#
200Atributos | Tipo | Descrição |
---|---|---|
zaapId | string | id no z-api |
messageId | string | id no whatsapp |
id | string | Adicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId |
Exemplo
#
405Neste 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.
#
415Caso 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 ResponseLink para a response do webhook (ao receber)