Valitse tililläsi oleva brändi
Käytä lähtökohtana rekisterin bränditunnusta, joka on jo liitetty MultiTEL-tiliisi. Tämä haku ei luo brändiä eikä liitä jonkun muun brändiä tiliisi. Nykyinen asiakkaan työnkulku tarkistaa omistajuuden ennen kelpoisuustietojen pyytämistä. Jos haku palauttaa koodin 404, tarkista valittu tili ja brändi sen sijaan, että korvaisit tunnuksen paikallisella rivitunnuksella.
Muodosta käyttötapausvaihtoehdot tämän tuloksen perusteella
Yleinen käyttötapausluettelo kuvaa rekisterin vaihtoehdot. Tämä brändikohtainen haku antaa valitun brändin vaihtoehdot. Säilytä jokainen palautettu usecase-arvo ja yhdistä siihen luettelon näyttönimi ja kuvaus. Älä tarjoa yleisen luettelon kaikkia vaihtoehtoja ikään kuin brändi täyttäisi niiden kelpoisuusehdot.
Portaali odottaa tämän vastauksen olevan JSON-lista. Jos vastaus puuttuu, on virheellisesti muotoiltu tai on virhevastaus, säilytä asiakkaan lomake ja näytä, ettei kelpoisuustietoja voitu ladata. Älä tulkitse sitä ilman ilmoitusta oletuskäyttötapauksen hyväksynnäksi. Rekisteri voi palauttaa myös muita kenttiä kuin lyhennetyssä esimerkissä esitetyt.
Lataa valitun käyttötapauksen vaatimukset
Kun asiakas on valinnut palautetun käyttötapausarvon, tee pyyntö osoitteeseen /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} samalle brändille. Vastaus antaa alikäyttötapausten rajat ja operaattorikohtaiset vaatimukset. Kerää sen perusteella esimerkkiviestit, suostumus ja muut vaaditut vakuutukset. Pelkkä kelpoisuuslista ei riitä täydellisen kampanjarekisteröinnin muodostamiseen.
Tarkista tilin hinnat erikseen
Palveluntarjoajan kentät, kuten monthlyFee, quarterlyFee tai annualFee, kuvaavat palautettuina palveluntarjoajan maksujen metatietoja. Ne eivät korvaa asiakkaan tilikohtaista hintaa tai rekisteröintiehtoja. Nykyinen portaali hakee kampanjoiden asiakashinnat erikseen ja yhdistää ne kelpoisuustietoihin tarkistusnäkymää varten. Älä päättele asiakkaalta veloitettavaa maksua vanhan luettelotyyppien apufunktion kovakoodatuista hinnoista.
Päivitä tiedot, kun brändi tai käyttötapaus vaihtuu
Hylkää edellisen brändin vaihtoehdot brändiä vaihdettaessa ja lataa uuden valinnan kelpoisuustiedot. Päivitä valitun käyttötapauksen vaatimukset ennen rekisteröinnin lähettämistä. Nämä GET-pyynnöt eivät lähetä rekisteröintiä, aktivoi kampanjaa eivätkä määritä numeroita.
Pyyntö
Käytä käytössä olevaa API-tiliä HTTPS-yhteydellä sallitusta lähde-IP-osoitteesta. Nykyinen reitti tukee tilin todennuskäytäntöä, mukaan lukien Basic-todennus ja käytössä olevat API-tilit, jotka käyttävät haltijatunnistetta. Älä käytä palveluntarjoajan tunnistetietoja.
GET siten, että bränditunnus on URL-polussa. Pyynnön runkoa ei tarvita.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
brand_id | merkkijono | Kyllä | Rekisterin bränditunnus, joka on liitetty todennettuun MultiTEL-tiliisi. Käytä bränditunnusta, älä paikallisen tietokannan rivitunnusta, kampanjatunnusta tai yrityksen verotunnusta. Koodaa se yhdeksi URL-polun segmentiksi. |
Vastaus
Nykyinen TCR-reitti palauttaa rekisterin JSON-rungon suoraan ja säilyttää sen HTTP-tilakoodin. Se ei lisää vanhaa v3-version status/response-käärettä. Lyhennetty kuvitteellinen esimerkki ei ole ajantasainen kelpoisuustulos. Tarkista HTTP-tilakoodi ja odotettu JSON-rakenne ennen vastauksen käyttöä. Nykyinen portaali odottaa kelpoisuustietueiden listaa, jonka jokainen tietue yksilöi usecase-arvon. Se yhdistää nämä tietueet usecase-luetteloon näyttönimien saamiseksi ja hakee asiakashinnat erikseen. Mukana voi olla myös muita palveluntarjoajan kenttiä.
Havainnollistava vastauksen rakenne; ei ajantasaisia tilitietoja eikä voimassa oleva hintatarjous.
[
{
"usecase": "2FA"
}
]Virheet
- 401: Tilin todennus epäonnistui. Tarkista API-tunnistetiedot, että tili on käytössä, ja sovellettavat lähde-IP-rajoitukset.
- 404: Brändiä ei ole liitetty todennettuun tiliin, tai palveluntarjoaja ei löydä pyydettyä brändiä tai valintaa. Paikallisen omistajuustarkistuksen kielteinen vastaus palautetaan ennen pyynnön lähettämistä palveluntarjoajalle.
- Muut rekisterivirheet: Taustajärjestelmän HTTP-tilakoodi ja vastauksen runko säilytetään. Virheellinen tai saavuttamattomissa oleva käyttötapaus ei ole onnistunut vastaus, jossa vaatimusten joukko on tyhjä.
- 429: Tilin pyyntöraja tai palveluntarjoajan yhteinen pyyntöraja on saavutettu. Noudata Retry-After-otsaketta.
- 502/503: Tiedonsiirron, palveluntarjoajan tai pyyntötiheyden rajoittimen saatavuushäiriö. Säilytä lomake ja yritä uudelleen pidentäen odotusaikaa yritysten välillä.
Saatavuus ja sivuvaikutukset
- Tarkastettu GET-pyyntö tarkistaa olemassa olevan brändin omistajuuden, ottaa yhteyden rekisteriin ja kirjoittaa pyynnön tarkastuslokimerkinnät. Se ei luo brändiä tai kampanjaa eikä veloita rekisteröintimaksua.
- Palveluntarjoajan maksujen metatiedot eivät ole MultiTELin asiakkaalle annettu hintatarjous. Portaali tarkistaa tilin hinnat erikseen ennen myöhempää rekisteröintipyyntöä.
- Kelpoisuus ja vaatimukset voivat muuttua. Päivitä ne valitulle brändille ja käyttötapaukselle ennen rekisteröinnin lähettämistä. Onnistunut haku ei tarkoita kampanjan hyväksyntää, numeroiden määrittämistä eikä lupaa aloittaa viestien lähettämistä.