Regjistroni biznesin që qëndron pas mesazheve tuaja
Një markë mesazhesh identifikon biznesin që dërgon mesazhe 10DLC në SHBA. Regjistroni markën përpara se të zgjidhni një rast përdorimi për fushatën. Përdorni të dhënat ligjore të biznesit dhe një kontakt që mund të përfundojë çdo validim të kërkuar. Një ID marke e kthyer nuk përbën, në vetvete, miratim për dërgimin e mesazheve.
Përdorni këtë rrugë aktuale në pronësi të llogarisë përmes HTTPS me një llogari API të aktivizuar dhe adresën e saj IP burimore të lejuar. Mos dërgoni user_id, username apo identifikuesin e pronarit të një klienti tjetër. MultiTEL e regjistron pronësinë nga llogaria e autentikuar.
Filloni me një kërkesë sandbox të qartë
Portali e vendos si parazgjedhje fushën mode të formularit të tij në sandbox; një kërkesë e drejtpërdrejtë API duhet të përfshijë shprehimisht vlerën booleane JSON mock: true kur synoni një markë mock. Mungesa e këtij flamuri nuk është garanci sandbox dhe mund të krijojë një regjistrim prodhimi të faturueshëm. Fusha mode e portalit nuk zëvendëson fushën mock të API-t.
Përgatitni një skedar lokal brand.json duke përdorur fushat më poshtë. Zëvendësoni vendmbajtësit me të dhëna testuese të përshtatshme dhe kode aktuale të katalogut. Ky shembull është një biznes privat fitimprurës; llojet e tjera të entiteteve kanë kërkesa të ndryshme.
{
"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
}Biznesi, adresa, telefoni dhe identifikuesi më sipër janë vendmbajtës, jo një identitet biznesi gati për regjistrim. Merrni vlerat aktuale për entityType, vertical, country, state, brandRelationship dhe enumerimet e tjera nga katalogët e mesazheve.
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'Fushat e biznesit dhe të kontaktit
| Fushat | Çfarë duhet dhënë |
|---|---|
| entityType, displayName | Kodi aktual i llojit të entitetit dhe emri i njohshëm i markës. Gjatësitë maksimale janë përkatësisht 20 dhe 255 karaktere. |
| country, street, city, state, postalCode | Adresa reale e biznesit. Përdorni kodin e shtetit me dy shkronja dhe një kod aktual state të SHBA-së kur është e zbatueshme. Kufijtë: street 255, city 100, state 20 dhe postalCode 10 karaktere. |
| email, phone | Një email kontakti funksional, deri në 100 karaktere, dhe një numër telefoni në format ndërkombëtar me +kod shteti, deri në 20 karaktere. Mbani të dhënat e biznesit të njëtrajtshme në të gjithë regjistrimin. |
| companyName, ein, einIssuingCountry | Për organizatat, jepni emrin ligjor të kompanisë dhe identifikuesin tatimor të biznesit. Shteti lëshues i identifikuesit është një fushë e veçantë me dy shkronja. Kufijtë: companyName 255 dhe ein 21 karaktere. Një sipërmarrës individual përdor fushat e emrit personal në vend të identitetit tatimor të një organizate. |
| brandRelationship, vertical | Marrëdhënia me biznesin dhe industria e tij, duke përdorur kodet aktuale të katalogut. Organizatat i kërkojnë këto; rregullat për sipërmarrësit individualë ndryshojnë. Mos i zëvendësoni kodet e API-t me etiketa shfaqjeje të përkthyera. |
| firstName, lastName, mobilePhone | E detyrueshme për një sipërmarrës individual. Fushat e emrit lejojnë deri në 100 karaktere secila. Jepni një numër celulari të pranueshëm për validimin e detyrueshëm OTP, në format ndërkombëtar. |
| stockSymbol, stockExchange, website, businessContactEmail | Një kompani e listuar në bursë ka nevojë gjithashtu për simbolin/bursën e saj të aksioneve, website dhe një email kontakti biznesi të pranueshëm për procesin e validimit shtesë. Kufijtë: stockSymbol 10, website 255 dhe businessContactEmail 255 karaktere. |
| altBusinessIdType, altBusinessId | Identifikues alternativ opsional i biznesit. Jepni llojin dhe vlerën e tij së bashku. Përdorni katalogun aktual të llojeve; vlera lejon deri në 50 karaktere. |
| referenceId | Referenca juaj e biznesit, deri në 50 karaktere. Përfshijeni për regjistrimin e sipërmarrësve individualë sipas kërkesave aktuale specifike për entitetin. Është metadata biznesi, jo çelësi i idempotencës së kërkesës. |
| website, ipAddress, tag | Faqe interneti shtesë, metadata të IP-së origjinuese dhe vlera etiketash kur janë të zbatueshme. Këto nuk vendosin pronësinë e llogarisë dhe nuk zëvendësojnë kontrollet e identitetit. |
| mock | Një vlerë booleane JSON. Përdorni true vetëm për rrjedhën e punës mock të synuar; përdorni false për një regjistrim prodhimi të shqyrtuar shprehimisht. Mos dërgoni vargun "false" si zëvendësim për një vlerë booleane JSON. |
Sipërmarrësit individualë mbështeten për regjistrime në SHBA ose Kanada dhe kanë nevojë për verifikim OTP përpara pranueshmërisë së fushatës. Kompanitë e listuara në bursë mund të kërkojnë një hap validimi të kontaktit të biznesit. GOVERNMENT është për entitetet qeveritare me bazë në SHBA; konfirmoni kategorinë e saktë të entitetit për organizatat e tjera. Ndiqni kërkesat specifike për entitetin si dhe gabimet e validimit të kthyera.
Mbani një çelës idempotence të qëndrueshëm
Gjeneroni një Idempotency-Key të vetëm për këtë regjistrim të synuar. Ai duhet të përmbajë 1–128 karaktere ASCII të printueshme pa hapësira. Ripërdoreni të njëjtin çelës vetëm me të njëjtën metodë HTTP, shteg, varg pyetjeje dhe saktësisht të njëjtët bajte të trupit të kërkesës. Riformatimi i JSON-it, edhe pa i ndryshuar kuptimin, e ndryshon gjurmën e kërkesës.
Një kërkesë e përfunduar me çelës mund ta riluajë përgjigjen e saj të ruajtur pa një dorëzim tjetër regjistrimi. Një dublikatë që është ende në përpunim kthen HTTP 409 dhe mund të përfshijë Retry-After. Një kërkesë e ndryshuar me të njëjtin çelës bie në konflikt. Mos gjeneroni një çelës të ri thjesht sepse një kërkesë skadoi ose ktheu një gabim: biznesi mund të jetë regjistruar tashmë.
Mbajeni brand.json të pandryshuar ndërsa zgjidhni atë kërkesë. Një 500 ose 502 e ruajtur në cache mund të riluajë gabimin origjinal në vend që ta riprovojë regjistrimin. Ruani çdo brandId, requestId dhe header korrelacioni të kthyer; kontrolloni gjendjen reale të markës ekzistuese dhe zgjidhni çdo mospërputhje përpara se të filloni një kërkesë tjetër.
Lexoni markën dhe statusin e saj
Ky API përdor kodet e statusit HTTP dhe një trup JSON të drejtpërdrejtë, në vend të mbështjellësit status/response të v3. Regjistrimi i suksesshëm kthen një objekt marke që përfshin brandId. Ruani atë identifikues dhe shqyrtoni statusin e kthyer të validimit ose të identitetit. Fushat shtesë varen nga entiteti dhe gjendja e regjistrimit.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID"Lexoni vetëm një markë që i përket llogarisë suaj. Një 404 mund të nënkuptojë se marka nuk është e disponueshme për këtë llogari. Përfundoni çdo validim të kërkuar, pastaj përdorni kualifikimin e markës për të gjetur rastet e disponueshme të përdorimit të fushatës. Burimet mock nuk mund të konsiderohen të pranueshme për dërgim në prodhim.
Tarifat e prodhimit
| Regjistrimi | Tarifa |
|---|---|
| Organizatë standarde | $5.00 |
| Sipërmarrës individual | $4.45 |
| Markë mock | Asnjë debitim për regjistrimin e markës në rrjedhën e punës mock |
Këto shuma me pakicë u kontrolluan kundrejt konfigurimit aktual të portalit më 24 tetor 2026. Konfirmoni tarifën aktuale në portal përpara regjistrimit në prodhim. Tarifat e fushatës, verifikimi shtesë dhe përdorimi i mesazheve janë të veçanta. Një regjistrim prodhimi kontrollon lejen e blerjes dhe fondet e disponueshme përpara dorëzimit; krijimi i suksesshëm në regjistër dhe faturimi lokal janë hapa përpunimi të veçantë, prandaj ruani ID-në e burimit dhe kontrolloni transaksionet dhe zgjidhni çdo mospërputhje nëse ndodh një gabim ose një problem faturimi.
Kalimi i një marke mock në prodhim është një rrjedhë pune e konfirmuar veçmas dhe mund të krijojë një identitet të ri prodhimi dhe një tarifim të ri. Mos supozoni se ndryshimi i mock në false në një kërkesë të mëvonshme e konverton markën ekzistuese.
Trajtoni gabimet pa e dublikuar markën
| Rezultati HTTP | Çfarë duhet kontrolluar |
|---|---|
| 400 | Lexoni gabimet e fushave. Gabimet e validimit të regjistrit mund të jenë një varg objektesh code/description. Validimi lokal i çelësit të idempotencës gjithashtu mund të kthejë 400. |
| 401, 403 ose 404 | Kontrolloni kredencialet e API-t, IP-në burimore të lejuar të llogarisë API, lejet e klientit dhe pronësinë. Një përgjigje e regjistrit mund të mbartë gjithashtu gabimin e vet të autorizimit. |
| 402 | Shqyrtoni fondet dhe lejen e blerjes. Mos e trajtoni një kërkesë prodhimi pa fonde si një test sandbox. |
| 409 | Mbani të njëjtin çelës dhe kërkesën e pandryshuar kur prisni një kërkesë në proces. Një konflikt trupi/çelësi të ndryshuar ose një përgjigje e mëparshme e parikuperueshme kërkon fillimisht kontrollin e gjendjes reale dhe zgjidhjen e çdo mospërputhjeje. |
| 429 ose një përgjigje për kufizues të padisponueshëm | Respektoni Retry-After kur është i pranishëm. Riprovoni të njëjtën kërkesë të synuar dhe të njëjtin çelës pasi kufizimi të hiqet. |
| 500 ose 502 | Operacioni në distancë mund të jetë pranuar. Një gabim i përpunimit lokal mund të përfshijë requestId. Ruajeni dhe kontrolloni burimin ekzistues; mos supozoni se nevojitet një regjistrim zëvendësues. |