Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-carousel
Enviar carrossel
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-carousel \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "message": "<string>",
  "carousel": [
    {
      "text": "<string>",
      "image": "<string>",
      "buttons": [
        {
          "id": "<string>",
          "label": "<string>",
          "type": "<string>",
          "url": "<string>",
          "phone": "<string>"
        }
      ]
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Neste método você poderá enviar mensagens de carrossel 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.

​
Exemplo no WhatsApp

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
phone
string
obrigatório
Telefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO. Ex: 551199999999
​
message
string
obrigatório
Texto da mensagem
​
carousel
array
obrigatório
Array de cartões do carrossel

​
Opcionais

​
delayMessage
number
Delay adicionado na mensagem. Você pode decidir entre um range de 1 a 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 a 3 sec

​
Request Body

{
  "phone": "551199999999",
  "message": "Texto da mensagem",
  "carousel": [
    {
      "text": "Texto do cartão",
      "image": "https://firebasestorage.googleapis.com/v0/b/zaap-messenger-web.appspot.com/o/logo.png?alt=media",
      "buttons": [
        {
          "id": "1",
          "label": "Nome do botão",
          "url": "https://z-api.io",
          "type": "URL"
        },
        {
          "id": "2",
          "label": "Nome do botão",
          "type": "REPLY"
        }
      ]
    },
    {
      "text": "Texto do cartão",
      "image": "https://firebasestorage.googleapis.com/v0/b/zaap-messenger-web.appspot.com/o/logo.png?alt=media",
      "buttons": [
        {
          "id": "1",
          "label": "Nome do botão",
          "url": "https://z-api.io",
          "type": "URL"
        },
        {
          "id": "2",
          "label": "Nome do botão",
          "type": "REPLY"
        }
      ]
    }
  ]
}

​
Response

​
200

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

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início 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”.