Zhvilluesit

POST/tcr/v2/campaignBuilder

Regjistroni një fushatë 10DLC

Dërgoni një fushatë të kualifikuar dhe dalloni regjistrimin në regjistër nga aktivizimi te operatori dhe gatishmëria për dërgim.

Në këtë faqe
  1. Kualifikoni një markë përpara se të regjistroni fushatën e saj
  2. Mbajeni të ndarë mjedisin sandbox nga prodhimi
  3. Dërgoni JSON-in e fushatës
  4. Fushat e fushatës dhe kërkesat e kushtëzuara
  5. Riprovoni të njëjtën kërkesë të synuar në mënyrë të sigurt
  6. Një ID fushate nuk është konfigurimi përfundimtar i dërgimit
  7. Tarifat e fushatave në prodhim
  8. Trajtoni validimin dhe dështimet e pjesshme

Kualifikoni një markë përpara se të regjistroni fushatën e saj

Një fushatë 10DLC përshkruan mesazhet që një biznes i regjistruar synon të dërgojë, mënyrën se si marrësit japin pëlqimin dhe si mund të marrin ndihmë ose të ndalojnë mesazhet. Kjo API krijon regjistrimin në regjistër; përfundimi i aktivizimit të operatorit në prodhim është një hap i veçantë i konfigurimit të llogarisë. Përdorni një markë në pronësi nga regjistrimi i markës, pastaj ngarkoni rastet e disponueshme të përdorimit dhe, për rastin e zgjedhur të përdorimit, kërkesat aktuale.

Përdorni rezultatin aktual të kualifikimit për të zgjedhur nën-rastet e përdorimit, ID-të e pranueshme të rrjetit, mostrat e mesazheve dhe deklarimet për pëlqimin e marrjes së mesazheve, çregjistrimin dhe ndihmën. Kërkesat mund të ndryshojnë sipas markës dhe rrjetit. Mos dërgoni identifikuesit e shembullit dhe mos kopjoni përshkrimin e pëlqimit për një biznes me proces tjetër.

Mbajeni të ndarë mjedisin sandbox nga prodhimi

Për një ushtrim sandbox, përdorni markën tuaj simuluese dhe një rast aktual përdorimi për të cilin ajo kualifikohet. Përdorni TRIAL vetëm kur ofrohet nga ai kualifikim. Portali kontrollon që marka e zgjedhur dhe mjedisi i fushatës të përputhen. Një kërkesë e drejtpërdrejtë API nuk ekzekuton për ju validimin e plotë të magjistarit të portalit, prandaj ruajeni këtë ndarje në integrimin tuaj.

Krijimi i fushatës në prodhim tarifohet dhe nuk e bën automatikisht një numër gati për dërgim. Mbajeni mjedisin e fushatës në përputhje me markën e saj dhe shqyrtoni tarifën dhe kushtet e zbatueshme përpara se të krijoni një fushatë live.

Dërgoni JSON-in e fushatës

Përgatitni campaign.json me vlerat tuaja të kualifikuara. R000000 do të thotë pa rishitës; përdorni atë vetëm kur ky është konfigurimi i synuar. Për konfigurimin normal të rishitësit MultiTEL, merrni identifikuesin e lejuar të rishitësit MultiTEL LLC nga koleksioni i rishitësve të llogarisë suaj ose nga rrjedha përgatitore e portalit, në vend që të kodoni fort identifikuesin e dikujt tjetër.

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

JSON-i vijues ilustron një fushatë prove për një markë simuluese në pronësi. Zëvendësoni markën, rastin e përdorimit, rishitësin dhe tekstin e pëlqimit me vlerat që kualifikohen realisht për testin tuaj.

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

Vendosni termsAndConditions në true vetëm pasi personi i autorizuar të ketë shqyrtuar dhe pranuar kushtet e zbatueshme. Shembulli nuk është pëlqim në emrin tuaj. Përdorni vlera logjike JSON për flamujt, jo vargje në thonjëza.

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'

Fushat e fushatës dhe kërkesat e kushtëzuara

Kërkesa për fushatë 10DLC
FushatÇfarë të jepni
brandId, channelId, usecaseMarka juaj në pronësi, kanali 10DLC dhe një kod aktual i pranueshëm i rastit të përdorimit. Përdorni kode nga kualifikimi, jo etiketa të përkthyera.
subUsecasesNjë varg me kode të pranueshme të nën-rasteve të përdorimit. Respektoni numrin minimal dhe maksimal të kualifikimit të zgjedhur.
resellerIdNjë identifikues i lejuar rishitësi. Rruga në pronësi të llogarisë pranon rishitës në pronësi, rishitësin e përbashkët të konfiguruar ose vlerën e qëllimshme pa rishitës. Një rishitës i palidhur refuzohet.
description, messageFlowPërshkruani qëllimin aktual dhe mënyrën e mbledhjes së pëlqimit. Secila duhet të përmbajë 40–4096 karaktere. Përfshini veprimin, formularin ose procesin e vërtetë të përdoruesit; mos shpikni pëlqim që aplikacioni juaj nuk mbledh.
sample1 … sample5Mesazhe përfaqësuese, normalisht 20–1024 karaktere secili. Portali kërkon të paktën një; rrjetet e pranueshme mund të kërkojnë më shumë. Jepni numrin e kërkuar nga kualifikimi aktual.
subscriberOptin, subscriberOptout, subscriberHelpDeklaroni rrjedhat e mbështetura të marrësve duke përdorur këta emra të saktë fushash. Kur një rrjedhë është e aktivizuar, jepni fushat e fjalëkyçit dhe të mesazhit të saj. Kërkesat e rrjetit mund ta bëjnë të detyrueshme ndonjë rrjedhë të caktuar.
optinKeywords, optoutKeywords, helpKeywordsFjalëkyçet aktuale të njohura, deri në 255 karaktere. Ato duhet të përputhen me sjelljen e aplikacionit marrës.
optinMessage, optoutMessage, helpMessageMesazhet përkatëse. Rregullat aktuale të publikuara të fushave specifikojnë 20–1024 karaktere. Përfshini sjelljen e vërtetë të mbështetjes dhe të çregjistrimit.
embeddedLink, embeddedPhone, embeddedLinkSampleDeklaroni sinqerisht lidhjet e ngulitura ose numrat e telefonit. Një rrjet ndryshe i kualifikuar mund t'i ndalojë ato. Një mostër lidhjeje lejon deri në 255 karaktere.
mnoIdsNjë varg opsional me ID numerike të pranueshme rrjeti nga kualifikimi. Mos supozoni se çdo rrjet mbështet rastin e zgjedhur të përdorimit.
numberPool, ageGated, directLendingKarakteristikat e zbatueshme të fushatës si vlera logjike JSON. Zgjidhini ato sipas shërbimit aktual.
privacyPolicyLink, termsAndConditionsLinkURL-të tuaja përkatëse publike të politikës dhe të kushteve kur zbatohen, deri në 2048 karaktere secila. Ato duhet të përshkruajnë shërbimin aktual të dërgimit të mesazheve.
termsAndConditionsPranim i shprehur i kushteve të zbatueshme të fushatës. Portali kërkon true dhe magjistari i tij mbledh gjithashtu konfirmimet aktuale individuale.
autoRenewalNëse fushata rinovohet. Vlera e parazgjedhur është true. Çaktivizimi i rinovimit nuk heq një angazhim minimal tashmë të lidhur me një fushatë prodhimi.
referenceId, tagReferenca juaj e fushatës, deri në 50 karaktere, dhe etiketa opsionale. referenceId nuk është kreu Idempotency-Key.

Skema e publikuar përmban disa mospërputhje kapitalizimi në tabelat përshkruese. Kërkesa aktuale e portalit përdor subscriberOptin dhe subscriberOptout siç tregohet më sipër. Mbani saktësisht këtë format shkrimi. Ky udhëzues mbulon rrjedhën 10DLC për qiramarrësit; mos supozoni se fushat e kërkuara ose hapat e aktivizimit të një kanali tjetër janë të njëjta.

Riprovoni të njëjtën kërkesë të synuar në mënyrë të sigurt

Përdorni një Idempotency-Key për këtë krijim të synuar. Çelësi ka 1–128 karaktere ASCII të printueshme pa hapësira dhe i përket llogarisë pronare. Mbani të pandryshuara metodën HTTP, shtegun, vargun e pyetjes dhe bajtet e sakta të trupit në një riprovë. Një skedar JSON i riformatuar bie në konflikt edhe nëse vlerat janë të njëvlershme.

Një dublikatë në vazhdim mund të kthejë HTTP 409 me Retry-After; kërkesat e përfunduara mund të riprodhojnë përgjigjen e ruajtur. Një gabim i ruajtur në memorie nuk provon se regjistri nuk krijoi asgjë. Ruani campaignId, requestId dhe çdo kre korrelacioni, inspektoni fushatën ekzistuese dhe kontrolloni gjendjen reale dhe zgjidhni mospërputhjet pas një dështimi të pjesshëm përpara se të merrni në konsideratë një çelës të ri.

Një ID fushate nuk është konfigurimi përfundimtar i dërgimit

Përgjigjja përdor statusin HTTP dhe JSON të drejtpërdrejtë. Pas krijimit të suksesshëm, mbani campaignId dhe lexoni gjendjen e tij aktuale:

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

Rrjedha e prodhimit e portalit aktual gjithashtu ndan fushatën me operatorin e dërgimit të mesazheve dhe ngarkon markën/fushatën në llogarinë dërguese. Këto janë operacione të ndara nga kjo thirrje publike krijimi. Një fushatë regjistri mund të ekzistojë edhe nëse një hap i mëvonshëm i ndarjes ose i ngarkimit te operatori dështon.

Përdorni rrjedhën e integruar të krijimit në prodhim të portalit kur ju nevojitet sekuenca e kombinuar e regjistrimit, ndarjes dhe ngarkimit te operatori. Për një fushatë prodhimi të krijuar tashmë drejtpërdrejt nga kjo API, ruani ID-në e fushatës së saj dhe kërkoni që mbështetja të kontrollojë gjendjen reale të konfigurimit të operatorit të llogarisë dhe të zgjidhë çdo mospërputhje. Ndërfaqja aktuale e klientit nuk ofron një buton të përgjithshëm vazhdimi për çdo fushatë prodhimi të krijuar drejtpërdrejt. Mos krijoni një regjistrim tjetër për të riprovuar aktivizimin e saj. Konfirmoni që fushata është aktive dhe se konfigurimi i operatorit ka përfunduar përpara caktimit të një numri dërgues. Numri duhet gjithashtu të jetë në pronësi, aktiv dhe i aftësuar për SMS. Krijimi i fushatës nuk dërgon mesazhe.

Tarifat e fushatave në prodhim

Tarifat aktuale mujore të konfiguruara të fushatave
Rasti i përdorimitTarifa mujore
LOW_VOLUME, UCAAS_LOW$1.67
SOLE_PROPRIETOR$2.23
CHARITY$3.34
EMERGENCY$5.56
AGENTS_FRANCHISES$33.34
Raste të tjera përdorimi rezervë të konfiguruara$11.12

Këto shuma me pakicë u kontrolluan kundrejt konfigurimit aktual të portalit më 24 tetor 2026. Konfirmoni rastin aktual të kualifikuar të përdorimit dhe çmimin e shfaqur përpara një dërgimi në prodhim. Një monthlyFee në një përgjigje kualifikimi të regjistrit nuk është automatikisht çmimi juaj me pakicë MultiTEL.

Portali aktual përcakton një angazhim minimal tre-mujor për fushatat e prodhimit jopolitike. Shqyrtoni kushtet e zbatueshme dhe zgjedhjen e rinovimit përpara konfirmimit. Regjistrimi, qiraja e numrit, verifikimi shtesë dhe përdorimi i mesazheve janë tarifa të ndara. Një përgjigje e suksesshme krijimi nuk provon në mënyrë të pavarur se çdo hap i faturimit ose i aktivizimit te operatori ka përfunduar.

Trajtoni validimin dhe dështimet e pjesshme

Lexoni HTTP status dhe JSON-in e kthyer. Dështimet e validimit mund të jenë vargje objektesh code/description; dështimet lokale mund të jenë në vend të kësaj objekte me message, status dhe, për disa gabime përpunimi, requestId.

Dështimet e fushatave
Rezultati HTTPVeprimi tjetër
400Korrigjoni fushat specifike ose çelësin e idempotencës. Rilexoni kualifikimin aktual, numrin e kërkuar të mostrave dhe kërkesat e rrjedhave të marrësve.
401, 403 ose 404Kontrolloni kredencialet API dhe IP-në e lejuar të burimit, pastaj pronësinë dhe lejet e markës/rishitësit. Mos përdorni identifikues nga një llogari tjetër.
402Shqyrtoni financimin e prodhimit dhe lejen e blerjes përpara se të riprovoni të njëjtin krijim të synuar.
409Dalloni riprodhimin në vazhdim nga një kërkesë e ndryshuar që përdor të njëjtin çelës. Mbani fushatën ekzistuese dhe detajet e kërkesës kur kontrolloni gjendjen reale dhe zgjidhni mospërputhjet.
429 ose kufizuesi i padisponueshëmRespektoni Retry-After kur është i pranishëm dhe ruani çelësin origjinal dhe kërkesën e saktë.
500 ose 502Krijimi mund të ketë ndodhur tashmë. Ruani çdo campaignId dhe requestId, kontrolloni fushatën ekzistuese dhe rifilloni aktivizimin e saj ose kontrolloni gjendjen reale dhe zgjidhni mospërputhjet e aktivizimit në vend që të krijoni një dublikatë.