Distinguir canal, sessão e identificador

Um canal representa a conexão usada no atendimento; a sessão mantém o estado técnico dessa conexão. As rotas publicadas exigem number, id ou whatsappId com nomes e tipos distintos. Não troque um identificador por outro sem confirmar o valor esperado na própria operação.

Tela de configuração de sessões e canais no Atendeu Rápido
Use a interface para confirmar nome, tipo e estado da sessão antes e depois de uma alteração pela API.

Consultar antes de alterar

  • GET /v2/api/external/{ApiID}/getAllSessionApis executa a consulta publicada com esse nome; como não há descrição nem schema de resposta, inspecione o retorno da versão antes de definir sua finalidade.
  • GET /v2/api/external/{ApiID}/listChannels lista os canais.
  • GET /v2/api/external/{ApiID}/listSessions lista as sessões.
  • POST /v2/api/external/{ApiID}/showChannel recebe number como string.
  • POST /v2/api/external/{ApiID}/showChannelById recebe id como número.
  1. 1

    Liste canais e sessões usando a mesma URL base, ApiID e credencial.

  2. 2

    Restrinja a seleção ao registro de homologação.

  3. 3

    Compare número, ID, nome, tipo e estado com a interface.

  4. 4

    Guarde somente os identificadores necessários e remova dados sensíveis do log.

Executar o ciclo da sessão

  • POST .../createtSession publica name, status e type como strings. A grafia da rota é exatamente createtSession.
  • POST .../startSession recebe whatsappId como número.
  • POST .../requestNewQrCodeSession recebe whatsappId como número e solicita um novo código.
  • POST .../qrCodeSession recebe whatsappId como número e consulta o código da sessão.
  • POST .../deleteSession recebe whatsappId como número e remove a sessão.
  1. 1

    Valide no ambiente de homologação quais valores de status e type são aceitos pela versão atual.

  2. 2

    Crie apenas uma sessão de teste e reliste para confirmar o identificador exigido pelas rotas de sessão no retorno da versão atual.

  3. 3

    Inicie a sessão, solicite um novo QR Code e faça a leitura sem guardar a imagem.

  4. 4

    Reliste e confirme a conexão também na interface antes de liberar o canal para testes.

  5. 5

    Se houver timeout, consulte novamente antes de repetir qualquer POST.

Opções de tipos de canal disponíveis para criação de uma conexão
O tipo precisa corresponder à tecnologia do canal; não invente um valor de type com base apenas no rótulo visual.

Excluir somente com dependências revisadas

  1. 1

    Confirme o whatsappId pela listagem mais recente.

  2. 2

    Interrompa novos envios e documente as dependências.

  3. 3

    Faça a exclusão apenas dentro da janela aprovada.

  4. 4

    Reliste sessões e canais e confira a interface.

  5. 5

    Se o retorno for inconclusivo, não repita a exclusão até reconciliar o estado.

Resolver falhas comuns

  • Criação recusada: confira a grafia createtSession e valide status e type no formulário interativo atual.
  • Lista vazia: confirme que URL base, ApiID e token pertencem ao mesmo ambiente.
  • QR indisponível: reutilize o whatsappId correto, solicite um código novo e descarte códigos expirados.
  • Sessão duplicada: pare as retentativas e pesquise por nome, número e tipo antes de criar novamente.
  • Resposta 200 sem conexão: valide o estado na listagem e na interface.