Arendajad

POST/tcr/v2/campaignBuilder

Registreerige 10DLC kampaania

Esitage kvalifitseeritud kampaania ning eristage registri registreerimine operaatori aktiveerimisest ja saatmisvalmidusest.

Sellel lehel
  1. Kvalifitseerige bränd enne selle kampaania registreerimist
  2. Hoidke liivakast ja tootmiskeskkond lahus
  3. Esitage kampaania JSON
  4. Kampaania väljad ja tingimuslikud nõuded
  5. Korrake sama kavandatud päringut ohutult
  6. Kampaania ID ei ole lõplik saatmisseadistus
  7. Tootmiskampaaniate tasud
  8. Käsitlege valideerimis- ja osalisi tõrkeid

Kvalifitseerige bränd enne selle kampaania registreerimist

10DLC kampaania kirjeldab sõnumeid, mida registreeritud ettevõte kavatseb saata, kuidas saajad nõusolekut annavad ning kuidas nad saavad abi või sõnumitest loobuda. Käesolev API loob registrikirje; tootmiskeskkonna operaatori aktiveerimise lõpuleviimine on eraldi konto seadistamise samm. Kasutage oma omandis olevat brändi jaotisest brändi registreerimine, seejärel laadige selle saadaolevad kasutusjuhud ja valitud kasutusjuhtumi kehtivad nõuded.

Kasutage kehtivat kvalifitseerimistulemust alamkasutusjuhtude, sobivate võrguidentifikaatorite, sõnuminäidiste ning liitumis-, loobumis- ja abideklaratsioonide valimiseks. Nõuded võivad bränditi ja võrguti erineda. Ärge esitage näite identifikaatoreid ega kopeerige selle nõusolekukirjeldust teistsuguse protsessiga ettevõtte jaoks.

Hoidke liivakast ja tootmiskeskkond lahus

Liivakasti harjutuseks kasutage oma testbrändi ja kehtivat kasutusjuhtu, mille jaoks see kvalifitseerub. Kasutage väärtust TRIAL ainult siis, kui see kvalifitseerimine seda pakub. Portaal kontrollib, et valitud brändi ja kampaania keskkond ühtiksid. Otsene API-päring ei käivita teie eest portaali täielikku viisardi valideerimist, seega säilitage see eristus oma integratsioonis.

Tootmiskampaania loomine on tasuline ega muuda numbrit automaatselt saatmiseks valmis. Hoidke kampaania keskkond selle brändiga kooskõlas ning vaadake enne reaalse kampaania loomist üle tasu ja kohaldatavad tingimused.

Esitage kampaania JSON

Valmistage ette campaign.json oma kvalifitseeritud väärtustega. R000000 tähendab edasimüüja puudumist; kasutage seda ainult siis, kui see on soovitud konfiguratsioon. Tavalise MultiTEL edasimüüjakonfiguratsiooni korral hankige lubatud MultiTEL LLC edasimüüja identifikaator oma konto edasimüüjate kogust või portaali ettevalmistusvoost, selle asemel et kõvakodeerida kellegi teise identifikaator.

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

Järgnev JSON illustreerib teie omandis oleva testbrändi proovikampaaniat. Asendage bränd, kasutusjuht, edasimüüja ja nõusolekutekst väärtustega, mis teie testi jaoks tegelikult kvalifitseeruvad.

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

Määrake termsAndConditions väärtuseks true alles pärast seda, kui volitatud isik on kohaldatavad tingimused läbi vaadanud ja aktsepteerinud. Näide ei ole teie eest antud nõusolek. Kasutage lippude jaoks JSON-i tõeväärtusi, mitte jutumärkides sõnesid.

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'

Kampaania väljad ja tingimuslikud nõuded

10DLC kampaania päring
VäljadMida esitada
brandId, channelId, usecaseTeie omandis olev bränd, kanal 10DLC ja sobiv kehtiv kasutusjuhtumi kood. Kasutage kvalifitseerimisest saadud koode, mitte tõlgitud silte.
subUsecasesSobivate alamkasutusjuhtude koodide massiiv. Järgige valitud kvalifitseerimise minimaalset ja maksimaalset arvu.
resellerIdLubatud edasimüüja identifikaator. Kontole kuuluv marsruut aktsepteerib omandis olevaid edasimüüjaid, selle konfigureeritud jagatud edasimüüjat või teadlikku edasimüüjata väärtust. Seosetu edasimüüja lükatakse tagasi.
description, messageFlowKirjeldage tegelikku eesmärki ja seda, kuidas nõusolekut kogutakse. Mõlemad peavad sisaldama 40–4096 tähemärki. Lisage tegelik kasutajatoiming, vorm või protsess; ärge leiutage nõusolekut, mida teie rakendus ei kogu.
sample1 … sample5Esinduslikud sõnumid, tavaliselt 20–1024 tähemärki kumbki. Portaal nõuab vähemalt ühte; sobivad võrgud võivad nõuda rohkem. Esitage arv, mida kehtiv kvalifitseerimine nõuab.
subscriberOptin, subscriberOptout, subscriberHelpDeklareerige toetatud saajavood nende täpsete väljanimede abil. Kui voog on lubatud, esitage selle märksõna- ja sõnumiväljad. Võrgunõuded võivad muuta teatud vood kohustuslikuks.
optinKeywords, optoutKeywords, helpKeywordsTegelikud tuvastatavad märksõnad, kuni 255 tähemärki. Need peavad vastama vastuvõtva rakenduse käitumisele.
optinMessage, optoutMessage, helpMessageVastavad sõnumid. Kehtivad avaldatud väljareeglid näevad ette 20–1024 tähemärki. Lisage tegelik tugi- ja loobumiskäitumine.
embeddedLink, embeddedPhone, embeddedLinkSampleDeklareerige manustatud lingid või telefoninumbrid tõepäraselt. Muidu kvalifitseeruv võrk võib need keelata. Linginäidis lubab kuni 255 tähemärki.
mnoIdsValikuline sobivate numbriliste võrguidentifikaatorite massiiv kvalifitseerimisest. Ärge eeldage, et iga võrk toetab valitud kasutusjuhtu.
numberPool, ageGated, directLendingKohaldatavad kampaania omadused JSON-i tõeväärtustena. Valige need vastavalt tegelikule teenusele.
privacyPolicyLink, termsAndConditionsLinkTeie asjakohased avaliku poliitika ja tingimuste URL-id, kui need on kohaldatavad, kuni 2048 tähemärki kumbki. Need peavad kirjeldama tegelikku sõnumsideteenust.
termsAndConditionsKohaldatavate kampaaniatingimuste selgesõnaline aktsepteerimine. Portaal nõuab väärtust true ning selle viisard kogub ka kehtivad individuaalsed kinnitused.
autoRenewalKas kampaania uueneb. Vaikeväärtus on true. Uuendamise keelamine ei eemalda tootmiskampaaniaga juba seotud miinimumkohustust.
referenceId, tagTeie kampaania viide, kuni 50 tähemärki, ja valikulised sildid. referenceId ei ole Idempotency-Key päis.

Avaldatud skeem sisaldab kirjeldavates tabelites mõningast ebaühtlast suurtähtede kasutust. Kehtiv portaali päring kasutab ülaltoodud viisil välju subscriberOptin ja subscriberOptout. Säilitage täpselt see suurtähtede kasutus. Käesolev juhend hõlmab üürnikule suunatud 10DLC töövoogu; ärge järeldage, et teise kanali nõutavad väljad või aktiveerimissammud on samad.

Korrake sama kavandatud päringut ohutult

Kasutage selle kavandatud loomise jaoks üht Idempotency-Key võtit. Võti on 1–128 prinditavat ASCII tähemärki ilma tühikuteta ja on seotud omanikukontoga. Hoidke korduskatsel HTTP-meetod, tee, päringu osa ja täpsed päringu keha baidid muutmata. Ümbervormindatud JSON-fail põhjustab konflikti isegi siis, kui selle väärtused on samaväärsed.

Pooleliolev duplikaat võib tagastada HTTP 409 koos päisega Retry-After; lõpetatud päringud võivad taasesitada oma salvestatud vastuse. Vahemällu salvestatud viga ei tõesta, et register ei loonud midagi. Salvestage campaignId, requestId ja kõik korrelatsioonipäised, kontrollige olemasolevat kampaaniat ning kontrollige tegelikku olekut ja lahendage osalisest tõrkest tekkinud lahknevused enne uue võtme kaalumist.

Kampaania ID ei ole lõplik saatmisseadistus

Vastus kasutab HTTP-olekut ja otsest JSON-i. Eduka loomise korral säilitage campaignId ja lugege selle kehtivat olekut:

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

Portaali kehtiv tootmistöövoog jagab kampaaniat ka sõnumside operaatoriga ning laadib brändi/kampaania saatvasse kontosse. Need on sellest avalikust loomiskutsest eraldi toimingud. Registri kampaania võib eksisteerida isegi siis, kui hilisem jagamis- või operaatorisse laadimise samm ebaõnnestub.

Kasutage portaali integreeritud tootmisloomise töövoogu, kui vajate kombineeritud registreerimise, jagamise ja operaatorisse laadimise jada. Selle API kaudu otse juba loodud tootmiskampaania korral säilitage selle kampaania ID ja laske konto operaatoriseadistus toe kaudu kooskõlla viia. Kehtiv kliendi kasutajaliides ei paku üldist jätkamisnuppu iga otse loodud tootmiskampaania jaoks. Ärge looge selle aktiveerimise kordamiseks uut registreeringut. Kinnitage, et kampaania on aktiivne ja operaatori seadistus on lõpule viidud, enne saatjanumbri määramist. Telefoninumber peab olema ka omandis olev, aktiivne ja SMS-iga saatmiseks lubatud. Kampaania loomine sõnumeid ei saada.

Tootmiskampaaniate tasud

Kehtivad konfigureeritud igakuised kampaaniatasud
KasutusjuhtIgakuine tasu
LOW_VOLUME, UCAAS_LOW$1.67
SOLE_PROPRIETOR$2.23
CHARITY$3.34
EMERGENCY$5.56
AGENTS_FRANCHISES$33.34
Muud konfigureeritud varu-kasutusjuhud$11.12

Neid jaehindasid kontrolliti kehtiva portaali konfiguratsiooni alusel 24. oktoobril 2026. Kinnitage enne tootmiskeskkonna esitamist kehtiv kvalifitseeritud kasutusjuht ja kuvatav hind. monthlyFee registri kvalifitseerimisvastuses ei ole automaatselt teie MultiTEL jaehind.

Kehtiv portaal sätestab mittepoliitiliste tootmiskampaaniate jaoks kolmekuulise miinimumkohustuse. Vaadake enne kinnitamist üle kohaldatavad tingimused ja uuendamisvalik. Registreerimine, numbri rent, täiendav taustakontroll ja sõnumikasutus on eraldi tasud. Edukas loomise vastus ei tõesta iseseisvalt, et kõik arveldus- või operaatori aktiveerimise sammud on lõpule viidud.

Käsitlege valideerimis- ja osalisi tõrkeid

Lugege HTTP status ja tagastatud JSON-i. Valideerimistõrked võivad olla code/description objektide massiivid; kohalikud tõrked võivad selle asemel olla objektid väljadega message, status ja mõnede töötlemisvigade korral requestId.

Kampaania tõrked
HTTP tulemusJärgmine toiming
400Parandage konkreetsed väljad või idempotentsusvõti. Lugege uuesti kehtivat kvalifitseerimist, nõutavat näidiste arvu ja saajavoogude nõudeid.
401, 403 või 404Kontrollige API mandaate ja lubatud lähte-IP-d, seejärel brändi/edasimüüja omandit ja õigusi. Ärge kasutage teise konto identifikaatoreid.
402Vaadake enne sama kavandatud loomise kordamist üle tootmise rahastamine ja ostuõigus.
409Eristage poolelioleva taasesitust sama võtit kasutavast muudetud päringust. Säilitage kooskõlla viimisel olemasoleva kampaania ja päringu üksikasjad.
429 või piiraja pole saadavalJärgige päist Retry-After, kui see on antud, ning säilitage algne võti ja täpne päring.
500 või 502Loomine võib olla juba toimunud. Salvestage kõik campaignId ja requestId, kontrollige olemasolevat kampaaniat ning jätkake või viige kooskõlla selle aktiveerimine, selle asemel et luua duplikaat.