PicChat

Campanhas

Listar campanhas

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

Lista as campanhas da conta (excluídas ficam de fora), ordenadas por created_at. Cada campanha traz suas automações com os totais de envio, entrega, leitura, resposta e erro.

Autenticação: Bearer tokenPermissão: Campanhas › ver

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.

  • statusstring

    Status da campanha (igualdade exata, ex.: `active`).

  • searchstring

    Busca parcial no nome, sem diferenciar maiúsculas.

  • orderstringpadrão "desc"

    Direção da ordenação por `created_at`. Qualquer outro valor usa o padrão.

Respostas

200OK

  • itemsarray<Campaign>obrigatório

    Registros da página.

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

    ID da campanha.

  • items[].namestringobrigatório

    Nome.

  • items[].statusstringobrigatório

    Status da campanha (ex.: active).

  • items[].defaultboolean | nullobrigatório

    Campanha padrão da conta.

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

    Criação.

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

    Última atualização.

  • items[].usersobject | nullobrigatório

    Quem criou.

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

    ID do usuário.

  • items[].users.namestringobrigatório

    Nome.

  • items[].automationsarray<CampaignAutomation>obrigatório

    Automações da campanha (excluídas ficam de fora).

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

    ID da automação.

  • items[].automations[].namestring | nullobrigatório

    Nome.

  • items[].automations[].typestringobrigatório

    Tipo de envio.

    whatsapp_litewhatsappsmsemailwebhookrcs

  • items[].automations[].statusstringobrigatório

    Status.

    pendingprocessingsendingcompletedcanceledpausederror

  • items[].automations[].totalinteger | nullobrigatório

    Total de envios.

  • items[].automations[].deliveredinteger | nullobrigatório

    Entregues.

  • items[].automations[].readinteger | nullobrigatório

    Lidas.

  • items[].automations[].repliedinteger | nullobrigatório

    Respondidas.

  • items[].automations[].errorinteger | nullobrigatório

    Com erro.

  • items[].automations[].start_atstring (date-time) | nullobrigatório

    Início programado.

  • 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.