Izstrādātājiem

POST/tcr/v2/campaignBuilder

Reģistrēt 10DLC kampaņu

Iesniedziet kvalificētu kampaņu un nošķiriet reģistra reģistrāciju no operatora aktivizēšanas un sūtīšanas gatavības.

Šajā lapā
  1. Kvalificējiet zīmolu pirms tā kampaņas reģistrēšanas
  2. Turiet smilškasti un produkciju atsevišķi
  3. Iesniedziet kampaņas JSON
  4. Kampaņas lauki un nosacītās prasības
  5. Droši atkārtojiet to pašu paredzēto pieprasījumu
  6. Kampaņas identifikators nav galīgais sūtīšanas iestatījums
  7. Produkcijas kampaņu maksas
  8. Apstrādājiet validācijas un daļējas kļūmes

Kvalificējiet zīmolu pirms tā kampaņas reģistrēšanas

10DLC kampaņa apraksta ziņojumus, ko reģistrēts uzņēmums paredz sūtīt, kā saņēmēji piekrīt, kā viņi var saņemt palīdzību vai pārtraukt ziņojumus. Šis API izveido reģistra ierakstu; produkcijas operatora aktivizēšanas pabeigšana ir atsevišķs konta iestatīšanas solis. Izmantojiet jums piederošu zīmolu, kas izveidots, izmantojot zīmola reģistrāciju, pēc tam ielādējiet tā pieejamos lietošanas gadījumus un atlasītā lietošanas gadījuma pašreizējās prasības.

Izmantojiet pašreizējo kvalifikācijas rezultātu, lai izvēlētos apakšlietošanas gadījumus, atbilstošos tīkla identifikatorus, ziņojumu paraugus un piekrišanas/atteikšanās/palīdzības deklarācijas. Prasības var atšķirties atkarībā no zīmola un tīkla. Neiesniedziet piemēra identifikatorus un nekopējiet tā piekrišanas aprakstu uzņēmumam ar atšķirīgu procesu.

Turiet smilškasti un produkciju atsevišķi

Smilškastes vingrinājumam izmantojiet savu testa zīmolu un pašreizējo lietošanas gadījumu, kuram tas kvalificējas. Izmantojiet TRIAL tikai tad, ja kvalifikācija to piedāvā. Portāls pārbauda, vai atlasītais zīmols un kampaņas vide atbilst. Tiešs API pieprasījums jūsu vietā neveic pilnu portāla vedņa validāciju, tāpēc saglabājiet šo nodalījumu savā integrācijā.

Produkcijas kampaņas izveide ir maksas pakalpojums un automātiski nepadara numuru gatavu sūtīšanai. Uzturiet kampaņas vidi atbilstošu tās zīmolam un pirms produkcijas kampaņas izveides pārskatiet maksu un piemērojamos noteikumus.

Iesniedziet kampaņas JSON

Sagatavojiet campaign.json ar savām kvalificētajām vērtībām. R000000 nozīmē, ka tālākpārdevēja nav; izmantojiet to tikai tad, ja tā ir paredzētā konfigurācija. Normālai MultiTEL tālākpārdevēja konfigurācijai iegūstiet atļauto MultiTEL LLC tālākpārdevēja identifikatoru no sava konta tālākpārdevēju kolekcijas vai portāla sagatavošanas plūsmas, nevis iekodējiet cita identifikatoru.

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

Tālāk redzamais JSON ilustrē testa kampaņu pašu testa zīmolam. Aizstājiet zīmolu, lietošanas gadījumu, tālākpārdevēju un piekrišanas tekstu ar vērtībām, kas faktiski kvalificējas jūsu testam.

{
  "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"
}

Iestatiet termsAndConditions uz true tikai pēc tam, kad pilnvarotā persona ir pārskatījusi un pieņēmusi piemērojamos noteikumus. Piemērs nav piekrišana jūsu vietā. Karogiem izmantojiet JSON Būla vērtības, nevis pēdiņās ietvertas virknes.

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'

Kampaņas lauki un nosacītās prasības

10DLC kampaņas pieprasījums
LaukiKas jānorāda
brandId, channelId, usecaseJūsu zīmols, kanāls 10DLC un atbilstošs pašreizējais lietošanas gadījuma kods. Izmantojiet kodus no kvalifikācijas, nevis tulkotos nosaukumus.
subUsecasesAtbilstošo apakšlietošanas gadījumu kodu masīvs. Ievērojiet atlasītās kvalifikācijas minimālo un maksimālo skaitu.
resellerIdAtļauts tālākpārdevēja identifikators. Kontam piederošais maršruts pieņem pašu tālākpārdevējus, tā konfigurēto koplietoto tālākpārdevēju vai apzināto vērtību bez tālākpārdevēja. Nesaistīts tālākpārdevējs tiek noraidīts.
description, messageFlowAprakstiet faktisko nolūku un to, kā tiek iegūta piekrišana. Katram jābūt 40–4096 rakstzīmes garam. Iekļaujiet reālo lietotāja darbību, veidlapu vai procesu; neizdomājiet piekrišanu, ko jūsu lietojumprogramma neiegūst.
sample1 … sample5Reprezentatīvi ziņojumi, parasti 20–1024 rakstzīmes katrs. Portāls pieprasa vismaz vienu; atbilstošie tīkli var pieprasīt vairāk. Norādiet skaitu, ko pieprasa pašreizējā kvalifikācija.
subscriberOptin, subscriberOptout, subscriberHelpDeklarējiet atbalstītās saņēmēju plūsmas, izmantojot šos precīzos lauku nosaukumus. Ja plūsma ir iespējota, norādiet tās atslēgvārdu un ziņojumu laukus. Tīkla prasības var padarīt noteiktas plūsmas obligātas.
optinKeywords, optoutKeywords, helpKeywordsFaktiskie atpazītie atslēgvārdi, līdz 255 rakstzīmēm. Tiem jāatbilst saņemošās lietojumprogrammas darbībai.
optinMessage, optoutMessage, helpMessageAtbilstošie ziņojumi. Pašreizējie publicētie lauku noteikumi nosaka 20–1024 rakstzīmes. Iekļaujiet reālu atbalsta un atteikšanās darbību.
embeddedLink, embeddedPhone, embeddedLinkSamplePatiesi deklarējiet iegultās saites vai tālruņu numurus. Citādi kvalificēts tīkls tos var aizliegt. Saites paraugs pieļauj līdz 255 rakstzīmēm.
mnoIdsNeobligāts atbilstošo skaitlisko tīkla identifikatoru masīvs no kvalifikācijas. Nepieņemiet, ka katrs tīkls atbalsta atlasīto lietošanas gadījumu.
numberPool, ageGated, directLendingPiemērojamie kampaņas raksturlielumi kā JSON Būla vērtības. Izvēlieties tos atbilstoši faktiskajam pakalpojumam.
privacyPolicyLink, termsAndConditionsLinkJūsu atbilstošie publiskās politikas un noteikumu URL, ja piemērojami, līdz 2048 rakstzīmēm katrs. Tiem jāapraksta faktiskais ziņojumapmaiņas pakalpojums.
termsAndConditionsEksplicīta piemērojamo kampaņas noteikumu pieņemšana. Portāls pieprasa true, un tā vednis ievāc arī pašreizējos individuālos apstiprinājumus.
autoRenewalVai kampaņa tiek atjaunota. Noklusējums ir true. Atjaunošanas atspējošana nenoņem minimālās saistības, kas jau ir saistītas ar produkcijas kampaņu.
referenceId, tagJūsu kampaņas atsauce, līdz 50 rakstzīmēm, un neobligātās birkas. referenceId nav Idempotency-Key galvene.

Publicētā shēma aprakstošajās tabulās satur nekonsekventu lielo burtu lietojumu. Pašreizējais portāla pieprasījums izmanto subscriberOptin un subscriberOptout, kā parādīts iepriekš. Saglabājiet tieši šo reģistru. Šis ceļvedis attiecas uz nomniekiem paredzēto 10DLC darbplūsmu; neuzskatiet, ka cita kanāla obligātie lauki vai aktivizēšanas darbības ir tādas pašas.

Droši atkārtojiet to pašu paredzēto pieprasījumu

Izmantojiet vienu Idempotency-Key šai paredzētajai izveidei. Atslēga ir 1–128 drukājamas ASCII rakstzīmes bez atstarpēm un ir saistīta ar īpašnieka kontu. Atkārtojot saglabājiet nemainīgu HTTP metodi, ceļu, vaicājuma virkni un precīzus pieprasījuma pamatteksta baitus. Pārformatēts JSON fails konfliktē, pat ja tā vērtības ir līdzvērtīgas.

Nepabeigts dublikāts var atgriezt HTTP 409 ar Retry-After; pabeigti pieprasījumi var atkārtot saglabāto atbildi. Kešatmiņā saglabāta kļūda nepierāda, ka reģistrs neko nav izveidojis. Saglabājiet campaignId, requestId un visas korelācijas galvenes, pārbaudiet esošo kampaņu un saskaņojiet daļēju kļūmi, pirms apsvērt jaunu atslēgu.

Kampaņas identifikators nav galīgais sūtīšanas iestatījums

Atbilde izmanto HTTP statusu un tiešu JSON. Pēc veiksmīgas izveides saglabājiet campaignId un izlasiet tā pašreizējo stāvokli:

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

Pašreizējā portāla produkcijas darbplūsma arī koplieto kampaņu ar ziņojumapmaiņas operatoru un ielādē zīmolu/kampaņu sūtīšanas kontā. Tās ir atsevišķas operācijas no šī publiskā izveides izsaukuma. Reģistra kampaņa var pastāvēt, pat ja vēlāka koplietošanas vai operatora ielādes darbība neizdodas.

Izmantojiet portāla integrēto produkcijas izveides darbplūsmu, kad nepieciešama apvienotā reģistrācijas, koplietošanas un operatora ielādes secība. Produkcijas kampaņai, kas jau izveidota tieši ar šo API, saglabājiet tās kampaņas identifikatoru un saskaņojiet konta operatora iestatījumu ar atbalsta palīdzību. Pašreizējā klienta saskarne nepiedāvā vispārīgu atsākšanas pogu katrai tieši izveidotai produkcijas kampaņai. Neveidojiet citu reģistrāciju, lai atkārtoti mēģinātu tās aktivizēšanu. Apstipriniet, ka kampaņa ir aktīva un operatora iestatīšana ir pabeigta, pirms sūtīšanas numura piešķiršanas. Numuram arī jābūt īpašumā, aktīvam un ar iespējotu SMS. Kampaņas izveide nesūta ziņojumus.

Produkcijas kampaņu maksas

Pašreizējās konfigurētās mēneša kampaņu maksas
Lietošanas gadījumsMēneša maksa
LOW_VOLUME, UCAAS_LOW$1.67
SOLE_PROPRIETOR$2.23
CHARITY$3.34
EMERGENCY$5.56
AGENTS_FRANCHISES$33.34
Citi konfigurētie rezerves lietošanas gadījumi$11.12

Šīs mazumtirdzniecības summas tika pārbaudītas pret pašreizējo portāla konfigurāciju 24. oktobrī 2026. gadā. Pirms produkcijas iesniegšanas apstipriniet pašreizējo kvalificēto lietošanas gadījumu un parādīto cenu. monthlyFee reģistra kvalifikācijas atbildē nav automātiski jūsu MultiTEL mazumtirdzniecības cena.

Pašreizējais portāls nosaka trīs mēnešu minimālās saistības nepolitiskām produkcijas kampaņām. Pirms apstiprināšanas pārskatiet piemērojamos noteikumus un atjaunošanas izvēli. Reģistrācija, numura noma, papildu pārbaude un ziņojumu lietojums ir atsevišķas maksas. Veiksmīga izveides atbilde pati par sevi nepierāda, ka visi norēķinu vai operatora aktivizēšanas soļi ir pabeigti.

Apstrādājiet validācijas un daļējas kļūmes

Lasiet HTTP status un atgriezto JSON. Validācijas kļūmes var būt code/description objektu masīvi; lokālas kļūmes tā vietā var būt objekti ar message, status un dažām apstrādes kļūdām ar requestId.

Kampaņu kļūmes
HTTP rezultātsNākamā darbība
400Izlabojiet konkrētos laukus vai idempotences atslēgu. Vēlreiz izlasiet pašreizējo kvalifikāciju, nepieciešamo paraugu skaitu un saņēmēju plūsmu prasības.
401, 403 vai 404Pārbaudiet API akreditācijas datus un atļauto avota IP, pēc tam zīmola/tālākpārdevēja īpašumtiesības un atļaujas. Neizmantojiet cita konta identifikatorus.
402Pārskatiet produkcijas finansējumu un pirkšanas atļauju, pirms atkārtoti mēģināt to pašu paredzēto izveidi.
409Atšķiriet nepabeigta pieprasījuma atkārtošanu no mainīta pieprasījuma ar to pašu atslēgu. Saskaņojot saglabājiet esošās kampaņas un pieprasījuma datus.
429 vai ierobežotājs nav pieejamsIevērojiet Retry-After, ja tas ir norādīts, un saglabājiet sākotnējo atslēgu un precīzo pieprasījumu.
500 vai 502Izveide, iespējams, jau ir notikusi. Saglabājiet visus campaignId un requestId, pārbaudiet esošo kampaņu un atsāciet vai saskaņojiet tās aktivizēšanu, nevis izveidojiet dublikātu.