Programadores

DELETE/tcr/v2/brand/{brandId}

Encerrar o registro de uma marca de mensagens

Escolha entre a limpeza coordenada pelo portal e a exclusão direta de uma marca; depois, verifique as campanhas e as atribuições de números.

Nesta página
  1. Escolha o procedimento de encerramento
  2. Analise o impacto no portal
  3. Prepare uma exclusão direta pela API
  4. Exclua a marca verificada
  5. Verifique o encerramento e concilie os resultados parciais
  6. Verifique as cobranças restantes da conta

Escolha o procedimento de encerramento

Encerre o registro de uma marca de mensagens quando a empresa não precisar mais desse registro. Isso interrompe o uso do registro existente; não registra um substituto, não libera números de telefone alugados nem corrige os dados de identificação da empresa. Para fazer uma correção, use Atualizar uma marca de mensagens.

A chamada pública DELETE para marcas e a ação Excluir marca do portal têm escopos diferentes. A chamada pública exclui uma marca do registro. O portal coordena a desvinculação dos números e a desativação das campanhas antes de tentar excluir a marca.

Opções para encerrar o registro de uma marca
ProcedimentoO que faz
Portal: Excluir marcaMostra as campanhas associadas e os números atribuídos, exige o identificador da marca como confirmação e, em seguida, tenta executar a limpeza correspondente antes de excluir a marca. As etapas anteriores podem permanecer concluídas se uma etapa posterior falhar.
API: DELETE /tcr/v2/brand/{brandId}Solicita apenas a exclusão desta marca pertencente à conta. Não desvincula números nem desativa as campanhas da marca automaticamente. Uma campanha ativa pode impedir a exclusão.

Analise o impacto no portal

Abra a página de registro de mensagens, encontre a marca correta e selecione Excluir marca. Confira as quantidades de campanhas associadas e de números atribuídos. Digite o identificador exato da marca para habilitar a ação final. O formulário do cliente só fica disponível quando a conta tem permissão para gerenciar registros.

O portal processa as campanhas ativas em sequência: tenta desvincular cada número atribuído no momento, desativa a campanha e, em seguida, exclui a marca. Ele não repete a exclusão remota de campanhas já marcadas como expiradas ou excluídas. Depois que essas etapas externas são concluídas com sucesso, atualiza os registros locais de campanhas e números em uma transação de banco de dados.

Essa sequência não constitui uma única transação atômica que abranja o registro, a operadora e os registros locais. Uma falha posterior não pode restaurar um número ou uma campanha já alterados externamente. Guarde os detalhes retornados sobre os números desvinculados e as campanhas desativadas, quando disponíveis; concilie esses identificadores em vez de criar outra marca.

Prepare uma exclusão direta pela API

Use uma conta de API habilitada, por HTTPS, a partir de um endereço IP de origem permitido. A marca deve pertencer a essa conta. Consulte e guarde seu identificador e estado atual; depois, verifique suas campanhas e atribuições de números. Desvincule os números afetados e prossiga para desativar as campanhas antes de excluir a marca. Não trate esta chamada DELETE como uma operação em cascata.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID"

Exclua a marca verificada

Execute o comando a seguir apenas para o encerramento pretendido, depois de verificar o identificador da marca e concluir a limpeza anterior. A solicitação não tem corpo JSON.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID"

O resultado de sucesso documentado é HTTP 204, sem corpo de resposta. Não exija um objeto JSON de sucesso nem o antigo envelope status/response da v3. Um resultado rejeitado que não seja 2xx não marca a marca como excluída pelo mecanismo atual de sincronização da API.

Use uma única chave de idempotência para a solicitação pretendida. Ao repeti-la, mantenha inalterados os bytes do método, do caminho, da consulta e do corpo. A chave não torna atômica toda a limpeza do portal nem comprova que um número foi desvinculado na operadora. Uma solicitação duplicada enquanto a original ainda está em andamento pode retornar 409 com Retry-After; solicitações concluídas podem retornar novamente sua resposta salva, inclusive um erro.

Verifique o encerramento e concilie os resultados parciais

Verifique as listas de marcas e campanhas do portal e os números afetados após a operação. A sincronização de sucesso da API pública marca a marca individual como excluída localmente; não remove os outros recursos de campanhas nem apaga as atribuições de números comprados. O estado no registro, a atribuição na operadora e as informações exibidas localmente exigem verificações separadas.

O adaptador atual do portal para a operadora aceita uma resposta HTTP de sucesso sem validar separadamente cada valor de estado de negócio no corpo. Por isso, verifique as atribuições reais dos números afetados às campanhas após uma limpeza pelo portal, mesmo que o portal tenha informado sucesso. Se uma atribuição ou um estado apresentar inconsistências, guarde os identificadores afetados e entre em contato com o suporte antes de enviar mensagens pela configuração encerrada ou de recriá-la.

Para HTTP 400, leia o erro detalhado do registro, especialmente se houver uma restrição por campanha ativa. Para 401, 403 ou 404, verifique as credenciais, o IP de origem permitido e se a marca pertence à conta. Para 429, respeite Retry-After. Um tempo limite excedido, um 500 ou um 502 podem ocorrer depois de uma alteração externa já concluída; examine o registro existente antes de repetir a solicitação.

Verifique as cobranças restantes da conta

O serviço DELETE atual não gera um débito imediato pelo registro da marca. Excluir uma marca não libera os números de telefone alugados, não emite reembolso nem determina o saldo final da conta. Confira no portal os compromissos vigentes das campanhas e as cobranças por aluguel de números e por uso. Esta operação não constitui um orçamento para esses serviços separados.