Registe a empresa por trás das suas mensagens
Uma marca de mensagens identifica a empresa que envia mensagens 10DLC nos EUA. Registe a marca antes de escolher um caso de utilização de campanha. Utilize os dados legais da empresa e um contacto capaz de concluir qualquer validação exigida. Um ID de marca devolvido não constitui, por si só, autorização para enviar mensagens.
Utilize esta rota atual associada à conta através de HTTPS com uma conta de API ativa e o respetivo endereço IP de origem permitido. Não envie user_id, username nem o identificador de proprietário de outro cliente. A MultiTEL regista a propriedade a partir da conta autenticada.
Comece com um pedido de sandbox explícito
O portal predefine o campo mode do seu formulário como sandbox; um pedido direto à API tem de incluir explicitamente o booleano JSON mock: true quando pretende uma marca fictícia. Omitir esse sinalizador não é garantia de sandbox e pode criar um registo de produção faturável. O campo mode do portal não substitui o campo mock da API.
Prepare um ficheiro brand.json local com os campos abaixo. Substitua os marcadores de posição por dados de teste adequados e códigos de catálogo atuais. Este exemplo é uma empresa privada com fins lucrativos; outros tipos de entidade têm requisitos diferentes.
{
"entityType": "PRIVATE_PROFIT",
"displayName": "Example business",
"companyName": "Example legal business name",
"ein": "YOUR_TAX_ID",
"einIssuingCountry": "US",
"phone": "+12025550123",
"street": "123 Example Street",
"city": "Example City",
"state": "NY",
"postalCode": "10001",
"country": "US",
"email": "contact@example.invalid",
"brandRelationship": "BASIC_ACCOUNT",
"vertical": "CURRENT_VERTICAL_CODE",
"referenceId": "your-business-reference",
"mock": true
}A empresa, a morada, o telefone e o identificador acima são marcadores de posição, não uma identidade empresarial pronta para registo. Obtenha os valores atuais de entityType, vertical, country, state, brandRelationship e de outras enumerações nos catálogos de mensagens.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--data-binary @brand.json \
'https://api.multitel.net/tcr/v2/brand/nonBlocking'Campos da empresa e de contacto
| Campos | O que fornecer |
|---|---|
| entityType, displayName | Código atual do tipo de entidade e o nome reconhecível da marca. Os comprimentos máximos são 20 e 255 caracteres, respetivamente. |
| country, street, city, state, postalCode | A morada real da empresa. Utilize o código de país de duas letras e um código state atual dos EUA quando aplicável. Limites: street 255, city 100, state 20 e postalCode 10 caracteres. |
| email, phone | Um e-mail de contacto funcional, até 100 caracteres, e um número de telefone em formato internacional com +indicativo de país, até 20 caracteres. Mantenha os dados da empresa coerentes em todo o registo. |
| companyName, ein, einIssuingCountry | Para organizações, forneça o nome legal da empresa e o identificador fiscal da empresa. O país emissor do identificador é um campo separado de duas letras. Limites: companyName 255 e ein 21 caracteres. Um empresário em nome individual utiliza os campos de nome pessoal em vez da identidade fiscal de uma organização. |
| brandRelationship, vertical | A relação com a empresa e o respetivo setor, utilizando códigos de catálogo atuais. As organizações exigem estes campos; as regras para empresários em nome individual diferem. Não substitua os códigos da API por etiquetas de apresentação traduzidas. |
| firstName, lastName, mobilePhone | Obrigatórios para um empresário em nome individual. Os campos de nome permitem até 100 caracteres cada. Forneça um número de telemóvel elegível para a validação OTP obrigatória, em formato internacional. |
| stockSymbol, stockExchange, website, businessContactEmail | Uma empresa cotada em bolsa também precisa do seu símbolo/bolsa de valores, website e de um e-mail de contacto empresarial elegível para o processo de validação adicional. Limites: stockSymbol 10, website 255 e businessContactEmail 255 caracteres. |
| altBusinessIdType, altBusinessId | Identificador empresarial alternativo opcional. Forneça o tipo e o valor em conjunto. Utilize o catálogo de tipos atual; o valor permite até 50 caracteres. |
| referenceId | A sua referência empresarial, até 50 caracteres. Inclua-a no registo de empresário em nome individual, de acordo com os requisitos atuais específicos da entidade. É um metadado empresarial, não a chave de idempotência do pedido. |
| website, ipAddress, tag | Website adicional, metadados do IP de origem e valores de etiqueta, quando aplicável. Estes não estabelecem a propriedade da conta nem substituem as verificações de identidade. |
| mock | Um booleano JSON. Utilize true apenas para o fluxo de trabalho fictício pretendido; utilize false para um registo de produção explicitamente revisto. Não envie a cadeia de caracteres "false" como substituto de um booleano JSON. |
Os empresários em nome individual são suportados para registos nos EUA ou no Canadá e precisam de verificação OTP antes da elegibilidade para campanhas. As empresas cotadas em bolsa podem exigir um passo de validação do contacto empresarial. GOVERNMENT destina-se a entidades governamentais sediadas nos EUA; confirme a categoria de entidade correta para outras organizações. Siga os requisitos específicos da entidade, bem como os erros de validação devolvidos.
Mantenha uma chave de idempotência estável
Gere uma única Idempotency-Key para este registo pretendido. Tem de conter 1–128 caracteres ASCII imprimíveis, sem espaços. Reutilize a mesma chave apenas com o mesmo método HTTP, o mesmo caminho, a mesma cadeia de consulta e exatamente os mesmos bytes do corpo do pedido. Reformatar o JSON, mesmo sem alterar o seu significado, altera a impressão digital do pedido.
Um pedido com chave já concluído pode reproduzir a resposta armazenada sem uma nova submissão de registo. Um duplicado ainda em processamento devolve HTTP 409 e pode incluir Retry-After. Um pedido alterado com a mesma chave entra em conflito. Não gere uma nova chave apenas porque um pedido expirou ou devolveu um erro: a empresa pode já ter sido registada.
Mantenha o brand.json inalterado enquanto resolve esse pedido. Um 500 ou 502 em cache pode reproduzir o erro original em vez de repetir o registo. Guarde qualquer brandId, requestId e cabeçalhos de correlação devolvidos; reconcilie a marca existente antes de iniciar um pedido diferente.
Leia a marca e o seu estado
Esta API utiliza códigos de estado HTTP e um corpo JSON direto, em vez do envelope status/response da v3. Um registo bem-sucedido devolve um objeto de marca que inclui brandId. Guarde esse identificador e inspecione o estado de validação ou de identidade devolvido. Os campos adicionais dependem da entidade e do estado do registo.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID"Leia apenas uma marca que pertença à sua conta. Um 404 pode significar que a marca não está disponível para esta conta. Conclua qualquer validação exigida e, em seguida, utilize a qualificação da marca para encontrar os respetivos casos de utilização de campanha disponíveis. Não se pode presumir que os recursos fictícios sejam elegíveis para envio em produção.
Taxas de produção
| Registo | Taxa |
|---|---|
| Organização padrão | $5.00 |
| Empresário em nome individual | $4.45 |
| Marca fictícia | Sem débito de registo de marca no fluxo de trabalho fictício |
Estes valores de retalho foram verificados face à configuração atual do portal em 24 de outubro de 2026. Confirme a taxa atual no portal antes de um registo de produção. Os encargos de campanha, a verificação adicional e a utilização de mensagens são separados. Um registo de produção verifica a permissão de compra e o financiamento disponível antes da submissão; a criação bem-sucedida no registo e a faturação local são passos de processamento separados, pelo que deve guardar o ID do recurso e reconciliar as transações se ocorrer um erro ou um problema de faturação.
Converter uma marca fictícia em produção é um fluxo de trabalho confirmado separadamente e pode criar uma nova identidade de produção e uma nova cobrança. Não presuma que editar mock para false num pedido posterior converte a marca existente.
Trate os erros sem duplicar a marca
| Resultado HTTP | O que verificar |
|---|---|
| 400 | Leia os erros de campo. Os erros de validação do registo podem ser uma matriz de objetos code/description. A validação local da chave de idempotência também pode devolver 400. |
| 401, 403 ou 404 | Verifique as credenciais da API, o IP de origem permitido da conta de API, as permissões do cliente e a propriedade. Uma resposta do registo também pode transportar o seu próprio erro de autorização. |
| 402 | Reveja o financiamento e a permissão de compra. Não trate um pedido de produção sem financiamento como um teste de sandbox. |
| 409 | Mantenha a mesma chave e o pedido inalterado enquanto aguarda um pedido em curso. Um conflito de corpo/chave alterado ou uma resposta anterior irrecuperável precisa primeiro de reconciliação. |
| 429 ou uma resposta de limitador indisponível | Respeite Retry-After quando presente. Repita o mesmo pedido pretendido e a mesma chave depois de o limite ser levantado. |
| 500 ou 502 | A operação remota pode ter sido aceite. Um erro de processamento local pode incluir requestId. Guarde-o e verifique o recurso existente; não presuma que é necessário um registo de substituição. |