Selecione uma marca existente na sua conta
Comece com o ID de marca do registro que já está associado à sua conta MultiTEL. Esta consulta não cria uma marca nem vincula a marca de outra pessoa à sua conta. O fluxo atual do cliente verifica a titularidade antes de solicitar os casos de uso para os quais a marca é elegível. Se a consulta retornar 404, verifique a conta e a marca selecionadas em vez de substituir o identificador pelo ID de uma linha local.
Monte as opções de casos de uso a partir deste resultado
O catálogo geral de casos de uso descreve as opções do registro. Esta consulta específica da marca fornece as opções para a marca selecionada. Preserve cada valor de usecase retornado e combine-o com o rótulo de exibição e a descrição do catálogo. Não ofereça todas as entradas do catálogo geral como se a marca fosse elegível para cada uma delas.
O portal espera que esta resposta seja uma lista JSON. Se ela estiver ausente, tiver formato inválido ou for um erro, preserve o formulário do cliente e informe que não foi possível carregar os casos de uso para os quais a marca é elegível. Não interprete isso silenciosamente como aprovação para um caso de uso padrão. O registro pode retornar campos além dos apresentados no exemplo abreviado.
Carregue os requisitos do caso de uso selecionado
Depois que o cliente escolher um dos valores de caso de uso retornados, solicite /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} para a mesma marca. Essa resposta fornece os limites dos subcasos de uso e os requisitos específicos de cada operadora. Use-a para coletar exemplos de mensagens, consentimento e outras declarações obrigatórias. A lista de casos de uso para os quais a marca é elegível, por si só, não basta para preparar um cadastro de campanha completo.
Revise os preços da conta separadamente
Os campos do provedor, como monthlyFee, quarterlyFee ou annualFee, quando retornados, descrevem metadados das tarifas do provedor. Eles não substituem o preço da conta do cliente nem os termos de cadastro. O portal atual consulta os preços de varejo das campanhas separadamente e os combina com os dados de elegibilidade na tela de revisão. Não deduza uma cobrança ao cliente a partir dos preços fixados no código da antiga função auxiliar de enumerações.
Atualize os dados quando a marca ou o caso de uso mudar
Ao trocar de marca, descarte as opções da marca anterior e carregue os casos de uso para os quais a nova seleção é elegível. Atualize os requisitos do caso de uso selecionado antes do envio. Estas solicitações GET não enviam um cadastro, não ativam uma campanha nem atribuem números.
Solicitação
Use uma conta API habilitada por HTTPS, a partir de um endereço IP de origem permitido. A rota atual aceita a política de autenticação de contas, incluindo a autenticação Basic e contas API habilitadas com autenticação por token de portador. Não use as credenciais do provedor.
GET com o identificador da marca no caminho da URL. Não é necessário um corpo de solicitação.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
brand_id | cadeia de caracteres | Sim | O ID de marca do registro associado à sua conta MultiTEL autenticada. Use o ID da marca, não o ID de uma linha do banco de dados local, o ID de uma campanha nem o número de identificação fiscal da empresa. Codifique-o como um único segmento de caminho da URL. |
Resposta
A rota atual do TCR retorna diretamente o corpo JSON do registro e preserva seu status HTTP. Ela não adiciona o envelope status/response da versão legada v3. O exemplo fictício abreviado não é o resultado de uma consulta real de elegibilidade. Verifique o status HTTP e a estrutura JSON esperada antes de usá-lo. O portal atual espera uma lista de registros de elegibilidade, cada um identificando um usecase. Ele combina esses registros com o catálogo de usecase para obter os rótulos de exibição e consulta os preços de varejo separadamente. Campos adicionais do provedor podem estar presentes.
Estrutura de resposta ilustrativa; não contém dados reais de uma conta nem constitui uma cotação vigente.
[
{
"usecase": "2FA"
}
]Erros
- 401: Falha na autenticação da conta. Verifique as credenciais da API, se a conta está habilitada e as restrições aplicáveis ao IP de origem.
- 404: A marca não está associada à conta autenticada, ou o provedor não consegue encontrar a marca ou a seleção solicitada. Se a verificação local de titularidade negar o acesso, essa negativa será retornada antes de enviar uma solicitação ao provedor.
- Outros erros do registro: o status HTTP e o corpo da resposta do serviço externo são preservados. Um caso de uso inválido ou indisponível não equivale a uma resposta bem-sucedida com um conjunto vazio de requisitos.
- 429: O limite de solicitações da conta ou o limite compartilhado do provedor foi atingido. Respeite Retry-After.
- 502/503: Falha de transporte ou de disponibilidade do provedor ou do limitador de solicitações. Preserve o formulário e tente novamente com intervalos de espera crescentes.
Disponibilidade e efeitos colaterais
- A solicitação GET revisada verifica a titularidade da marca existente, entra em contato com o registro e grava registros de auditoria das solicitações. Ela não cria uma marca nem uma campanha e não cobra uma tarifa de cadastro.
- Os metadados das tarifas do provedor não constituem uma cotação de preço de varejo para o cliente MultiTEL. O portal revisa os preços da conta separadamente antes de uma solicitação de cadastro posterior.
- A elegibilidade e os requisitos podem mudar. Atualize-os para a marca e o caso de uso selecionados antes do envio. Uma consulta bem-sucedida não constitui aprovação de campanha, atribuição de números nem permissão para começar a enviar mensagens.