PicChat

Canais

Listar canais

GEThttps://api.picchat.com.br/v1/channels

Lista os canais da conta (excluídos ficam de fora) em ordem alfabética, sem nenhum token de acesso. Quem tem Canais › ver vê todos; quem só tem Inbox › ver vê apenas os canais a que está vinculado. Não aceita order.

Autenticação: Bearer tokenPermissão: Canais › ver ou Inbox › ver (só Inbox › ver: apenas os canais do usuário)

Parâmetros de consulta (query)

  • pageintegerpadrão 1

    Página, começando em 1. Valor ausente, inválido ou menor que 1 vira 1.

  • limitintegerpadrão 20

    Itens por página. Padrão 20, máximo 100: acima disso é reduzido para 100 sem erro; valor inválido ou menor que 1 vira 20.

  • typestring

    Tipo do canal.

  • statusstring

    Status da conexão (igualdade exata, ex.: `active`, `inactive`).

Respostas

200OK

  • itemsarray<Channel>obrigatório

    Registros da página.

  • items[].idstring (uuid)obrigatório

    ID do canal.

  • items[].namestringobrigatório

    Nome.

  • items[].typestringobrigatório

    Tipo do canal.

    whatsappwhatsapp_litesmsemailwebhookchatinstagramrcs

  • items[].statusstringobrigatório

    Status da conexão (ex.: active, inactive).

  • items[].providerstring | nullobrigatório

    Provedor da conexão.

  • items[].platform_typestring | nullobrigatório

    Plataforma de origem informada pela Meta.

  • items[].display_phone_numberstring | nullobrigatório

    Número exibido (WhatsApp).

  • items[].verified_namestring | nullobrigatório

    Nome verificado na Meta.

  • items[].number_idstring | nullobrigatório

    Phone number ID na Meta.

  • items[].wabastring | nullobrigatório

    ID da conta WhatsApp Business (WABA).

  • items[].quality_ratingstring | nullobrigatório

    Qualidade do número na Meta (GREEN, YELLOW, RED...).

  • items[].instagram_usernamestring | nullobrigatório

    Usuário do Instagram (canais instagram).

  • items[].isBOTboolean | nullobrigatório

    Canal atendido por bot.

  • items[].auto_taggingboolean | nullobrigatório

    Classificação automática de tags pela IA.

  • items[].auto_npsboolean | nullobrigatório

    NPS automático pela IA.

  • items[].auto_summaryboolean | nullobrigatório

    Resumo automático de tíquetes.

  • items[].timezonestring | nullobrigatório

    Fuso horário do canal (IANA).

  • items[].max_first_response_timeinteger | nullobrigatório

    SLA de primeira resposta, em minutos.

  • items[].max_resolution_timeinteger | nullobrigatório

    SLA de resolução, em minutos.

  • items[].work_all_timeboolean | nullobrigatório

    Atende 24 h (ignora horário comercial).

  • items[].created_atstring (date-time)obrigatório

    Criação.

  • totalintegerobrigatório

    Total de registros que casam com os filtros (todas as páginas).

  • pageintegerobrigatório

    Página devolvida (começa em 1).

  • limitintegerobrigatório

    Itens por página efetivamente usados (1–100).

  • pagesintegerobrigatório

    Total de páginas: `max(1, ceil(total / limit))`. Nunca é 0, mesmo sem resultados.

403Acesso negado: usuário do token sem a permissão da rota (`permission_denied`) ou token não ligado a um usuário ativo (`token_without_user`) — para token de integração da conta isso só é aplicado quando `access.enforced` é true (veja GET /v1/me); token pessoal e JWT de sessão são sempre verificados; `account_id` na query diferente da conta do token; conta do tipo INFRA.

498Token ausente, inválido, de outra finalidade (ex.: token do canal chat) ou revogado. Note o status não padrão 498.