Pidä brändi ja käyttötapaus yhdessä
Käytä tilisi bränditunnusta ja käyttötapausarvoa, jonka saman brändin kelpoisuusluettelo on palauttanut. Asiakkaan työnkulku tarkistaa omistajuuden ennen tarjoajalle lähetettävää pyyntöä. Varmista, että palautetun objektin usecase vastaa valittua arvoa. Yhden brändin tai käyttötapauksen haku ei määritä vaatimuksia toiselle.
Lue nykyiset vaatimukset
| Kenttä | Miten portaali käyttää sitä |
|---|---|
| minSubUsecases / maxSubUsecases | Alikäyttötapausten vähimmäis- ja enimmäismäärä tälle valinnalle. Valitse arvot kelvollisten alikäyttötapausten luettelosta vapaan tekstin sijaan. |
| mnoMetadata | Operaattorikohtaiset vaatimukset operaattoritunnuksen mukaan avainnettuina. Käytä operaattorivalinnassa nykyisessä vastauksessa olevia tunnuksia. |
| mnoSupport / qualify | Operaattorin tuki ja kelpoisuus. Portaali sulkee pois operaattorit, joilla jompikumpi kenttä on nimenomaisesti merkitty arvoon false, ja edellyttää vähintään yhtä kelvollista valittua operaattoria. |
| minMsgSamples | Operaattorin vaatima näytteiden määrä. Portaali edellyttää vähintään yhtä ei-tyhjää näytettä ja täyttää kelvollisten valittujen operaattorien korkeimman vähimmäisvaatimuksen. |
| reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp | Vaaditut tilaajailmoitukset. Kun ilmoitus vaaditaan, vastaavan ilmoituksen on oltava true. Käyttöön otetut ilmoitukset tarvitsevat lisäksi avainsana- ja vastausviestikenttänsä. |
| noEmbeddedLink / noEmbeddedPhone | Upotettuja linkkejä tai puhelinnumeroita koskevat rajoitukset. Portaali hylkää ilmoitetun ominaisuuden, jos kelvollinen valittu operaattori kieltää sen. |
Sovella valittujen operaattorien vaatimuksia yhdessä
Operaattorien vaatimukset voivat erota toisistaan. Kun nimenomaista operaattoriluetteloa ei anneta, portaali ottaa huomioon kaikki vastauksen operaattorimetatiedot; ei-tyhjä luettelo rajaa tarkistukset näihin valittuihin tunnuksiin. Älä käytä vain ensimmäisen operaattorin näytemäärää tai ilmoituksia. Valitse operaattorit vastauksesta, tarkista tuki ja kelpoisuus, täytä korkein sovellettava näytteiden vähimmäismäärä ja täytä vaaditut opt-in-, opt-out- ja ohjeilmoitukset koko valinnan osalta. Portaali hylkää valitut operaattoritunnukset, jotka puuttuvat nykyisestä vastauksesta, ja hylkää valinnan, jossa ei ole yhtään kelvollista operaattoria.
Vaatimukset kuvaavat, mitä on toimitettava; ne eivät todista, että asiakkaan suostumusprosessi tai kampanjasisältö täyttää nämä vaatimukset. Kerää totuudenmukaisia, edustavia näytteitä ja ilmoituksia. Älä kytke ilmoituksia automaattisesti päälle, jotta lomake läpäisisi tarkistuksen.
Valmistele näytteet ja tilaajavastaukset
Nykyinen kampanjalomake käyttää kenttiä sample1 – sample5 viestinäytteisiin. Jos vaatimuksia ei voida täyttää käytettävissä olevan lomakkeen puitteissa, keskeytä ja selvitä valinta tuen kanssa. Käyttöön otettua tilaajailmoitusta varten anna sitä vastaavat avainsanat ja vastausteksti: optinKeywords/optinMessage, optoutKeywords/optoutMessage ja helpKeywords/helpMessage. Pidä näytteet yhdenmukaisina valitun käyttötapauksen ja todellisen asiakasviestinnän kanssa.
Tarkista ennen rekisteröintipyyntöä
Päivitä vaatimukset, kun brändi, käyttötapaus tai operaattorivalinta muuttuu. Portaali validoi uudelleen valitun käyttötapauksen, alikäyttötapausten määrän, operaattorien kelpoisuuden, näytteet ja ilmoitukset ennen luontia. Tarkista tilin hinnoittelu ja rekisteröintiehdot erikseen. Tämä GET ei rekisteröi eikä hyväksy kampanjaa, ei jaa sitä viestioperaattorille eikä määritä puhelinnumeroa. Luonti ja provisiointi ovat erillisiä toimintoja.
Käsittele epäonnistunut vaatimushaku
Jos pyyntö epäonnistuu, palauttaa odottamatonta JSON-dataa tai ei vastaa valittua käyttötapausta, pidä lomake keskeneräisenä ja anna asiakkaan yrittää uudelleen virheen ratkaisemisen jälkeen. Älä korvaa saatavilla olemattomia vaatimuksia tyhjällä objektilla äläkä oleta, että puuttuvat tiedot tarkoittavat vaatimusten puuttumista. Noudata Retry-After -otsaketta ja käytä uudelleenyritysten viivettä (backoff) nopeusrajoitusten ja saatavuusvirheiden yhteydessä.
Pyyntö
Käytä käyttöön otettua API-tiliä HTTPS-yhteydellä sallitusta lähde-IP-osoitteesta. Nykyinen reitti tukee tilin todennuskäytäntöä, mukaan lukien Basic-todennus ja käyttöön otetut bearer-API-tilit. Älä käytä tarjoajan tunnistetietoja.
GET bränditunnuksella ja valitulla käyttötapausarvolla URL-polussa. Pyynnön runkoa ei vaadita.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"| Nimi | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
brand_id | string | Kyllä | Todennettuun MultiTEL-tiliisi liitetty rekisterin bränditunnus. Käytä bränditunnusta, ei paikallisen tietokannan rivitunnusta, kampanjatunnusta tai yrityksen verotunnistetta. Koodaa se yhtenä URL-polun segmenttinä. |
usecase | string | Kyllä | Koneluettava usecase-arvo, joka on valittu tämän saman brändin kelpoisuusluettelosta. Säilytä sen kirjainkoko; älä lähetä käännettyä näyttönimeä. Koodaa se yhtenä URL-polun segmenttinä. |
Vastaus
Nykyinen TCR-reitti palauttaa rekisterin JSON-rungon suoraan ja säilyttää sen HTTP-tilakoodin. Se ei lisää vanhaa v3:n status/response-kuorta. Lyhennetty kuvitteellinen esimerkki ei ole todellinen kelpoisuustulos. Tarkista HTTP-tilakoodi ja odotettu JSON-rakenne ennen sen käyttöä. Portaali odottaa objektia, jonka usecase vastaa valittua käyttötapausta. Operaattorien vaatimukset ovat kohdassa mnoMetadata operaattoritunnuksen mukaan avainnettuina. Esimerkin operaattoritunnus ja vaatimukset ovat kuvitteellisia. Muita tarjoajan kenttiä voidaan palauttaa.
Havainnollistava vastausrakenne; ei todellisia tilitietoja eikä ajantasainen hintatarjous.
{
"usecase": "2FA",
"minSubUsecases": 0,
"maxSubUsecases": 0,
"mnoMetadata": {
"12345": {
"mnoSupport": true,
"qualify": true,
"minMsgSamples": 1,
"reqSubscriberOptin": true,
"reqSubscriberOptout": true,
"reqSubscriberHelp": true,
"noEmbeddedLink": false,
"noEmbeddedPhone": false
}
}
}Virheet
- 401: Tilin todennus epäonnistui. Tarkista API-tunnistetiedot, käyttöönottotila ja sovellettavat lähde-IP-rajoitukset.
- 404: Brändiä ei ole liitetty todennettuun tiliin, tai tarjoaja ei löydä pyydettyä brändiä tai valintaa. Paikallinen omistajuuden epääminen palautetaan ennen tarjoajalle lähetettävää pyyntöä.
- Muut rekisterivirheet: Ylävirran HTTP-tilakoodi ja runko säilytetään. Virheellinen tai saatavilla olematon käyttötapaus ei ole onnistunut tyhjä vaatimusjoukko.
- 429: Tilin tai jaetun tarjoajan pyyntöraja saavutettu. Noudata Retry-After-otsaketta.
- 502/503: Siirron, tarjoajan tai nopeusrajoittimen saatavuusvirhe. Säilytä lomake ja yritä uudelleen viiveellä (backoff).
Saatavuus ja sivuvaikutukset
- Tarkistettu GET tarkistaa olemassa olevan brändin omistajuuden, ottaa yhteyttä rekisteriin ja kirjoittaa pyynnön auditointitietueet. Se ei luo brändiä tai kampanjaa eikä veloita rekisteröintimaksua.
- Tarjoajan maksumetatiedot eivät ole MultiTELin asiakkaalle annettu vähittäishintatarjous. Portaali tarkistaa tilin hinnoittelun erikseen ennen myöhempää rekisteröintipyyntöä.
- Kelpoisuus ja vaatimukset voivat muuttua. Päivitä ne valitulle brändille ja käyttötapaukselle ennen lähettämistä. Onnistunut haku ei ole kampanjan hyväksyntä, numeron määritys eikä lupa aloittaa viestintää.