PicChat

Automações

Consultar automação

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

Devolve uma automação pelo ID com modelo, canal, campanha, criador e contadores. Automação excluída responde 404.

Autenticação: Bearer tokenPermissão: Automações › ver

Parâmetros de caminho

  • idstring (uuid)obrigatório

    UUID da automação.

Respostas

200OK

  • idstring (uuid)obrigatório

    ID da automação.

  • namestring | nullobrigatório

    Nome.

  • typestringobrigatório

    Tipo de envio.

    whatsapp_litewhatsappsmsemailwebhookrcs

  • statusstringobrigatório

    Status.

    pendingprocessingsendingcompletedcanceledpausederror

  • destinationstring | nullobrigatório

    Para quem envia: contato ou usuário da conta.

    contactusernull

  • fontstring | nullobrigatório

    Origem da automação.

    automationFlowinboxcontactnull

  • manualboolean | nullobrigatório

    Disparo manual (true) ou por gatilho.

  • activeboolean | nullobrigatório

    Ativa.

  • business_hourboolean | nullobrigatório

    Respeita o horário comercial.

  • create_ticketboolean | nullobrigatório

    Cria tíquete ao enviar.

  • start_atstring (date-time) | nullobrigatório

    Início programado.

  • end_atstring (date-time) | nullobrigatório

    Fim.

  • totalinteger | nullobrigatório

    Total de envios.

  • pendinginteger | nullobrigatório

    Pendentes.

  • sendinginteger | nullobrigatório

    Enviando.

  • errorinteger | nullobrigatório

    Com erro.

  • deliveredinteger | nullobrigatório

    Entregues.

  • readinteger | nullobrigatório

    Lidas.

  • repliedinteger | nullobrigatório

    Respondidas.

  • avg_seconds_to_readinteger | nullobrigatório

    Tempo médio até a leitura, em segundos.

  • avg_seconds_to_replyinteger | nullobrigatório

    Tempo médio até a resposta, em segundos.

  • metrics_synced_atstring (date-time) | nullobrigatório

    Última atualização dos contadores.

  • created_atstring (date-time)obrigatório

    Criação.

  • updated_atstring (date-time)obrigatório

    Última atualização.

  • templatesobjectobrigatório

    Modelo enviado.

  • templates.idstring (uuid)obrigatório

    ID do modelo.

  • templates.namestringobrigatório

    Nome.

  • templates.internal_namestringobrigatório

    Nome interno (o da Meta).

  • channelsobjectobrigatório

    Canal resumido.

  • channels.idstring (uuid)obrigatório

    ID do canal.

  • channels.namestringobrigatório

    Nome do canal.

  • channels.typestringobrigatório

    Tipo do canal.

    whatsappwhatsapp_litesmsemailwebhookchatinstagramrcs

  • campaignsobject | nullobrigatório

    Campanha, se houver.

  • campaigns.idstring (uuid)obrigatório

    ID.

  • campaigns.namestring | nullobrigatório

    Nome.

  • usersobjectobrigatório

    Usuário resumido (só nome).

  • users.idstring (uuid)obrigatório

    ID do usuário.

  • users.namestringobrigatório

    Nome.

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.