Reģistrējiet uzņēmumu, kas sūta jūsu ziņojumus
Ziņojumapmaiņas zīmols identificē uzņēmumu, kas sūta US 10DLC ziņojumus. Reģistrējiet zīmolu pirms kampaņas lietošanas gadījuma izvēles. Izmantojiet uzņēmuma juridiskos datus un kontaktpersonu, kas var pabeigt nepieciešamo validāciju. Atgrieztais zīmola ID pats par sevi nav atļauja sūtīt ziņojumus.
Izmantojiet šo pašreizējo kontam piederošo maršrutu HTTPS savienojumā ar iespējotu API kontu un tā atļauto avota IP adresi. Neiesniedziet user_id, username vai cita klienta īpašnieka identifikatoru. MultiTEL reģistrē īpašumtiesības no autentificētā konta.
Sāciet ar nepārprotamu smilškastes pieprasījumu
Portāls pēc noklusējuma izvēlas smilškastes režīmu veidlapas mode laukā; tiešam API pieprasījumam nepārprotami jāiekļauj JSON Būla vērtība mock: true, ja paredzat testa zīmolu. Karodziņa izlaišana negarantē smilškasti un var izveidot apmaksājamu produkcijas reģistrāciju. Portāla mode lauks neaizstāj API mock lauku.
Sagatavojiet vietējo brand.json failu, izmantojot tālāk norādītos laukus. Aizstājiet vietturus ar atbilstošiem testa datiem un aktuālajiem katalogu kodiem. Šis piemērs ir privāts peļņas uzņēmums; citiem entītiju veidiem ir atšķirīgas prasības.
{
"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
}Iepriekš norādītais uzņēmums, adrese, tālrunis un identifikators ir vietturi, nevis reģistrācijai gatava uzņēmuma identitāte. Aktuālās vērtības laukiem entityType, vertical, country, state, brandRelationship un citām uzskaitēm skatiet ziņojumapmaiņas katalogus.
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'Uzņēmuma un kontaktinformācijas lauki
| Lauki | Kas jānorāda |
|---|---|
| entityType, displayName | Aktuālais entītijas veida kods un atpazīstamais zīmola nosaukums. Maksimālais garums ir attiecīgi 20 un 255 rakstzīmes. |
| country, street, city, state, postalCode | Faktiskā uzņēmuma adrese. Izmantojiet divu burtu valsts kodu un, ja piemērojams, aktuālo US state kodu. Ierobežojumi: street 255, city 100, state 20 un postalCode 10 rakstzīmes. |
| email, phone | Derīga kontaktpersonas e-pasta adrese līdz 100 rakstzīmēm un tālruņa numurs starptautiskā +valsts koda formātā līdz 20 rakstzīmēm. Visā reģistrācijā saglabājiet uzņēmuma datu konsekvenci. |
| companyName, ein, einIssuingCountry | Organizācijām norādiet juridisko uzņēmuma nosaukumu un uzņēmuma nodokļu identifikatoru. Identifikatora izdevējvalsts ir atsevišķs divu burtu lauks. Ierobežojumi: companyName 255 un ein 21 rakstzīme. Individuālais komersants personas vārda laukus izmanto organizācijas nodokļu identitātes vietā. |
| brandRelationship, vertical | Saistība ar uzņēmumu un tā nozari, izmantojot aktuālos katalogu kodus. Organizācijām tie ir obligāti; individuālā komersanta noteikumi atšķiras. Neaizstājiet API kodus ar tulkotiem attēlojamiem nosaukumiem. |
| firstName, lastName, mobilePhone | Obligāti individuālajam komersantam. Vārda laukos atļautas līdz 100 rakstzīmēm katrā. Norādiet atbilstošu mobilā tālruņa numuru nepieciešamajai OTP validācijai starptautiskā formātā. |
| stockSymbol, stockExchange, website, businessContactEmail | Biržā kotētam uzņēmumam papildu validācijas procesam nepieciešami arī akciju simbols un birža, website un atbilstošs uzņēmuma kontakta e-pasts. Ierobežojumi: stockSymbol 10, website 255 un businessContactEmail 255 rakstzīmes. |
| altBusinessIdType, altBusinessId | Neobligāts alternatīvs uzņēmuma identifikators. Norādiet tā veidu un vērtību kopā. Izmantojiet aktuālo veidu katalogu; vērtībā atļautas līdz 50 rakstzīmēm. |
| referenceId | Jūsu uzņēmuma atsauce līdz 50 rakstzīmēm. Iekļaujiet to individuālā komersanta reģistrācijā saskaņā ar aktuālajām entītijai specifiskajām prasībām. Tie ir uzņēmuma metadati, nevis pieprasījuma idempotences atslēga. |
| website, ipAddress, tag | Papildu tīmekļa vietne, izcelsmes IP metadati un atzīmju vērtības, ja piemērojams. Tie nenodibina konta īpašumtiesības un neaizstāj identitātes pārbaudes. |
| mock | JSON Būla vērtība. Izmantojiet true tikai paredzētajai testa darbplūsmai; izmantojiet false nepārprotami pārbaudītai produkcijas reģistrācijai. Nesūtiet virkni "false" kā JSON Būla vērtības aizstājēju. |
Individuālie komersanti ir atbalstīti US vai Kanādas reģistrācijām un pirms kampaņas atbilstības tiem nepieciešama OTP verifikācija. Biržā kotētiem uzņēmumiem var būt nepieciešams uzņēmuma kontakta validācijas solis. GOVERNMENT ir paredzēts US valdības entītijām; citām organizācijām apstipriniet pareizo entītijas kategoriju. Ievērojiet entītijai specifiskās prasības, kā arī atgrieztās validācijas kļūdas.
Saglabājiet stabilu idempotences atslēgu
Izveidojiet vienu Idempotency-Key šai paredzētajai reģistrācijai. Tai jāsatur 1–128 drukājamas ASCII rakstzīmes bez atstarpēm. To pašu atslēgu atkārtoti izmantojiet tikai ar to pašu HTTP metodi, ceļu, vaicājuma virkni un tieši tiem pašiem pieprasījuma pamatteksta baitiem. JSON pārformatēšana, pat nemainot tā nozīmi, maina pieprasījuma pirkstu nospiedumu.
Pabeigts pieprasījums ar atslēgu var atkārtot saglabāto atbildi bez citas reģistrācijas iesniegšanas. Dublikāts, kas vēl tiek apstrādāts, atgriež HTTP 409 un var ietvert Retry-After. Mainīts pieprasījums ar to pašu atslēgu konfliktē. Neveidojiet jaunu atslēgu tikai tāpēc, ka pieprasījuma noildze iestājās vai tika atgriezta kļūda: uzņēmums, iespējams, jau ir reģistrēts.
Atrisinot šo pieprasījumu, nemainiet brand.json. Kešota 500 vai 502 kļūda var atkārtot sākotnējo kļūdu, nevis mēģināt reģistrāciju vēlreiz. Saglabājiet visus atgrieztos brandId, requestId un korelācijas galvenes; pirms cita pieprasījuma sākšanas pārbaudiet esošā zīmola faktisko stāvokli un novērsiet neatbilstības.
Lasiet zīmolu un tā statusu
Šis API izmanto HTTP statusa kodus un tiešu JSON pamattekstu, nevis v3 status/response aploksni. Veiksmīga reģistrācija atgriež zīmola objektu, tostarp brandId. Saglabājiet šo identifikatoru un pārbaudiet atgriezto validācijas vai identitātes statusu. Papildu lauki ir atkarīgi no entītijas un reģistrācijas stāvokļa.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID"Lasiet tikai savam kontam piederošu zīmolu. 404 var nozīmēt, ka zīmols šim kontam nav pieejams. Pabeidziet nepieciešamo validāciju un pēc tam izmantojiet zīmola kvalifikāciju, lai atrastu tā pieejamos kampaņas lietošanas gadījumus. Testa resursus nevar uzskatīt par atbilstošiem produkcijas sūtīšanai.
Produkcijas maksas
| Reģistrācija | Maksa |
|---|---|
| Standarta organizācija | $5.00 |
| Individuālais komersants | $4.45 |
| Testa zīmols | Nav zīmola reģistrācijas debeta testa darbplūsmā |
Šīs mazumtirdzniecības summas tika pārbaudītas pēc pašreizējās portāla konfigurācijas 24. oktobrī 2026. gadā. Pirms produkcijas reģistrācijas apstipriniet aktuālo maksu portālā. Kampaņas maksas, papildu pārbaude un ziņojumapmaiņas lietojums ir atsevišķi. Produkcijas reģistrācija pirms iesniegšanas pārbauda pirkšanas atļauju un pieejamo finansējumu; veiksmīga zīmola izveide reģistrā un vietējā norēķināšana ir atsevišķi apstrādes soļi, tāpēc saglabājiet resursa ID un saskaņojiet darījumus, ja rodas kļūda vai norēķinu problēma.
Testa zīmola mainīšana uz produkciju ir atsevišķi apstiprināma darbplūsma un var izveidot jaunu produkcijas identitāti un maksu. Nepieņemiet, ka mock rediģēšana uz false vēlākā pieprasījumā pārveido esošo zīmolu.
Apstrādājiet kļūdas, nedublējot zīmolu
| HTTP rezultāts | Kas jāpārbauda |
|---|---|
| 400 | Lasiet lauku kļūdas. Reģistra validācijas kļūdas var būt code/description objektu masīvs. Arī lokālā idempotences atslēgas validācija var atgriezt 400. |
| 401, 403 vai 404 | Pārbaudiet API akreditācijas datus, API konta atļauto avota IP, klienta atļaujas un īpašumtiesības. Reģistra atbilde var saturēt arī savu autorizācijas kļūdu. |
| 402 | Pārskatiet finansējumu un pirkšanas atļauju. Neuzskatiet nefinansētu produkcijas pieprasījumu par smilškastes testu. |
| 409 | Gaidot pieprasījumu, kas tiek apstrādāts, saglabājiet to pašu atslēgu un nemainītu pieprasījumu. Mainīta pamatteksta/atslēgas konflikts vai neatgūstama iepriekšējā atbilde vispirms prasa faktiskā stāvokļa pārbaudi un neatbilstību novēršanu. |
| 429 vai ierobežotāja nepieejamības atbilde | Ja ir norādīts, ievērojiet Retry-After. Pēc ierobežojuma atcelšanas atkārtojiet to pašu paredzēto pieprasījumu un atslēgu. |
| 500 vai 502 | Attālā darbība, iespējams, ir pieņemta. Vietējās apstrādes kļūda var ietvert requestId. Saglabājiet to un pārbaudiet esošo resursu; nepieņemiet, ka nepieciešama aizstājoša reģistrācija. |