Registruokite verslą, slypintį už jūsų pranešimų
Pranešimų prekės ženklas nurodo verslą, siunčiantį US 10DLC pranešimus. Užregistruokite prekės ženklą prieš pasirinkdami kampanijos naudojimo atvejį. Naudokite teisinius verslo duomenis ir kontaktą, kuris gali atlikti reikiamą patvirtinimą. Grąžintas prekės ženklo ID savaime nėra leidimas siųsti pranešimus.
Naudokite šį dabartinį paskyrai priklausantį maršrutą per HTTPS su įjungta API paskyra ir jos leidžiamu šaltinio IP adresu. Nepateikite user_id, username ar kito kliento savininko identifikatoriaus. MultiTEL nuosavybę fiksuoja iš autentifikuotos paskyros.
Pradėkite nuo aiškios smėlio dėžės užklausos
Portalo formos lauke mode pagal numatytuosius nustatymus parinktas smėlio dėžės režimas; tiesioginė API užklausa, kai ketinate sukurti bandomąjį prekės ženklą, turi aiškiai nurodyti JSON loginę reikšmę mock: true. Šios vėliavėlės praleidimas negarantuoja smėlio dėžės ir gali sukurti apmokestinamą gamybinę registraciją. Portalo laukas mode nepakeičia API lauko mock.
Parenkite vietinį failą brand.json, naudodami toliau nurodytus laukus. Pakeiskite rezervuotas vietas tinkamais bandomaisiais duomenimis ir dabartiniais katalogų kodais. Šis pavyzdys yra privataus pelno verslas; kitų subjektų tipams taikomi kitokie reikalavimai.
{
"entityType": "PRIVATE_PROFIT",
"displayName": "Example business",
"companyName": "Example legal business name",
"ein": "YOUR_TAX_ID",
"einIssuingCountry": "US",
"phone": "+12025550123",
"street": "123 Example Street",
"city": "Example City",
"state": "NY",
"postalCode": "10001",
"country": "US",
"email": "contact@example.invalid",
"brandRelationship": "BASIC_ACCOUNT",
"vertical": "CURRENT_VERTICAL_CODE",
"referenceId": "your-business-reference",
"mock": true
}Aukščiau pateiktas verslas, adresas, telefonas ir identifikatorius yra rezervuotos vietos, o ne registracijai paruošta verslo tapatybė. Dabartines entityType, vertical, country, state, brandRelationship ir kitų išvardijų reikšmes gaukite iš pranešimų katalogų.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--data-binary @brand.json \
'https://api.multitel.net/tcr/v2/brand/nonBlocking'Verslo ir kontaktiniai laukai
| Laukai | Ką pateikti |
|---|---|
| entityType, displayName | Dabartinis subjekto tipo kodas ir atpažįstamas prekės ženklo pavadinimas. Maksimalūs ilgiai yra atitinkamai 20 ir 255 simboliai. |
| country, street, city, state, postalCode | Tikrasis verslo adresas. Kai taikoma, naudokite dviejų raidžių šalies kodą ir dabartinį US state kodą. Apribojimai: street – 255, city – 100, state – 20 ir postalCode – 10 simbolių. |
| email, phone | Veikiantis kontaktinis el. paštas iki 100 simbolių ir telefono numeris tarptautiniu +šalies kodo formatu iki 20 simbolių. Visoje registracijoje išlaikykite nuoseklius verslo duomenis. |
| companyName, ein, einIssuingCountry | Organizacijoms pateikite teisinį įmonės pavadinimą ir verslo mokesčių identifikatorių. Identifikatoriaus išdavimo šalis yra atskiras dviejų raidžių laukas. Apribojimai: companyName – 255 ir ein – 21 simbolis. Individualus verslininkas vietoj organizacijos mokesčių tapatybės naudoja asmenvardžių laukus. |
| brandRelationship, vertical | Ryšys su verslu ir jo pramonės šaka, naudojant dabartinius katalogų kodus. Organizacijoms jie privalomi; individualaus verslininko taisyklės skiriasi. Nepakeiskite API kodų išverstomis rodymo etiketėmis. |
| firstName, lastName, mobilePhone | Privaloma individualiam verslininkui. Vardų laukai leidžia iki 100 simbolių kiekvienas. Pateikite tinkamą mobiliojo telefono numerį reikiamam OTP patvirtinimui tarptautiniu formatu. |
| stockSymbol, stockExchange, website, businessContactEmail | Bendrovei, kurios akcijomis prekiaujama viešai, papildomam patvirtinimo procesui taip pat reikia akcijų simbolio/biržos, website ir tinkamo verslo kontaktinio el. pašto. Apribojimai: stockSymbol – 10, website – 255 ir businessContactEmail – 255 simboliai. |
| altBusinessIdType, altBusinessId | Neprivalomas alternatyvus verslo identifikatorius. Pateikite jo tipą ir reikšmę kartu. Naudokite dabartinį tipų katalogą; reikšmė leidžia iki 50 simbolių. |
| referenceId | Jūsų verslo nuoroda iki 50 simbolių. Įtraukite ją registruodami individualų verslininką pagal dabartinius subjektui taikomus reikalavimus. Tai verslo metaduomenys, o ne užklausos idempotentumo raktas. |
| website, ipAddress, tag | Papildoma svetainė, kilmės IP metaduomenys ir žymų reikšmės, kai taikoma. Tai nenustato paskyros nuosavybės ir nepakeičia tapatybės patikrinimų. |
| mock | JSON loginė reikšmė. Naudokite true tik numatytai bandomajai darbo eigai; naudokite false aiškiai peržiūrėtai gamybinei registracijai. Nesiųskite eilutės "false" kaip JSON loginės reikšmės pakaitalo. |
Individualūs verslininkai palaikomi US arba Kanados registracijoms ir prieš įgydami teisę į kampaniją turi atlikti OTP patvirtinimą. Bendrovėms, kurių akcijomis prekiaujama viešai, gali reikėti verslo kontaktinio patvirtinimo veiksmo. GOVERNMENT skirta US įsikūrusiems valdžios subjektams; kitoms organizacijoms patvirtinkite tinkamą subjekto kategoriją. Laikykitės subjektui taikomų reikalavimų ir grąžintų patvirtinimo klaidų.
Išlaikykite stabilų idempotentumo raktą
Sugeneruokite vieną Idempotency-Key šiai numatytai registracijai. Jame turi būti 1–128 spausdinami ASCII simboliai be tarpų. Tą patį raktą naudokite pakartotinai tik su tuo pačiu HTTP metodu, keliu, užklausos eilute ir tiksliais užklausos turinio baitais. JSON performatavimas, net nekeičiant jo reikšmės, pakeičia užklausos kontrolinį atspaudą.
Užbaigta raktu pažymėta užklausa gali pakartoti išsaugotą atsakymą be kitos registracijos pateikimo. Vis dar apdorojamas dublikatas grąžina HTTP 409 ir gali nurodyti Retry-After. Pakeista užklausa su tuo pačiu raktu konfliktuoja. Negeneruokite naujo rakto vien todėl, kad užklausa pasibaigė arba grąžino klaidą: verslas gali būti jau užregistruotas.
Kol sprendžiate šią užklausą, nekeiskite brand.json. Talpykloje saugomas 500 arba 502 gali pakartoti pradinę klaidą, o ne pakartoti registraciją. Išsaugokite visus grąžintus brandId, requestId ir koreliacijos antraštes; prieš pradėdami kitą užklausą, patikrinkite faktinę esamo prekės ženklo būseną ir pašalinkite neatitikimus.
Skaitykite prekės ženklą ir jo būseną
Ši API naudoja HTTP būsenos kodus ir tiesioginį JSON turinį, o ne v3 status/response voką. Sėkminga registracija grąžina prekės ženklo objektą, įskaitant brandId. Išsaugokite šį identifikatorių ir patikrinkite grąžintą patvirtinimo arba tapatybės būseną. Papildomi laukai priklauso nuo subjekto ir registracijos būsenos.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID"Skaitykite tik jūsų paskyrai priklausantį prekės ženklą. 404 gali reikšti, kad prekės ženklas nepasiekiamas šiai paskyrai. Užbaikite reikiamą patvirtinimą, tada naudokite prekės ženklo kvalifikavimą, kad rastumėte galimus jo kampanijos naudojimo atvejus. Negalima manyti, kad bandomieji ištekliai tinkami gamybiniam siuntimui.
Gamybiniai mokesčiai
| Registracija | Mokestis |
|---|---|
| Standartinė organizacija | $5.00 |
| Individualus verslininkas | $4.45 |
| Bandomasis prekės ženklas | Bandomojoje darbo eigoje prekės ženklo registracijos nurašymo nėra |
Šios mažmeninės sumos buvo patikrintos pagal dabartinę portalo konfigūraciją spalio 24 d., 2026 m. Prieš gamybinę registraciją patvirtinkite dabartinį mokestį portale. Kampanijos mokesčiai, papildomas tikrinimas ir pranešimų naudojimas yra atskiri. Gamybinė registracija prieš pateikimą patikrina pirkimo leidimą ir turimą finansavimą; sėkmingas prekės ženklo sukūrimas registre ir vietinis atsiskaitymas yra atskiri apdorojimo veiksmai, todėl išsaugokite ištekliaus ID ir patikrinkite operacijas ir pašalinkite neatitikimus, jei įvyksta klaida ar atsiskaitymo problema.
Bandomojo prekės ženklo keitimas į gamybinį yra atskirai patvirtinama darbo eiga ir gali sukurti naują gamybinę tapatybę bei mokestį. Nemanykite, kad mock redagavimas į false vėlesnėje užklausoje konvertuoja esamą prekės ženklą.
Tvarkykite klaidas nedubliuodami prekės ženklo
| HTTP rezultatas | Ką patikrinti |
|---|---|
| 400 | Skaitykite laukų klaidas. Registro patvirtinimo klaidos gali būti code/description objektų masyvas. Vietinis idempotentumo rakto patvirtinimas taip pat gali grąžinti 400. |
| 401, 403 arba 404 | Patikrinkite API kredencialus, API paskyros leidžiamą šaltinio IP, kliento leidimus ir nuosavybę. Registro atsakyme taip pat gali būti jo paties autorizacijos klaida. |
| 402 | Peržiūrėkite finansavimą ir pirkimo leidimą. Nelaikykite nefinansuotos gamybinės užklausos smėlio dėžės testu. |
| 409 | Laukdami vykdomos užklausos, išlaikykite tą patį raktą ir nepakeistą užklausą. Pakeisto turinio/rakto konfliktas arba neatkuriamas ankstesnis atsakymas pirmiausia reikalauja faktinės būsenos patikros ir neatitikimų pašalinimo. |
| 429 arba ribotuvo nepasiekiamas atsakas | Laikykitės Retry-After, kai jis pateiktas. Pakartokite tą pačią numatytą užklausą ir raktą, kai apribojimas išnyksta. |
| 500 arba 502 | Nuotolinė operacija galėjo būti priimta. Vietinio apdorojimo klaidoje gali būti requestId. Išsaugokite jį ir patikrinkite esamą išteklių; nemanykite, kad reikia pakaitinės registracijos. |