Lähetä luettelomerkintä operaattorille
Lähetä nimi ja osoite, joita käytetään luettelomerkinnässä MultiTELissä omistamallesi palveluun soveltuvalle puhelinnumerolle. Kyseessä on maksullinen päivitys operaattorille, ei soittajan nimen haku, yksityisen osoitekirjan merkintä eikä portaalin numeroluettelon LIDB-kentän yleinen päivitys.
Lähetä vain tietoja, joiden käytön luettelomerkinnässä asiakas on hyväksynyt. Varmista ennen tämän vanhan kutsureitin käyttöä, että operaattori tukee numeroa. Tarkastettu käsittelijä ei tarkista palveluntarjoajan soveltuvuutta eikä numeron kansainvälistä muotoa; sen operaattoripyyntö olettaa numeron pohjoisamerikkalaiseksi ja poistaa ensimmäisen tallennetun numeromerkin.
Tiliä ja numeroa koskevat vaatimukset
Käytä käytössä olevaa API-tiliä HTTPS-yhteydellä sallitusta lähde-IP-osoitteesta. Täsmälleen kyseisen numeron on oltava tilille kuuluvalla ostetun numeron tietuerivillä, jota ei ole mitätöity. Käytä numeroluetteloosi tallennetun kansainvälisen numeron kaikkia numeroita, esimerkiksi tuetun pohjoisamerikkalaisen numeron muotoa, jossa maatunnus on 1. Älä käytä hinnoittelupaketin tunnusta, numeron UUID-tunnusta tai toiselle tilille kuuluvaa numeroa.
Lomaketietojen POST-pyyntö
Aseta NUMBER omistamaksesi numeroksi. Korvaa kuvitteellinen esimerkki hyväksytyillä luettelotiedoilla. Tämä kutsureitti lukee lomakekentät POST-pyynnöstä; se ei jäsennä application/json-muotoista pyyntörunkoa.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--data-urlencode "lastname=EXAMPLE" \
--data-urlencode "firstname=EXAMPLE" \
--data-urlencode "streetnum=1" \
--data-urlencode "streetname=Example" \
--data-urlencode "streetpredir=N" \
--data-urlencode "streetpostdir=W" \
--data-urlencode "city=Example City" \
--data-urlencode "state=NY" \
--data-urlencode "postalcode=10001" \
"https://api.multitel.net/v3/directory/$NUMBER"| Kenttä | Pakollinen tässä API-rajapinnassa | Merkitys |
|---|---|---|
| lastname | Kyllä | Luettelomerkinnän sukunimi tai kyseiseen merkintään soveltuva nimikenttä. |
| city | Kyllä | Luettelomerkinnän kaupunki. |
| postalcode | Kyllä | Luettelomerkinnän postinumero. |
| state | Kyllä | Luettelomerkinnän osavaltio tai alue, jonka tuettu operaattori hyväksyy. |
| streetname | Kyllä | Kadunnimi. |
| streetnum | Kyllä | Katunumero. |
| firstname | Ei | Täydentävä etunimiosa. |
| streetpredir, streetpostdir | Ei | Ilmansuuntatiedot kadunnimen edessä ja jäljessä, kun ne ovat tarpeen. |
| streettype, location | Ei | Katutyypin tai täydentävän sijainnin teksti, kun se on tarpeen. |
Esimerkin ilmansuunnat ja osoite ovat paikkamerkkejä, eivät suositeltu postiosoite. Älä lisää kuvitteellista ilmansuuntaa todellisiin asiakastietoihin. API-rajapinnan pakollisten kenttien tarkistukset ovat pintapuolisia: ne eivät varmista osoitteen kelvollisuutta tai sitä, että operaattori hyväksyy osoitteen, ja vanhalla verkkosivustolla oli erilaiset lomakevaatimukset.
Toteutus voi antaa varoituksen puuttuvasta taulukkoavaimesta, jos valinnainen ilmansuuntatieto puuttuu tai on tyhjä. Jos vastaus on virheellisesti muotoiltu tai operaattori hylkää osoitteen, säilytä pyynnön viite ja pyydä tukea vahvistamaan luettelomerkintä sen sijaan, että lähettäisit toistuvasti muokattuja osoitearvauksia.
Veloitus ja uudet yritykset
Tarkastettu käsittelijä varmistaa, että saldo on vähintään 10.00 saldoyksikköä ennen yhteydenottoa operaattoriin. Kun sekä operaattori että paikallinen numeropäivitys ilmoittavat onnistumisesta, käsittelijä vähentää 10.00 tilin saldosta ja kirjaa luettelomerkinnän perustamistapahtuman. Nämä ovat nykyiseen toteutukseen määritetyt määrät, eivät uusi hinnoitteluehdotus; varmista sovellettava laskutusvaluutta ja tuettu palvelu tiliehdoistasi ennen lähettämistä.
Toiminnolla ei ole idempotenssiavainta, päällekkäisten tilausten estoa eikä operaattorille lähettämisen, paikallisen päivityksen ja laskutuksen kattavaa transaktiota. Onnistunut toistettu pyyntö voi johtaa uuteen lähetykseen operaattorille ja uuteen veloitukseen. Aikakatkaisu tai API-virhe ei todista operaattorin hylänneen aiempaa pyyntöä: palveluntarjoaja on voinut hyväksyä sen ennen paikallisen päivityksen epäonnistumista.
Vastaus
{
"status": {
"code": 200,
"msg": "Success"
},
"response": ""
}Tavallisessa onnistumisvastauksessa tyhjän merkkijonon sisältää kenttä response eikä vastauksessa palauteta luettelomerkinnän tunnusta tai valmistumisen lisätietoja. Tämä tarkoittaa, että operaattorikäsittely ja paikallinen päivitys ilmoittivat onnistumisesta; se ei todista julkaisua kaikissa ulkoisissa luetteloissa, tietojen välitöntä leviämistä tai soittajatunnisteen näkymistä tulevaisuudessa.
Vanhan toteutuksen virheet
| API-koodi | Merkitys |
|---|---|
| 404 | Numeroa ei löytynyt tililtä tai jokin pakollisista lomakekentistä oli tyhjä. |
| 400 | Tilin saldo on pienempi kuin toteutukseen määritetty veloitus. |
| 500 | Operaattoripyyntö epäonnistui tai paikallinen päivitys epäonnistui sen jälkeen, kun operaattori oli mahdollisesti jo hyväksynyt pyynnön. |
| 200 | Toiminto ilmoitettiin onnistuneeksi; vastaus ei sisällä julkaisuvahvistusta. |
Lue sekä HTTP-tila että seuraavat JSON-kentät: status.code/status.msg. Todennus ja lähde-IP-osoitteen rajoitukset voivat myös estää käyttökelpoisen vastauksen saamisen. Älä pyydä päivitystä GET-menetelmällä tai kyselyparametreilla vain siksi, ettei vanha käsittelijä tarkista HTTP-menetelmää erikseen.
Tarkista ennen uutta yritystä
- Varmista omistamasi numero, operaattorin soveltuvuus, hyväksytyt luettelotiedot ja veloitus ennen pyynnön lähettämistä.
- Lähetä pyyntö kerran ja säilytä tilin puolella saatu tulos paljastamatta asiakkaan osoitetta julkisissa lokeissa tai analytiikassa.
- Tarkista tallennettu luettelomerkintä ja tapahtumahistoria tuetun tilin asiointipolun kautta tai tuesta. Odota operaattorin vahvistama käsittelyaika; tämä API-rajapinta ei määritä taattua määräaikaa tietojen leviämiselle.
- Jos tulos on epävarma, pyydä tukea täsmäyttämään operaattoritilaus ja paikallinen laskutus ennen uutta yritystä. Toistettu pyyntö ei ole idempotentti tilantarkistus.