Registreer die besigheid agter jou boodskappe
'n Boodskaphandelsmerk identifiseer die besigheid wat US 10DLC-boodskappe stuur. Registreer die handelsmerk voordat jy 'n veldtoggebruiksgeval kies. Gebruik die besigheid se wettige besonderhede en 'n kontakpersoon wat enige vereiste validering kan voltooi. 'n Teruggestuurde handelsmerk-ID is nie op sigself goedkeuring om boodskappe te stuur nie.
Gebruik hierdie huidige rekeninggebonden roete oor HTTPS met 'n geaktiveerde API-rekening en sy toegelate bron-IP-adres. Moenie user_id, username of 'n ander kliënt se eienaaridentifiseerder indien nie. MultiTEL teken eienaarskap vanaf die geoutentiseerde rekening aan.
Begin met 'n eksplisiete sandbox-versoek
Die portaal verstek sy vorm na sandbox-mode; 'n direkte API-versoek moet die JSON-boolese mock: true eksplisiet insluit wanneer jy 'n nabootsingshandelsmerk bedoel. Om daardie vlag weg te laat is nie 'n sandbox-waarborg nie en kan 'n betaalbare produksieregistrasie skep. Die portaal se mode-veld is nie 'n plaasvervanger vir die API se mock-veld nie.
Berei 'n plaaslike brand.json-lêer voor met die velde hieronder. Vervang die plekhouers met gepaste toetsbesonderhede en huidige kataloguskodes. Hierdie voorbeeld is 'n privaat-winsgewende besigheid; ander entiteitstipes het verskillende vereistes.
{
"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
}Die besigheid, adres, telefoon en identifiseerder hierbo is plekhouers, nie 'n sake-identiteit wat gereed is vir registrasie nie. Kry huidige waardes vir entityType, vertical, country, state, brandRelationship en ander enumerasies vanaf die boodskapkatalogusse.
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'Besigheids- en kontakvelde
| Velde | Wat om te verskaf |
|---|---|
| entityType, displayName | Huidige entiteitstipekode en die herkenbare handelsmerknaam. Maksimum lengtes is onderskeidelik 20 en 255 karakters. |
| country, street, city, state, postalCode | Die werklike besigheidsadres. Gebruik die tweeletter-landkode en 'n huidige US state-kode waar van toepassing. Limiete: street 255, city 100, state 20 en postalCode 10 karakters. |
| email, phone | 'n Werkende kontak-e-posadres, tot 100 karakters, en 'n telefoonnommer in internasionale +landkode-formaat, tot 20 karakters. Hou besigheidsbesonderhede konsekwent oor die registrasie. |
| companyName, ein, einIssuingCountry | Vir organisasies, verskaf die wettige maatskappynaam en besigheidsbelastingidentifiseerder. Die identifiseerder se uitreikingsland is 'n aparte tweeletterveld. Limiete: companyName 255 en ein 21 karakters. 'n Alleeneienaar gebruik persoonsnaamvelde in plaas van 'n organisasie se belastingidentiteit. |
| brandRelationship, vertical | Die verhouding tot die besigheid en sy bedryf, met huidige kataloguskodes. Organisasies vereis hierdie; die alleeneienaar-reëls verskil. Moenie vertaalde vertoonetikette vir API-kodes substitueer nie. |
| firstName, lastName, mobilePhone | Vereis vir 'n alleeneienaar. Naamvelde laat tot 100 karakters elk toe. Verskaf 'n kwalifiserende selfoonnommer vir die vereiste OTP-validering, in internasionale formaat. |
| stockSymbol, stockExchange, website, businessContactEmail | 'n Openbare maatskappy benodig ook sy aandeelsimbool/beurs, website en 'n kwalifiserende besigheidskontak-e-posadres vir die bykomende valideringsproses. Limiete: stockSymbol 10, website 255 en businessContactEmail 255 karakters. |
| altBusinessIdType, altBusinessId | Opsionele alternatiewe besigheidsidentifiseerder. Verskaf sy tipe en waarde saam. Gebruik die huidige tipekatalogus; die waarde laat tot 50 karakters toe. |
| referenceId | Jou besigheidsverwysing, tot 50 karakters. Sluit dit in vir alleeneienaarregistrasie onder die huidige entiteitspesifieke vereistes. Dit is besigheidsmetadata, nie die versoek se idempotensiesleutel nie. |
| website, ipAddress, tag | Bykomende webwerf-, oorsprong-IP-metadata- en etiketwaardes waar van toepassing. Hierdie vestig nie rekeningseienaarskap nie en vervang nie identiteitskontroles nie. |
| mock | 'n JSON-boolese. Gebruik true slegs vir die beoogde nabootsingswerkvloei; gebruik false vir 'n eksplisiet nagegane produksieregistrasie. Moenie die string "false" as plaasvervanger vir 'n JSON-boolese stuur nie. |
Alleeneienaars word vir US- of Kanadese registrasies ondersteun en benodig OTP-verifikasie voor veldtogkwalifisering. Openbare maatskappye kan 'n besigheidskontak-valideringstap vereis. GOVERNMENT is vir US-gebaseerde regeringsentiteite; bevestig die korrekte entiteitskategorie vir ander organisasies. Volg die entiteitspesifieke vereistes sowel as die teruggestuurde valideringsfoute.
Behou 'n stabiele idempotensiesleutel
Genereer een Idempotency-Key vir hierdie beoogde registrasie. Dit moet 1–128 drukbare ASCII-karakters sonder spasies bevat. Hergebruik dieselfde sleutel slegs met dieselfde HTTP-metode, pad, navraagstring en presiese versoekliggaamgrepe. Herformatering van JSON, selfs sonder om die betekenis te verander, verander die versoekvingerafdruk.
'n Voltooide gesleutelde versoek kan sy gestoorde antwoord herhaal sonder nog 'n registrasie-indiening. 'n Duplikaat wat nog verwerk word, gee HTTP 409 terug en kan Retry-After insluit. 'n Gewysigde versoek met dieselfde sleutel bots. Moenie 'n nuwe sleutel genereer bloot omdat 'n versoek uitgetel het of 'n fout teruggestuur het nie: die besigheid is moontlik reeds geregistreer.
Hou brand.json onveranderd terwyl jy daardie versoek oplos. 'n Gekaste 500 of 502 kan die oorspronklike fout herhaal eerder as om die registrasie weer te probeer. Behou enige teruggestuurde brandId, requestId en korrelasieopskrifte; rekonsilieer die bestaande handelsmerk voordat jy 'n ander versoek begin.
Lees die handelsmerk en sy status
Hierdie API gebruik HTTP-statuskodes en 'n direkte JSON-liggaam, eerder as die v3-status/response-koevert. Suksesvolle registrasie gee 'n handelsmerkobjek terug wat brandId insluit. Stoor daardie identifiseerder en inspekteer die teruggestuurde validering- of identiteitstatus. Ekstra velde hang van die entiteit en registrasiestatus af.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID"Lees slegs 'n handelsmerk wat aan jou rekening behoort. 'n 404 kan beteken dat die handelsmerk nie vir hierdie rekening beskikbaar is nie. Voltooi enige vereiste validering, gebruik dan handelsmerkkwalifisering om sy beskikbare veldtoggebruiksgevalle te vind. Nabootsingshulpbronne kan nie as geskik vir produksieversending aanvaar word nie.
Produksiefooie
| Registrasie | Fooi |
|---|---|
| Standaardorganisasie | $5.00 |
| Alleeneienaar | $4.45 |
| Nabootsingshandelsmerk | Geen handelsmerkregistrasiedebiet in die nabootsingswerkvloei nie |
Hierdie kleinhandelbedrae is op 24 Oktober 2026 teen die huidige portaalopstelling nagegaan. Bevestig die huidige fooi in die portaal voor produksieregistrasie. Veldtogheffings, bykomende keuring en boodskapgebruik is apart. 'n Produksieregistrasie kontroleer aankoopmagtiging en beskikbare befondsing voor indiening; suksesvolle registrasie van die handelsmerk in die register en plaaslike fakturering is aparte verwerkingstappe, so behou die hulpbron-ID en rekonsilieer transaksies indien 'n fout of faktureringskwessie voorkom.
Om 'n nabootsingshandelsmerk na produksie te verander is 'n apart bevestigde werkvloei en kan 'n nuwe produksie-identiteit en heffing skep. Moenie aanvaar dat die wysiging van mock na false in 'n latere versoek die bestaande handelsmerk omskakel nie.
Hanteer foute sonder om die handelsmerk te dupliseer
| HTTP-resultaat | Wat om te kontroleer |
|---|---|
| 400 | Lees die veldfoute. Register-valideringsfoute kan 'n skikking van code/description-objekte wees. Plaaslike idempotensiesleutel-validering kan ook 400 teruggee. |
| 401, 403 of 404 | Kontroleer API-aanmeldbesonderhede, die API-rekening se toegelate bron-IP, kliëntmagtigings en eienaarskap. 'n Registerantwoord kan ook sy eie magtigingsfout dra. |
| 402 | Hersien befondsing en aankoopmagtiging. Moenie 'n onbefondsde produksieversoek as 'n sandbox-toets behandel nie. |
| 409 | Behou dieselfde sleutel en onveranderde versoek terwyl jy vir 'n versoek in verwerking wag. 'n Gewysigde liggaam/sleutel-konflik of 'n onherstelbare vorige antwoord benodig eerstens rekonsiliasie. |
| 429 of 'n beperker-onbeskikbare antwoord | Eer Retry-After wanneer teenwoordig. Probeer dieselfde beoogde versoek en sleutel weer nadat die limiet uitgeklaar het. |
| 500 of 502 | Die afgeleë bewerking is moontlik aanvaar. 'n Plaaslike-verwerkingsfout kan requestId insluit. Stoor dit en kontroleer die bestaande hulpbron; moenie aanvaar dat 'n vervangingsregistrasie nodig is nie. |