PicChat

Campanhas

Consultar campanha

GEThttps://api.picchat.com.br/v1/campaigns/{id}

Devolve uma campanha pelo ID com suas automações e totais. Campanha excluída responde 404.

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

Parâmetros de caminho

  • idstring (uuid)obrigatório

    UUID da campanha.

Respostas

200OK

  • idstring (uuid)obrigatório

    ID da campanha.

  • namestringobrigatório

    Nome.

  • statusstringobrigatório

    Status da campanha (ex.: active).

  • defaultboolean | nullobrigatório

    Campanha padrão da conta.

  • created_atstring (date-time)obrigatório

    Criação.

  • updated_atstring (date-time)obrigatório

    Última atualização.

  • usersobject | nullobrigatório

    Quem criou.

  • users.idstring (uuid)obrigatório

    ID do usuário.

  • users.namestringobrigatório

    Nome.

  • automationsarray<CampaignAutomation>obrigatório

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

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

    ID da automação.

  • automations[].namestring | nullobrigatório

    Nome.

  • automations[].typestringobrigatório

    Tipo de envio.

    whatsapp_litewhatsappsmsemailwebhookrcs

  • automations[].statusstringobrigatório

    Status.

    pendingprocessingsendingcompletedcanceledpausederror

  • automations[].totalinteger | nullobrigatório

    Total de envios.

  • automations[].deliveredinteger | nullobrigatório

    Entregues.

  • automations[].readinteger | nullobrigatório

    Lidas.

  • automations[].repliedinteger | nullobrigatório

    Respondidas.

  • automations[].errorinteger | nullobrigatório

    Com erro.

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

    Início programado.

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.

404Registro não existe, é de outra conta, foi excluído ou está fora do escopo de canais do usuário.

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