OrbitSenderDocs
ReferenceSegmentos

Listar grupos do canal

GET
/api/external/list-groups/{id_channel}

Lista os grupos de WhatsApp de um canal conectado.

Authorization

x-api-key<token>

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

In: header

Path Parameters

id_channel*string

Token do canal (ex.- channel_<uuid>).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/external/list-groups/string"
{  "success": true,  "id_channel": "string",  "total_groups": 0,  "groups": [    {      "id_group": "120363021234567890@g.us",      "name": "Grupo Vendas"    }  ],  "timestamp": "2019-08-24T14:15:22Z"}
{  "success": false,  "error": "Bad Request",  "message": "O campo \"name\" é obrigatório no body da requisição."}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Not Found",  "message": "Segmento não encontrado."}
{  "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."}
{  "success": false,  "error": "Service Unavailable",  "message": "Não foi possível consultar os grupos. Tente novamente em instantes."}