> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Enviar Carrossel

> Envia mensagem com carrossel de cards (header, corpo, rodapé e botões)

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** não

## Descrição

Envia uma mensagem com **carrossel de cards** deslizáveis. Cada card tem `header` (título obrigatório, com mídia opcional via `imageUrl` ou `videoUrl`), `body.text` (obrigatório), `footer` opcional e até alguns botões interativos. Os botões aceitam quatro tipos: `REPLY` (padrão, retorna o ID quando clicado), `URL` (abre link), `CALL` (disca número) e `COPY` (copia código). É possível adicionar `message` (texto antes do carrossel) e `footer` (texto abaixo). Suporta `delay`, `replyTo` e `replyPrivate`.

## Exemplos

### Carrossel simples com botões REPLY

Dois cards apenas com texto e botões de resposta rápida.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/carousel/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":  "5511999999999",
      "message": "Escolha um dos planos abaixo:",
      "footer":  "Promoção válida até o fim do mês.",
      "cards": [
        {
          "header": { "title": "Plano Básico" },
          "body":   { "text": "5 instâncias, suporte por e-mail." },
          "footer": "R$ 49/mês",
          "buttons": [
            { "displayText": "Quero o Básico", "id": "plan_basic", "type": "REPLY" }
          ]
        },
        {
          "header": { "title": "Plano Pro" },
          "body":   { "text": "20 instâncias, suporte prioritário, webhooks." },
          "footer": "R$ 149/mês",
          "buttons": [
            { "displayText": "Quero o Pro", "id": "plan_pro", "type": "REPLY" }
          ]
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/carousel/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:  "5511999999999",
      message: "Escolha um dos planos abaixo:",
      footer:  "Promoção válida até o fim do mês.",
      cards: [
        {
          header: { title: "Plano Básico" },
          body:   { text: "5 instâncias, suporte por e-mail." },
          footer: "R$ 49/mês",
          buttons: [
            { displayText: "Quero o Básico", id: "plan_basic", type: "REPLY" }
          ]
        },
        {
          header: { title: "Plano Pro" },
          body:   { text: "20 instâncias, suporte prioritário, webhooks." },
          footer: "R$ 149/mês",
          buttons: [
            { displayText: "Quero o Pro", id: "plan_pro", type: "REPLY" }
          ]
        }
      ]
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/carousel/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":  "5511999999999",
          "message": "Escolha um dos planos abaixo:",
          "footer":  "Promoção válida até o fim do mês.",
          "cards": [
              {
                  "header": {"title": "Plano Básico"},
                  "body":   {"text": "5 instâncias, suporte por e-mail."},
                  "footer": "R$ 49/mês",
                  "buttons": [
                      {"displayText": "Quero o Básico", "id": "plan_basic", "type": "REPLY"}
                  ]
              },
              {
                  "header": {"title": "Plano Pro"},
                  "body":   {"text": "20 instâncias, suporte prioritário, webhooks."},
                  "footer": "R$ 149/mês",
                  "buttons": [
                      {"displayText": "Quero o Pro", "id": "plan_pro", "type": "REPLY"}
                  ]
              }
          ]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number":  "5511999999999",
          "message": "Escolha um dos planos abaixo:",
          "footer":  "Promoção válida até o fim do mês.",
          "cards": [
              {
                  "header": { "title": "Plano Básico" },
                  "body":   { "text": "5 instâncias, suporte por e-mail." },
                  "footer": "R$ 49/mês",
                  "buttons": [
                      { "displayText": "Quero o Básico", "id": "plan_basic", "type": "REPLY" }
                  ]
              },
              {
                  "header": { "title": "Plano Pro" },
                  "body":   { "text": "20 instâncias, suporte prioritário, webhooks." },
                  "footer": "R$ 149/mês",
                  "buttons": [
                      { "displayText": "Quero o Pro", "id": "plan_pro", "type": "REPLY" }
                  ]
              }
          ]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/carousel/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Carrossel com header de imagem e botões URL

`imageUrl` no header e botões do tipo `URL` (o `id` recebe a URL a abrir).

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/carousel/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":  "5511999999999",
      "message": "Conheça nossos produtos:",
      "cards": [
        {
          "header": {
            "title":    "Tênis Runner X",
            "subtitle": "Edição limitada",
            "imageUrl": "https://exemplo.com/img/runner-x.jpg"
          },
          "body":   { "text": "Amortecimento de alta performance, ideal para corridas longas." },
          "buttons": [
            { "displayText": "Ver detalhes", "id": "https://loja.exemplo.com/runner-x", "type": "URL" },
            { "displayText": "Falar com vendedor", "id": "talk_seller_runner", "type": "REPLY" }
          ]
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/carousel/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:  "5511999999999",
      message: "Conheça nossos produtos:",
      cards: [
        {
          header: {
            title:    "Tênis Runner X",
            subtitle: "Edição limitada",
            imageUrl: "https://exemplo.com/img/runner-x.jpg"
          },
          body:   { text: "Amortecimento de alta performance, ideal para corridas longas." },
          buttons: [
            { displayText: "Ver detalhes",        id: "https://loja.exemplo.com/runner-x", type: "URL" },
            { displayText: "Falar com vendedor", id: "talk_seller_runner",                type: "REPLY" }
          ]
        }
      ]
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/carousel/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":  "5511999999999",
          "message": "Conheça nossos produtos:",
          "cards": [
              {
                  "header": {
                      "title":    "Tênis Runner X",
                      "subtitle": "Edição limitada",
                      "imageUrl": "https://exemplo.com/img/runner-x.jpg"
                  },
                  "body": {"text": "Amortecimento de alta performance, ideal para corridas longas."},
                  "buttons": [
                      {"displayText": "Ver detalhes",        "id": "https://loja.exemplo.com/runner-x", "type": "URL"},
                      {"displayText": "Falar com vendedor", "id": "talk_seller_runner",                "type": "REPLY"}
                  ]
              }
          ]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number":  "5511999999999",
          "message": "Conheça nossos produtos:",
          "cards": [
              {
                  "header": {
                      "title":    "Tênis Runner X",
                      "subtitle": "Edição limitada",
                      "imageUrl": "https://exemplo.com/img/runner-x.jpg"
                  },
                  "body":   { "text": "Amortecimento de alta performance, ideal para corridas longas." },
                  "buttons": [
                      { "displayText": "Ver detalhes",        "id": "https://loja.exemplo.com/runner-x", "type": "URL" },
                      { "displayText": "Falar com vendedor", "id": "talk_seller_runner",                "type": "REPLY" }
                  ]
              }
          ]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/carousel/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Carrossel com header de vídeo

`videoUrl` substitui `imageUrl` no header. Use um dos dois, não os dois.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/carousel/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number": "5511999999999",
      "cards": [
        {
          "header": {
            "title":    "Tutorial: como ativar",
            "videoUrl": "https://exemplo.com/videos/onboarding.mp4"
          },
          "body":   { "text": "Veja em 30 segundos como configurar sua primeira instância." },
          "buttons": [
            { "displayText": "Começar agora", "id": "start_onboarding", "type": "REPLY" },
            { "displayText": "Ligar para suporte", "id": "+551130000000", "type": "CALL" },
            { "displayText": "Copiar cupom", "id": "RYZE10", "type": "COPY" }
          ]
        }
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/carousel/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number: "5511999999999",
      cards: [
        {
          header: {
            title:    "Tutorial: como ativar",
            videoUrl: "https://exemplo.com/videos/onboarding.mp4"
          },
          body:   { text: "Veja em 30 segundos como configurar sua primeira instância." },
          buttons: [
            { displayText: "Começar agora",       id: "start_onboarding", type: "REPLY" },
            { displayText: "Ligar para suporte", id: "+551130000000",    type: "CALL"  },
            { displayText: "Copiar cupom",       id: "RYZE10",           type: "COPY"  }
          ]
        }
      ]
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/carousel/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number": "5511999999999",
          "cards": [
              {
                  "header": {
                      "title":    "Tutorial: como ativar",
                      "videoUrl": "https://exemplo.com/videos/onboarding.mp4"
                  },
                  "body": {"text": "Veja em 30 segundos como configurar sua primeira instância."},
                  "buttons": [
                      {"displayText": "Começar agora",       "id": "start_onboarding", "type": "REPLY"},
                      {"displayText": "Ligar para suporte", "id": "+551130000000",    "type": "CALL"},
                      {"displayText": "Copiar cupom",       "id": "RYZE10",           "type": "COPY"}
                  ]
              }
          ]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number": "5511999999999",
          "cards": [
              {
                  "header": {
                      "title":    "Tutorial: como ativar",
                      "videoUrl": "https://exemplo.com/videos/onboarding.mp4"
                  },
                  "body":   { "text": "Veja em 30 segundos como configurar sua primeira instância." },
                  "buttons": [
                      { "displayText": "Começar agora",       "id": "start_onboarding", "type": "REPLY" },
                      { "displayText": "Ligar para suporte", "id": "+551130000000",    "type": "CALL"  },
                      { "displayText": "Copiar cupom",       "id": "RYZE10",           "type": "COPY"  }
                  ]
              }
          ]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/carousel/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

O `messageType` retornado é `interactive` (carrossel é uma variação de mensagem interativa do WhatsApp), e o `content` traz uma descrição agregada (`"<message> - Carousel with N card(s)"`) usada pelo histórico. Os cards individuais não vêm na resposta, guarde o `messageId` para correlacionar com cliques via webhook.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Carousel sent successfully",
  "status":  "sent",
  "data": {
    "messageId":   "3EB08FCF27E532F1E4E4",
    "direction":   "sent",
    "messageType": "interactive",
    "content":     "Escolha um dos planos abaixo: - Carousel with 3 card(s)",
    "source":      "api",
    "timestamp":   "2026-04-30T14:30:00Z",
    "chat": {
      "jid":     "5511999999999@s.whatsapp.net",
      "isGroup": false
    },
    "sender": {
      "jid":      "5511777777777@s.whatsapp.net",
      "instance": "minha-instancia"
    }
  }
}
```

<Note>
  Quando o usuário toca em um botão `REPLY`, a resposta chega como mensagem de texto contendo o `id` do botão clicado, capture isso pelo webhook para encadear o fluxo.
</Note>

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância (ex.: `$Instance_Name`).
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Request body

<ParamField body="number" type="string" required>
  Destino: telefone (`5511999999999`) ou JID (`@s.whatsapp.net`, `@lid`, `@g.us`, `@newsletter`).
</ParamField>

<ParamField body="message" type="string">
  Texto exibido **acima** do carrossel (opcional).
</ParamField>

<ParamField body="footer" type="string">
  Texto exibido **abaixo** do carrossel (opcional).
</ParamField>

<ParamField body="cards" type="CarouselCard[]" required>
  Lista de cards do carrossel. **Mínimo 1**. Cada card é um objeto com `header`, `body`, `footer` e `buttons` (descritos abaixo).
</ParamField>

<ParamField body="cards[].header" type="object" required>
  Header do card. Sub-campos:

  * `title` (string, **obrigatório**), título do card.
  * `subtitle` (string), subtítulo opcional.
  * `imageUrl` (string), URL de imagem para o header.
  * `videoUrl` (string), URL de vídeo para o header. Use **uma das duas** mídias por card.
</ParamField>

<ParamField body="cards[].body" type="object" required>
  Corpo do card. Sub-campo:

  * `text` (string, **obrigatório**), conteúdo textual do card.
</ParamField>

<ParamField body="cards[].footer" type="string">
  Texto opcional exibido no rodapé do card individual.
</ParamField>

<ParamField body="cards[].buttons" type="CarouselButton[]">
  Lista de botões do card. Cada botão tem:

  * `displayText` (string, **obrigatório**), texto visível.
  * `id` (string, **obrigatório**), semântica varia conforme `type`: para `REPLY`, é o ID retornado quando clicado; para `URL`, a URL a abrir; para `CALL`, o número a discar; para `COPY`, o código a copiar.
  * `type` (string), `REPLY` (padrão), `URL`, `CALL` ou `COPY`. Valores diferentes retornam `400 Card N, Button M: Type must be one of: REPLY, URL, CALL, COPY`.
</ParamField>

<ParamField body="delay" type="int" default="0">
  Tempo em **segundos** para aguardar antes de enviar. Durante o intervalo, o servidor envia o indicador de "digitando..." e dispara o "paused" antes do envio real.
</ParamField>

<ParamField body="replyTo" type="string">
  ID da mensagem a ser citada (reply). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco.
</ParamField>

<ParamField body="replyPrivate" type="boolean" default="false">
  Quando `true` **e** `replyTo` aponta para uma mensagem originária de um grupo, o carrossel é redirecionado para o **privado** do autor original (mantendo a citação).
</ParamField>

<ParamField body="source" type="string" default="api">
  Identificador de origem para rastreabilidade (ex.: `crm`, `bot-suporte`, `n8n`). Salvo no registro da mensagem e propagado para webhooks.
</ParamField>

## Notas

<Note>
  * **`delay` é em segundos** (não milissegundos).
  * Em cada `header`, escolha **uma única** mídia: ou `imageUrl` ou `videoUrl`. Enviar ambas pode resultar em renderização inconsistente no cliente.
  * Validação do servidor: cada card precisa de `header.title` e `body.text` não vazios; cada botão precisa de `displayText` e `id` não vazios. Erros são retornados com o índice (`Card N, Button M: ...`) para facilitar debug.
  * Aparelhos antigos do WhatsApp podem cair em fallback de texto e exibir o carrossel como mensagem comum.
  * Para botões `URL`, garanta que o link comece com `https://` para evitar ser bloqueado pelo cliente.
</Note>

## Erros

| HTTP | Status interno          | Mensagem                                                        |
| ---- | ----------------------- | --------------------------------------------------------------- |
| 400  | ,                       | `Instance name is required`                                     |
| 400  | ,                       | `Invalid request body: <detalhe>`                               |
| 400  | ,                       | `Number is required`                                            |
| 400  | ,                       | `At least one card is required`                                 |
| 400  | ,                       | `Card N: Header title is required`                              |
| 400  | ,                       | `Card N: Body text is required`                                 |
| 400  | ,                       | `Card N, Button M: Display text is required`                    |
| 400  | ,                       | `Card N, Button M: ID is required`                              |
| 400  | ,                       | `Card N, Button M: Type must be one of: REPLY, URL, CALL, COPY` |
| 400  | `invalid_number`        | `Invalid phone number format: <detalhe>`                        |
| 400  | `media_download_failed` | (motivo do download de mídia do header falhar)                  |
| 404  | ,                       | `Instance not found`                                            |
| 500  | `media_upload_failed`   | (motivo do upload de mídia do header falhar)                    |
| 500  | `send_failed`           | `Failed to send carousel: <reason>`                             |
| 503  | `disconnected`          | `Instance is not connected to WhatsApp`                         |

Envelope de erro:

```json theme={null}
{
  "success": false,
  "error": { "message": "Card 1: Header title is required" }
}
```