Ontwikkelaars

POST/tcr/v2/campaignBuilder

Registreer 'n 10DLC-veldtog

Dien 'n gekwalifiseerde veldtog in en onderskei registerregistrasie van diensverskafferaktivering en versendgereedheid.

Op hierdie bladsy
  1. Kwalifiseer 'n handelsmerk voordat sy veldtog geregistreer word
  2. Hou toets- en produksie-omgewings geskei
  3. Dien die veldtog-JSON in
  4. Veldtogvelde en voorwaardelike vereistes
  5. Probeer dieselfde beoogde versoek veilig weer
  6. 'n Veldtog-ID is nie die finale versendopstelling nie
  7. Produksieveldtoggelde
  8. Hanteer validering en gedeeltelike mislukkings

Kwalifiseer 'n handelsmerk voordat sy veldtog geregistreer word

'n 10DLC-veldtog beskryf die boodskappe wat 'n geregistreerde besigheid beplan om te stuur, hoe ontvangers toestem, en hoe hulle hulp kan kry of boodskappe kan staak. Hierdie API skep die registerrekord; die voltooiing van produksie-diensverskafferaktivering is 'n afsonderlike rekeningopstellingstap. Gebruik 'n handelsmerk in jou besit uit handelsmerkregistrasie, laai dan sy beskikbare gebruiksgevalle en die gekose gebruiksgeval se huidige vereistes.

Gebruik die huidige kwalifikasieresultaat om subgebruiksgevalle, kwalifiserende netwerk-ID's, boodskapvoorbeelde en inteken-/uitskryf-/hulpverklarings te kies. Vereistes kan per handelsmerk en netwerk verskil. Moenie die voorbeeld se identifiseerders indien of sy toestemmingsbeskrywing kopieer vir 'n besigheid met 'n ander proses nie.

Hou toets- en produksie-omgewings geskei

Vir 'n toetsoefening, gebruik jou eie toets-handelsmerk en 'n huidige gebruiksgeval waarvoor dit kwalifiseer. Gebruik TRIAL slegs wanneer daardie kwalifikasie dit aanbied. Die portaal kontroleer dat die gekose handelsmerk en veldtogomgewing ooreenstem. 'n Direkte API-versoek loop nie die portaal se volledige towenaarvalidering vir jou nie, behou dus daardie skeiding in jou integrasie.

Produksieveldtogskepping is betaalbaar en maak nie outomaties 'n nommer versendgereed nie. Hou die veldtogomgewing konsekwent met sy handelsmerk, en hersien die fooi en toepaslike bepalings voordat jy 'n produksieveldtog skep.

Dien die veldtog-JSON in

Berei campaign.json voor met jou gekwalifiseerde waardes. R000000 beteken geen herverkoper nie; gebruik dit slegs wanneer dit die beoogde konfigurasie is. Vir die normale MultiTEL-herverkoperkonfigurasie, verkry die toegelate MultiTEL LLC-herverkoperidentifiseerder uit jou rekening se herverkoper-versameling of die portaalvoorbereidingsvloei eerder as om iemand anders se identifiseerder hard te kodeer.

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

Die volgende JSON illustreer 'n proefveldtog vir 'n toetshandelsmerk in jou besit. Vervang die handelsmerk, gebruiksgeval, herverkoper en toestemmingsteks met die waardes wat werklik vir jou toets kwalifiseer.

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

Stel termsAndConditions op true slegs nadat die gemagtigde persoon die toepaslike bepalings nagegaan en aanvaar het. Die voorbeeld is nie toestemming namens jou nie. Gebruik JSON-boolewaardes vir die vlae, nie aangehaalde stringe nie.

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'

Veldtogvelde en voorwaardelike vereistes

10DLC-veldtogversoek
VeldeWat om te verskaf
brandId, channelId, usecaseDie handelsmerk in jou besit, kanaal 10DLC, en 'n kwalifiserende huidige gebruiksgevalkode. Gebruik kodes uit kwalifikasie, nie vertaalde etikette nie.
subUsecases'n Skikking van kwalifiserende subgebruiksgevalkodes. Respekteer die gekose kwalifikasie se minimum- en maksimumtelling.
resellerId'n Toegelate herverkoperidentifiseerder. Die rekeningbesit roete aanvaar herverkopers in jou besit, sy gekonfigureerde gedeelde herverkoper, of die opsetlike geen-herverkoper-waarde. 'n Onverwante herverkoper word verwerp.
description, messageFlowBeskryf die werklike doel en hoe toestemming ingesamel word. Elk moet 40–4096 karakters bevat. Sluit die werklike gebruikeraksie, vorm of proses in; moenie toestemming uitdink wat jou toepassing nie insamel nie.
sample1 … sample5Verteenwoordigende boodskappe, normaalweg 20–1024 karakters elk. Die portaal vereis minstens een; kwalifiserende netwerke kan meer vereis. Verskaf die getal wat die huidige kwalifikasie vereis.
subscriberOptin, subscriberOptout, subscriberHelpVerklaar ondersteunde ontvangersvloeie deur hierdie presiese veldname te gebruik. Wanneer 'n vloei geaktiveer is, verskaf sy sleutelwoord- en boodskapvelde. Netwerkvereistes kan spesifieke vloeie verpligtend maak.
optinKeywords, optoutKeywords, helpKeywordsDie werklik herkende sleutelwoorde, tot 255 karakters. Hulle moet ooreenstem met die ontvangende toepassing se gedrag.
optinMessage, optoutMessage, helpMessageDie ooreenstemmende boodskappe. Die huidige gepubliseerde veldreels spesifiseer 20–1024 karakters. Sluit werklike ondersteuning- en uitskryfgedrag in.
embeddedLink, embeddedPhone, embeddedLinkSampleVerklaar ingebedde skakels of telefoonnommers waarheidsgetrou. 'n Andersins gekwalifiseerde netwerk kan hulle verbied. 'n Skakelvoorbeeld laat tot 255 karakters toe.
mnoIds'n Opsionele skikking van kwalifiserende numeriese netwerk-ID's uit kwalifikasie. Moenie aanvaar dat elke netwerk die gekose gebruiksgeval ondersteun nie.
numberPool, ageGated, directLendingToepaslike veldtoggienskappe as JSON-boolewaardes. Kies hulle volgens die werklike diens.
privacyPolicyLink, termsAndConditionsLinkJou relevante publieke beleid- en bepalings-URL's wanneer van toepassing, tot 2048 karakters elk. Hulle moet die werklike boodskapdiens beskryf.
termsAndConditionsUitdruklike aanvaarding van die toepaslike veldtogbepalings. Die portaal vereis true en sy towenaar versamel ook die huidige individuele bevestigings.
autoRenewalOf die veldtog hernu. Die verstek is true. Die deaktivering van hernuwing verwyder nie 'n minimumverbintenis wat reeds met 'n produksieveldtog geassosieer is nie.
referenceId, tagJou veldtogverwysing, tot 50 karakters, en opsionele etikette. referenceId is nie die Idempotency-Key-opskrif nie.

Die gepubliseerde skema bevat sekere inkonsekwente hooflettergebruik in beskrywende tabelle. Die huidige portaalversoek gebruik subscriberOptin en subscriberOptout soos hierbo getoon. Behou daardie presiese hoofletters. Hierdie gids dek die huurdergerigte 10DLC-werkvloei; moenie aflei dat 'n ander kanaal se vereiste velde of aktiveringstappe dieselfde is nie.

Probeer dieselfde beoogde versoek veilig weer

Gebruik een Idempotency-Key vir hierdie beoogde skepping. Die sleutel is 1–128 drukbare ASCII-karakters sonder spasies en is tot die eienaarsrekening beperk. Hou die HTTP-metode, pad, navraagstring en presiese liggaamsgrepe onveranderd by 'n herpoging. 'n Herformateerde JSON-leer veroorsaak 'n konflik selfs al is sy waardes ekwivalent.

'n Aan-die-gang-duplikaat kan HTTP 409 met Retry-After teruggee; voltooide versoeke kan hulle gestoorde antwoord herspeel. 'n Gekaste fout bewys nie dat die register niks geskep het nie. Stoor campaignId, requestId en enige korrelasie-opskrifte, inspekteer die bestaande veldtog en rekonsilieer 'n gedeeltelike mislukking voordat jy 'n nuwe sleutel oorweeg.

'n Veldtog-ID is nie die finale versendopstelling nie

Die antwoord gebruik HTTP-status en direkte JSON. By suksesvolle skepping, behou campaignId en lees sy huidige toestand:

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

Die huidige portaal se produksiewerkvloei deel ook die veldtog met die boodskapdiensverskaffer en laai die handelsmerk/veldtog in die versendrekening. Dit is afsonderlike bewerkings van hierdie publieke skeppingsoproep. 'n Registerveldtog kan bestaan selfs al misluk 'n latere deel- of diensverskafferlaaistap.

Gebruik die portaal se geintegreerde produksieskeppingswerkvloei wanneer jy die gekombineerde registrasie-, deel- en diensverskafferlaaivolgorde nodig het. Vir 'n produksieveldtog wat reeds direk deur hierdie API geskep is, behou sy veldtog-ID en laat die rekening se diensverskafferopstelling deur ondersteuning rekonsilieer. Die huidige klantkoppelvlak stel nie 'n algemene hervatknoppie vir elke direk geskepte produksieveldtog beskikbaar nie. Moenie nog 'n registrasie skep om sy aktivering weer te probeer nie. Bevestig dat die veldtog aktief is en die diensverskafferopstelling voltooi is voor die toewysing van 'n versendnommer. Die nommer moet ook in jou besit, aktief en SMS-geaktiveer wees. Veldtogskepping stuur nie boodskappe nie.

Produksieveldtoggelde

Huidige gekonfigureerde maandelikse veldtoggelde
GebruiksgevalMaandelikse fooi
LOW_VOLUME, UCAAS_LOW$1.67
SOLE_PROPRIETOR$2.23
CHARITY$3.34
EMERGENCY$5.56
AGENTS_FRANCHISES$33.34
Ander gekonfigureerde terugvalgebruiksgevalle$11.12

Hierdie kleinhandelbedrae is op 24 Oktober 2026 teen die huidige portaalopstelling gekontroleer. Bevestig die huidige gekwalifiseerde gebruiksgeval en vertoonde prys voor 'n produksie-indiening. 'n monthlyFee in 'n registerkwalifikasieantwoord is nie outomaties jou MultiTEL-kleinhandelprys nie.

Die huidige portaal meld 'n minimumverbintenis van drie maande vir nie-politieke produksieveldtogte. Hersien die toepaslike bepalings en hernuwingskeuse voor bevestiging. Registrasie, nommerhuur, bykomende keuring en boodskapgebruik is afsonderlike heffings. 'n Suksesvolle skeppingsantwoord bewys nie onafhanklik dat elke fakturering- of diensverskafferaktiveringstap voltooi is nie.

Hanteer validering en gedeeltelike mislukkings

Lees HTTP-status en die teruggegewe JSON. Valideringsmislukkings kan skikkings van code/description-objekte wees; plaaslike mislukkings kan in plaas daarvan objekte met message, status en, vir sommige verwerkingsfoute, requestId wees.

Veldtogmislukkings
HTTP-resultaatVolgende aksie
400Korrigier die spesifieke velde of idempotensiesleutel. Herlees huidige kwalifikasie, vereiste voorbeeldtelling en ontvangersvloeivereistes.
401, 403 of 404Kontroleer API-geloofsbriewe en toegelate bron-IP, dan handelsmerk/herverkoper-eienaarskap en toestemmings. Moenie identifiseerders van 'n ander rekening gebruik nie.
402Hersien produksiebefondsing en aankoopmagtiging voordat jy dieselfde beoogde skepping weer probeer.
409Onderskei aan-die-gang-herhaling van 'n gewysigde versoek wat dieselfde sleutel gebruik. Behou die bestaande veldtog- en versoekbesonderhede wanneer jy rekonsilieer.
429 of beperker onbeskikbaarEer Retry-After wanneer teenwoordig en behou die oorspronklike sleutel en presiese versoek.
500 of 502Skepping het moontlik reeds plaasgevind. Stoor enige campaignId en requestId, kontroleer die bestaande veldtog, en hervat of rekonsilieer sy aktivering eerder as om 'n duplikaat te skep.