PicChat

Conta

Consultar a conta do token

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

Devolve a conta dona do token com plano, saldos de créditos e totais de canais e usuários. O campo access diz quem é o usuário por trás do token, seus grupos e permissões, o escopo de canais e, em routes, quais consultas do /v1 ele pode fazer. Não exige permissão: serve para descobrir o que o token alcança antes de chamar as outras rotas.

Autenticação: Bearer tokenPermissão: Nenhuma (qualquer token válido da conta)

Respostas

200OK

  • idstring (uuid)obrigatório

    ID da conta.

  • namestringobrigatório

    Nome da conta.

  • subdomainstringobrigatório

    Subdomínio.

  • account_typestringobrigatório

    STANDARD ou INFRA (INFRA não usa /v1).

    STANDARDINFRA

  • activeboolean | nullobrigatório

    Conta ativa.

  • payment_statusstringobrigatório

    Situação de pagamento.

    pendingpaidoverdue

  • creditsintegerobrigatório

    Saldo de créditos do plano.

  • whatsapp_official_creditsintegerobrigatório

    Créditos bônus de WhatsApp oficial.

  • whatsapp_lite_creditsintegerobrigatório

    Créditos bônus de WhatsApp Lite.

  • sms_creditsintegerobrigatório

    Créditos bônus de SMS.

  • email_creditsintegerobrigatório

    Créditos bônus de e-mail.

  • credit_renewal_datestring (date-time) | nullobrigatório

    Próxima renovação dos créditos do plano.

  • created_atstring (date-time)obrigatório

    Criação.

  • planobject | nullobrigatório

    Plano atual.

  • plan.idstring (uuid)obrigatório

    ID do plano.

  • plan.namestringobrigatório

    Nome do plano.

  • plan.plan_groupstring | nullobrigatório

    Grupo do plano.

  • channels_countintegerobrigatório

    Canais não excluídos.

  • users_countintegerobrigatório

    Usuários de origem não excluídos.

  • accessobjectobrigatório

    Quem é o usuário do token e o que ele pode consultar.

  • access.enforcedbooleanobrigatório

    Se as permissões estão sendo aplicadas a este token. false = modo observe (token de integração da conta durante a transição): nada é negado, só registrado.

  • access.viastring | nullobrigatório

    Como o usuário foi identificado: JWT de sessão, token de integração ou token pessoal. null = token sem usuário ativo.

    sessionintegrationpersonalnull

  • access.userobject | nullobrigatório

    Usuário por trás do token.

  • access.user.idstring (uuid)obrigatório

    ID do usuário.

  • access.user.namestringobrigatório

    Nome completo.

  • access.user.emailstring | nullobrigatório

    E-mail.

  • access.adminbooleanobrigatório

    Usuário sem grupo de permissão na conta de origem = administrador (vê tudo).

  • access.permission_groupsarray<string>obrigatório

    Nomes dos grupos de permissão do usuário nesta conta.

  • access.permissionsarray<string>obrigatório

    Permissões `recurso:ação` (ex.: `inbox:read`). Admin recebe `["*"]`.

  • access.channel_scopestring | array<ChannelRefShort>obrigatório

    `"all"` ou a lista de canais a que o usuário está restrito (tíquetes, mensagens e notas só desses canais).

  • access.routesobjectobrigatório

    Por chave de rota (me, tickets, messages, notes, ticket-status, contacts, contact-tickets, lists, list-contacts, properties, tags, campaigns, automations, channels, templates, users, assistants, knowledge-bases): se o usuário pode consultá-la.

403Acesso negado: `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.