Kehittäjät

POST/tcr/v2/brand/nonBlocking

Rekisteröi viestintäbrändi

Rekisteröi tiliomisteinen yritysidentiteetti, pidä hiekkalaatikkapyynnöt nimenomaisina sekä täsmäytä validointi ja maksut.

Tällä sivulla
  1. Rekisteröi viestiesi taustalla oleva yritys
  2. Aloita nimenomaisella hiekkalaatikkapyynnöllä
  3. Yritys- ja yhteystietokentät
  4. Pidä idempotenssiavain vakaana
  5. Lue brändi ja sen tila
  6. Tuotantomaksut
  7. Käsittele virheet ilman brändin monistamista

Rekisteröi viestiesi taustalla oleva yritys

Viestintäbrändi tunnistaa yrityksen, joka lähettää US 10DLC -viestejä. Rekisteröi brändi ennen kampanjan käyttötarkoituksen valintaa. Käytä yrityksen virallisia tietoja ja yhteyshenkilöä, joka voi suorittaa mahdollisesti vaadittavan validoinnin. Palautettu bränditunnus ei yksinään ole lupa lähettää viestejä.

Käytä tätä nykyistä tiliomisteista reittiä HTTPS-yhteydellä käytössä olevalla API-tilillä ja sen sallitulla lähde-IP-osoitteella. Älä lähetä user_id- tai username-kenttää tai toisen asiakkaan omistajatunnistetta. MultiTEL kirjaa omistajuuden todennetulta tililtä.

Aloita nimenomaisella hiekkalaatikkapyynnöllä

Portaali asettaa lomakkeensa mode-kentän oletuksena hiekkalaatikkotilaan; suoran API-pyynnön on sisällettävä nimenomaisesti JSON-totuusarvo mock: true, kun tarkoitat testibrändiä. Tunnisteen pois jättäminen ei takaa hiekkalaatikkaa ja voi luoda laskutettavan tuotantorekisteröinnin. Portaalin mode-kenttä ei korvaa API:n mock-kenttää.

Valmistele paikallinen brand.json-tiedosto alla olevien kenttien avulla. Korvaa paikkamerkit sopivilla testitiedoilla ja ajantasaisilla luettelokoodeilla. Tämä esimerkki on yksityinen voittoa tavoitteleva yritys; muilla yhteisötyypeillä on erilaiset vaatimukset.

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

Edellä oleva yritys, osoite, puhelin ja tunniste ovat paikkamerkkejä, eivät rekisteröintikelpoinen yritysidentiteetti. Hae ajantasaiset arvot kentille entityType, vertical, country, state, brandRelationship ja muille luetteloarvoille kohdasta viestintäluettelot.

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'

Yritys- ja yhteystietokentät

Brändin rekisteröintikentät
KentätMitä ilmoitetaan
entityType, displayNameAjantasainen yhteisötyypin koodi ja tunnistettava brändinimi. Enimmäispituudet ovat 20 ja 255 merkkiä vastaavasti.
country, street, city, state, postalCodeVarsinainen yrityksen osoite. Käytä kaksikirjaimista maakoodia ja tarvittaessa ajantasaista US state -koodia. Rajoitukset: street 255, city 100, state 20 ja postalCode 10 merkkiä.
email, phoneToimiva yhteyssähköpostiosoite, enintään 100 merkkiä, ja puhelinnumero kansainvälisessä +maakoodimuodossa, enintään 20 merkkiä. Pidä yritystiedot yhdenmukaisina koko rekisteröinnin ajan.
companyName, ein, einIssuingCountryAnna organisaatioille virallinen yritysnimi ja yrityksen verotunniste. Tunnisteen myöntäjämaa on erillinen kaksikirjaiminen kenttä. Rajoitukset: companyName 255 ja ein 21 merkkiä. Yksityinen elinkeinonharjoittaja käyttää henkilönnimikenttiä organisaation verotunnisteen sijaan.
brandRelationship, verticalSuhde yritykseen ja sen toimialaan käyttäen ajantasaisia luettelokoodeja. Organisaatioilta nämä vaaditaan; yksityisen elinkeinonharjoittajan säännöt eroavat. Älä korvaa API-koodeja käännetyillä näyttönimillä.
firstName, lastName, mobilePhonePakollinen yksityiselle elinkeinonharjoittajalle. Nimikentät sallivat enintään 100 merkkiä kukin. Anna kelvollinen matkapuhelinnumero vaadittavaa OTP-validointia varten kansainvälisessä muodossa.
stockSymbol, stockExchange, website, businessContactEmailPörssiyhtiö tarvitsee lisäksi osaketunnuksensa ja pörssinsä, website-osoitteen ja kelvollisen yritys-yhteyssähköpostin lisävalidointiprosessia varten. Rajoitukset: stockSymbol 10, website 255 ja businessContactEmail 255 merkkiä.
altBusinessIdType, altBusinessIdValinnainen vaihtoehtoinen yritystunniste. Anna sen tyyppi ja arvo yhdessä. Käytä ajantasaista tyyppiluetteloa; arvo sallii enintään 50 merkkiä.
referenceIdYrityksesi viite, enintään 50 merkkiä. Sisällytä se yksityisen elinkeinonharjoittajan rekisteröintiin ajantasaisten yhteisökohtaisten vaatimusten mukaisesti. Se on yritysmetatietoa, ei pyynnön idempotenssiavain.
website, ipAddress, tagLisäverkkosivusto, alkuperäisen IP-osoitteen metatiedot ja tunnistearvot tarvittaessa. Ne eivät vahvista tilin omistajuutta eivätkä korvaa henkilöllisyystarkistuksia.
mockJSON-totuusarvo. Käytä true-arvoa vain tarkoitettuun testityönkulkuun; käytä false-arvoa nimenomaisesti tarkistettuun tuotantorekisteröintiin. Älä lähetä merkkijonoa "false" JSON-totuusarvon korvikkeena.

Yksityiset elinkeinonharjoittajat ovat tuettuja US- tai Kanadan rekisteröinneissä ja tarvitsevat OTP-vahvistuksen ennen kampanjakelpoisuutta. Pörssiyhtiöt voivat vaatia yritys-yhteystietojen validointivaiheen. GOVERNMENT on tarkoitettu US-pohjaisille julkishallinnon yhteisöille; vahvista oikea yhteisöluokka muille organisaatioille. Noudata yhteisökohtaisia vaatimuksia sekä palautettuja validointivirheitä.

Pidä idempotenssiavain vakaana

Luo yksi Idempotency-Key tätä tarkoitettua rekisteröintiä varten. Sen on sisällettävä 1–128 tulostettavaa ASCII-merkkiä ilman välilyöntejä. Käytä samaa avainta uudelleen vain saman HTTP-menetelmän, polun, kyselymerkkijonon ja tarkkojen pyynnön runkotavujen kanssa. JSON-muotoilun muuttaminen, vaikka sen merkitys ei muuttuisi, muuttaa pyynnön sormenjälkeä.

Valmis avaimellinen pyyntö voi toistaa tallennetun vastauksensa ilman uutta rekisteröintilähetystä. Yhä käsiteltävä kaksoiskappale palauttaa HTTP 409 -tilan ja voi sisältää Retry-After-otsikon. Muutettu pyyntö samalla avaimella aiheuttaa ristiriidan. Älä luo uutta avainta vain siksi, että pyyntö aikakatkaistiin tai palautti virheen: yritys on ehkä jo rekisteröity.

Pidä brand.json muuttumattomana selvittäessäsi kyseistä pyyntöä. Välimuistiin tallennettu 500- tai 502-virhe voi toistaa alkuperäisen virheen rekisteröinnin uudelleenyrityksen sijaan. Säilytä mahdolliset palautetut brandId-, requestId- ja korrelaatio-otsikot; täsmäytä olemassa oleva brändi ennen eri pyynnön aloittamista.

Lue brändi ja sen tila

Tämä API käyttää HTTP-tilakoodeja ja suoraa JSON-runkoa v3 status/response -kääreen sijaan. Onnistunut rekisteröinti palauttaa brändiobjektin, joka sisältää brandId-tunnisteen. Tallenna kyseinen tunniste ja tarkista palautettu validointi- tai henkilöllisyystila. Lisäkentät riippuvat yhteisöstä ja rekisteröinnin tilasta.

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

Lue vain tilillesi kuuluva brändi. 404-koodi voi tarkoittaa, että brändi ei ole tämän tilin käytettävissä. Suorita mahdollinen vaadittava validointi ja käytä sitten brändin kelpoisuutta löytääksesi sen käytettävissä olevat kampanjan käyttötarkoitukset. Testiresursseja ei voida olettaa kelvollisiksi tuotantolähetykseen.

Tuotantomaksut

Nykyiset määritetyt brändin rekisteröintimaksut
RekisteröintiMaksu
Tavanomainen organisaatio$5.00
Yksityinen elinkeinonharjoittaja$4.45
TestibrändiEi brändirekisteröintiveloitusta testityönkulussa

Nämä vähittäishinnat tarkistettiin nykyistä portaalin määritystä vasten 24. lokakuuta 2026. Vahvista ajantasainen maksu portaalissa ennen tuotantorekisteröintiä. Kampanjamaksut, lisäselvitykset ja viestinkäyttö ovat erillisiä. Tuotantorekisteröinti tarkistaa ostoluvan ja käytettävissä olevan rahoituksen ennen lähetystä; onnistunut brändin kirjaus rekisteriin ja paikallinen laskutus ovat erillisiä käsittelyvaiheita, joten säilytä resurssitunnus ja täsmäytä tapahtumat, jos ilmenee virhe tai laskutusongelma.

Testibrändin muuttaminen tuotantoon on erikseen vahvistettava työnkulku ja voi luoda uuden tuotanto-identiteetin ja veloituksen. Älä oleta, että mock-arvon muokkaaminen arvoksi false myöhemmässä pyynnössä muuntaa olemassa olevan brändin.

Käsittele virheet ilman brändin monistamista

Rekisteröintivirheet
HTTP-tulosMitä tarkistetaan
400Lue kenttävirheet. Rekisterin validointivirheet voivat olla code/description-objektien taulukko. Paikallinen idempotenssiavaimen validointi voi myös palauttaa 400-koodin.
401, 403 tai 404Tarkista API-tunnukset, API-tilin sallittu lähde-IP, asiakkaan käyttöoikeudet ja omistajuus. Rekisterin vastaus voi sisältää myös oman valtuutusvirheensä.
402Tarkista rahoitus ja ostolupa. Älä käsittele rahoittamatonta tuotantopyyntöä hiekkalaatikkatestinä.
409Pidä sama avain ja muuttumaton pyyntö odottaessasi keskeneräistä pyyntöä. Muutettu runko/avain-ristiriita tai palautumaton aiempi vastaus on täsmäytettävä ensin.
429 tai rajoittimen saavuttamattomuusvastausNoudata Retry-After-otsikkoa, kun se on annettu. Yritä samaa tarkoitettua pyyntöä ja avainta uudelleen rajoituksen poistuttua.
500 tai 502Etätoiminto on saatettu hyväksyä. Paikallisen käsittelyn virhe voi sisältää requestId-tunnisteen. Tallenna se ja tarkista olemassa oleva resurssi; älä oleta, että korvaava rekisteröinti tarvitaan.