Usar o contrato exibido na versão atual

Filas, etiquetas e motivos podem afetar classificação, roteamento ou encerramento, conforme o cadastro associado. Antes de automatizar uma mudança, abra a documentação interativa no mesmo ambiente da credencial e compare a rota e o exemplo de corpo com este guia.

Área de APIs com acesso à documentação e proteção do token
Consulte a versão atual antes de preparar o corpo e mantenha o token fora de URLs, capturas e logs.

Criar, atualizar e excluir filas

  • Criar: POST /v2/api/external/{ApiID}/createQueueData, com o exemplo name, color, greetingMessage e userId.
  • Atualizar: POST /v2/api/external/{ApiID}/updateQueueData/{id}, com o mesmo exemplo name, color, greetingMessage e userId.
  • Excluir: POST /v2/api/external/{ApiID}/deleteQueueData/{id}, com o exemplo de corpo {}.
Formulário visual de criação de uma fila de atendimento
A interface possui configurações adicionais; envie pela API somente os campos mostrados no exemplo atual da rota.
  1. 1

    Crie uma fila de homologação com nome inequívoco.

  2. 2

    Confirme na documentação interativa o formato aceito por color e a finalidade esperada de userId.

  3. 3

    Valide como greetingMessage aparece no fluxo antes de usar conteúdo real.

  4. 4

    Confira a fila na interface e registre o identificador devolvido ou confirmado pela versão.

  5. 5

    Atualize somente a fila de teste e compare o estado anterior com o novo.

  6. 6

    Exclua apenas depois de confirmar que nenhum usuário, canal, automação ou ticket depende dela.

Criar, atualizar e excluir etiquetas

  • Criar: POST /v2/api/external/{ApiID}/createTag, com o exemplo name, color e isActive.
  • Atualizar: POST /v2/api/external/{ApiID}/updateTagData/{id}, com o exemplo name, color e isActive.
  • Excluir: POST /v2/api/external/{ApiID}/deleteTag/{id}, com o exemplo de corpo {}.
Formulário visual de criação de uma etiqueta com nome, cor e estado
A tela pode mostrar recursos adicionais, como palavra-chave gatilho; eles não aparecem no exemplo atual dessas três rotas.
  1. 1

    Cadastre uma etiqueta fictícia e confirme o resultado na interface.

  2. 2

    Use exatamente name; não substitua o campo por tag.

  3. 3

    Valide o formato de color e o comportamento de isActive na versão atual.

  4. 4

    Atualize nome, cor ou estado em uma única etiqueta de teste.

  5. 5

    Antes de excluir, revise contatos, tickets, campanhas, filtros e automações que possam usar a etiqueta.

Consultar e manter motivos

  • Listar: GET /v2/api/external/{ApiID}/listReasons.
  • Criar: POST /v2/api/external/{ApiID}/createReason, com o exemplo name e color.
  • Atualizar: POST /v2/api/external/{ApiID}/updateReason/{id}, com o exemplo name e color.
  • Excluir: POST /v2/api/external/{ApiID}/deleteReason/{id}, com o exemplo de corpo {}.
Tela visual de configuração de motivos de fechamento
As rotas usam o nome genérico Reasons; confirme na versão atual a qual cadastro de motivos elas correspondem.
  1. 1

    Execute listReasons e registre internamente o formato real da resposta da versão.

  2. 2

    Compare a listagem com a tela de motivos antes de criar um registro.

  3. 3

    Crie um motivo fictício usando somente name e color no exemplo.

  4. 4

    Atualize o mesmo registro e confira novamente pela listagem e pela interface.

  5. 5

    Exclua apenas o motivo de teste e valide se ele desapareceu das duas visões.

Homologar cada alteração com segurança

  1. 1

    Guarde URL base, ApiID e credencial no consumidor autorizado, sem expor o token.

  2. 2

    Registre o estado anterior do cadastro sem copiar dados pessoais ou segredos.

  3. 3

    Envie uma única operação para um registro fictício.

  4. 4

    Confirme o resultado na interface e, quando houver uma listagem publicada, pela própria API.

  5. 5

    Depois de um update, confira todos os campos exibidos e os vínculos afetados.

  6. 6

    Após timeout, reconcilie o estado antes de repetir qualquer POST.

  7. 7

    Restrinja delete aos identificadores de homologação aprovados.

Reconhecer limites e resolver divergências

  • Campo rejeitado: compare a grafia com o exemplo atual; use name, não queue ou tag.
  • Etiqueta não muda de estado: confirme se isActive continua presente em updateTagData na versão instalada.
  • Fila incompleta: valide greetingMessage e userId no formulário interativo sem inventar tipo ou valor padrão.
  • Motivo ausente: execute listReasons e confirme se o ID pertence ao mesmo ambiente.
  • Cor ignorada: confira o formato aceito pela versão; o exemplo não publica enum nem padrão.
  • Resposta inconclusiva: não invente chaves de retorno; valide na interface.
  • Registro duplicado: procure timeouts, retentativas e consumidores concorrentes antes de criar novamente.
  • Exclusão não confirmada: reconcilie a existência e os vínculos antes de repetir o POST.