OrbitSenderDocs
ReferenceCanais

Listar canais

GET
/api/external/list-channels

Lista os canais do tenant com paginação. O status é sincronizado com o WhatsApp antes de responder.

Authorization

x-api-key<token>

Chave de API no formato sk_live_..., no header x-api-key.

In: header

Query Parameters

page?integer

Número da página.

Range1 <= value
Default1

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/external/list-channels"
{  "success": true,  "total": 0,  "page": 0,  "per_page": 0,  "pages": 0,  "channels": [    {      "name": "string",      "id_channel": "string",      "channel_ref": "string",      "status": "pending",      "phone": "string",      "created_at": "2019-08-24T14:15:22Z"    }  ]}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Too Many Requests",  "code": "rate_limited",  "message": "Muitas requisições. Tente novamente em instantes."}
{  "success": false,  "error": "Internal Server Error",  "message": "Erro interno ao processar a requisição."}