Listar etiquetas

GET /labels/list

Lista as etiquetas do WhatsApp Business da conta, como estão guardadas na api (etiquetas sem nome não aparecem). O id de cada uma é o que vai em PATCH /chats (labels), PUT /labels e no filtro label_id de GET /chats.

Se a lista estiver diferente da do celular, use POST /labels/sync.

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Respostas

{
  "200": {
    "description": "As etiquetas.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "labels"
          ],
          "properties": {
            "labels": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/OrkesioLabel"
              }
            }
          }
        },
        "example": {
          "labels": [
            {
              "id": "3",
              "name": "Cliente VIP",
              "color": 2,
              "color_hex": "#fed428"
            }
          ]
        }
      }
    }
  },
  "401": {
    "description": "Token inválido ou ausente.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "description": "`internal_error`: não deu para ler as etiquetas.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "internal_error",
          "message": "Não deu para ler as etiquetas."
        }
      }
    }
  },
  "501": {
    "$ref": "#/components/responses/CloudUnsupported"
  }
}

Estado: Disponível

Compatibilidade de canais

Eventos que esta rota gera

Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.

Antes e depois (uazapi → Orkesio)

Na uazapi: GET /labels.

• Rota própria: o GET /labels da uazapi segue igual (lista solta, id <número>:<labelid>, colorHex).
• Vem {labels: [...]}; o id é o labelid (o mesmo de labels na conversa); color_hex no lugar de colorHex; saem labelid, owner, created e updated.

#/components/schemas/OrkesioLabel

{
  "type": "object",
  "description": "Uma etiqueta do WhatsApp Business.",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "color",
    "color_hex"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Id da etiqueta no WhatsApp: o mesmo de `labels` na conversa, de `PATCH /chats` (`labels`), de `PUT /labels` e do filtro `label_id`."
    },
    "name": {
      "type": "string",
      "description": "Nome da etiqueta."
    },
    "color": {
      "type": "integer",
      "description": "Cor da etiqueta: índice de 0 a 19, o mesmo da paleta do WhatsApp.",
      "minimum": 0,
      "maximum": 19,
      "example": 2
    },
    "color_hex": {
      "type": "string",
      "description": "A cor de `color` em hexadecimal.",
      "enum": [
        "#ff9484",
        "#64c4ff",
        "#fed428",
        "#dfaef0",
        "#9ab6c1",
        "#56ccb4",
        "#fe9dfe",
        "#d3a91f",
        "#6f7bcf",
        "#d8e651",
        "#01d0e2",
        "#ffc5c7",
        "#92ceac",
        "#f64847",
        "#00a1f2",
        "#83e421",
        "#ffae04",
        "#b4ebff",
        "#9ba6ff",
        "#9568cf"
      ],
      "example": "#fed428"
    }
  },
  "example": {
    "id": "3",
    "name": "Cliente VIP",
    "color": 2,
    "color_hex": "#fed428"
  }
}

#/components/schemas/OrkesioError

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}

#/components/responses/RateLimited

{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}

#/components/responses/CloudUnsupported

{
  "description": "`unsupported_for_channel`: o canal da inbox não atende esta rota (rota só do WhatsApp Web numa inbox oficial, ou rota da API oficial numa inbox do WhatsApp Web). O canal está em `Inbox.channel`.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "unsupported_for_channel",
        "message": "Esta rota não está disponível no canal da inbox."
      }
    }
  }
}

Guias relacionados

Visão geral · O que funciona em cada canal · O que muda da uazapi