Registar uma campanha 10DLC

Qualifique uma marca antes de registar a sua campanha

Uma campanha 10DLC descreve as mensagens que uma empresa registada pretende enviar, como os destinatários consentem e como podem obter ajuda ou parar as mensagens. Esta API cria o registo no registo central; concluir a ativação da operadora em produção é uma etapa separada de configuração da conta. Utilize uma marca pertencente à sua conta, obtida através do registo de marca, depois carregue os seus casos de uso disponíveis e os requisitos atuais do caso de uso selecionado.

Utilize o resultado atual da qualificação para escolher subcasos de uso, ID de rede elegíveis, exemplos de mensagens e declarações de opt-in/opt-out/ajuda. Os requisitos podem variar consoante a marca e a rede. Não submeta os identificadores do exemplo nem copie a sua descrição de consentimento para uma empresa com um processo diferente.

Mantenha sandbox e produção separadas

Para um exercício em sandbox, utilize a sua própria marca simulada e um caso de uso atual para o qual seja elegível. Utilize TRIAL apenas quando essa qualificação o oferecer. O portal verifica se a marca selecionada e o ambiente da campanha coincidem. Um pedido direto à API não executa por si a validação completa do assistente do portal, pelo que deve preservar essa separação na sua integração.

A criação de campanhas de produção é faturável e não torna automaticamente um número pronto para enviar. Mantenha o ambiente da campanha coerente com a sua marca e reveja a tarifa e os termos aplicáveis antes de criar uma campanha ativa.

Submeta o JSON da campanha

Prepare campaign.json com os seus valores qualificados. R000000 significa sem revendedor; utilize-o apenas quando essa for a configuração pretendida. Para a configuração normal de revendedor MultiTEL, obtenha o identificador de revendedor MultiTEL LLC permitido a partir da coleção de revendedores da sua conta ou do fluxo de preparação do portal, em vez de codificar diretamente o identificador de outra entidade.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  'https://api.multitel.net/tcr/v2/reseller?companyName=MultiTEL%20LLC&recordsPerPage=500'

O JSON seguinte ilustra uma campanha de teste para uma marca simulada própria. Substitua a marca, o caso de uso, o revendedor e o texto de consentimento pelos valores que realmente se qualificam para o seu teste.

{
  "brandId": "B123ABC",
  "channelId": "10DLC",
  "usecase": "TRIAL",
  "subUsecases": [],
  "resellerId": "R000000",
  "description": "Trial account notices requested by users of the example application.",
  "messageFlow": "Test users explicitly select an unchecked consent box before requesting these trial notices.",
  "sample1": "Example application: your requested account notice is available. Reply STOP to stop notices.",
  "subscriberOptin": true,
  "optinKeywords": "START",
  "optinMessage": "You are subscribed to the example application's requested account notices.",
  "subscriberOptout": true,
  "optoutKeywords": "STOP",
  "optoutMessage": "You will no longer receive the example application's account notices.",
  "subscriberHelp": true,
  "helpKeywords": "HELP",
  "helpMessage": "For help with example account notices, contact support@example.invalid.",
  "embeddedLink": false,
  "embeddedPhone": false,
  "numberPool": false,
  "ageGated": false,
  "directLending": false,
  "termsAndConditions": true,
  "autoRenewal": false,
  "mnoIds": [],
  "referenceId": "your-trial-reference"
}

Defina termsAndConditions como true apenas depois de a pessoa autorizada ter revisto e aceite os termos aplicáveis. O exemplo não constitui consentimento em seu nome. Utilize booleanos JSON para os sinalizadores, não cadeias entre aspas.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @campaign.json \
  'https://api.multitel.net/tcr/v2/campaignBuilder'

Campos da campanha e requisitos condicionais

O esquema publicado contém algumas maiúsculas inconsistentes nas tabelas descritivas. O pedido atual do portal utiliza subscriberOptin e subscriberOptout conforme mostrado acima. Mantenha exatamente essas maiúsculas. Este guia abrange o fluxo 10DLC destinado ao inquilino; não infira que os campos obrigatórios ou as etapas de ativação de outro canal sejam os mesmos.

Repita o mesmo pedido pretendido em segurança

Utilize uma Idempotency-Key para esta criação pretendida. A chave tem 1–128 caracteres ASCII imprimíveis sem espaços e está limitada à conta proprietária. Mantenha o método HTTP, o caminho, a cadeia de consulta e os bytes exatos do corpo inalterados numa repetição. Um ficheiro JSON reformatado entra em conflito mesmo que os seus valores sejam equivalentes.

Uma duplicação em curso pode devolver HTTP 409 com Retry-After; os pedidos concluídos podem repetir a sua resposta armazenada. Um erro em cache não prova que o registo não criou nada. Guarde campaignId, requestId e quaisquer cabeçalhos de correlação, inspecione a campanha existente e reconcilie uma falha parcial antes de considerar uma nova chave.

Um ID de campanha não é a configuração final de envio

A resposta utiliza o estado HTTP e JSON direto. Após uma criação bem-sucedida, guarde campaignId e leia o seu estado atual:

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

O fluxo de produção atual do portal também partilha a campanha com a operadora de mensagens e carrega a marca/campanha na conta de envio. Essas são operações separadas desta chamada pública de criação. Uma campanha de registo pode existir mesmo que uma etapa posterior de partilha ou de carregamento na operadora falhe.

Utilize o fluxo integrado de criação em produção do portal quando precisar da sequência combinada de registo, partilha e carregamento na operadora. Para uma campanha de produção já criada diretamente por esta API, conserve o seu ID de campanha e solicite a reconciliação da configuração da operadora da conta através do suporte. A IU atual do cliente não expõe um botão geral de retomar para cada campanha de produção criada diretamente. Não crie outro registo para repetir a sua ativação. Confirme que a campanha está ativa e que a configuração da operadora foi concluída antes de atribuir um número de envio. O número também deve ser próprio, ativo e com SMS ativado. A criação da campanha não envia mensagens.

Tarifas de campanhas de produção

Estes montantes de retalho foram verificados em relação à configuração atual do portal em 24 de outubro de 2026. Confirme o caso de uso qualificado atual e o preço apresentado antes de uma submissão em produção. Um monthlyFee numa resposta de qualificação do registo não é automaticamente o seu preço de retalho MultiTEL.

O portal atual indica um compromisso mínimo de três meses para campanhas de produção não políticas. Reveja os termos aplicáveis e a escolha de renovação antes de confirmar. Registo, aluguer de número, verificação adicional e utilização de mensagens são cobranças separadas. Uma resposta de criação bem-sucedida não prova por si só que todas as etapas de faturação ou de ativação na operadora foram concluídas.

Trate falhas de validação e parciais

Leia HTTP status e o JSON devolvido. As falhas de validação podem ser matrizes de objetos code/description; as falhas locais podem, em vez disso, ser objetos com message, status e, para alguns erros de processamento, requestId.