Tilin ja projektin käyttöoikeudet
Käytä käytössä olevaa API-tiliä HTTPS-yhteydellä sallitusta IP-osoitteesta. Projektin on kuuluttava kyseiselle tilille, eikä se saa olla poistettu. Käytä numeronsiirtotilauksen työnkulusta saatavaa projektin yksilöllistä tunnistetta, älä sen numeerista tietokantatunnistetta tai puhelinnumeroa. URL-koodaa projektin tunniste pyyntöä muodostaessasi.
Pyyntö
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"Käsittele tätä vastausta luottamuksellisena
Täydellinen vastaus sisältää luovuttavan operaattorin laskutustiedot, mukaan lukien tallennetun arvon kentästä billing_pin, laskutustilin, puhelinnumeron, osoitteen, yrityksen ja valtuutetun yhteyshenkilön tiedot. API ei peitä näitä kenttiä. Pyydä vain tila tai numeroluettelo, jos työnkulkusi ei tarvitse muuta. Älä tallenna täydellistä tietovastausta selaimen tallennustilaan, analytiikkaan, julkisiin lokeihin tai tuelle toimitettaviin näyttökuviin. Näytä vain ne kentät, joita valtuutettu asiakas tarvitsee.
Vastauksen rakenne
Kuvitteellinen esimerkki valituista kentistä; vastauksessa voidaan palauttaa myös muita kenttiä.
{
"status": {
"code": 200,
"msg": "Project Detail"
},
"response": {
"project": {
"id": 11,
"uniqueid": "PROJECT_EXAMPLE",
"project_name": "Example transfer",
"location": "US",
"status": 0,
"status_str": "Pending"
},
"counts": {
"total": 0,
"pending": 0,
"in_progress": 0,
"completed": 0,
"rejected": 0
},
"numbers": [],
"events": [],
"uploads": []
}
}Tästä tarkoituksella osittaisesta esimerkistä on jätetty pois kaikki laskutukseen liittyvät tunnistautumistiedot ja henkilökohtaiset yhteystiedot. Niiden puuttuminen esimerkistä ei tarkoita, että ne peitettäisiin todellisessa vastauksessa.
| Osio | Sisältö |
|---|---|
| project | Rivin numeerinen tunniste, projektin yksilöllinen tunniste, projektin nimi, sijainti, tallennetut laskutus-, yhteys- ja osoitetiedot, luontiaika ja johdettu tila. Luovuttavan operaattorin vanhan kentän kirjoitusasu on loosing_carrier. |
| counts | Numerorivien kokonaismäärä ja tilojen Pending, In Progress, Completed ja Rejected laskurit. |
| numbers | Sama numerotietojen valikoima kuin projektin numeroluettelon päätepisteessä, mukaan lukien asiakkaan kommentit ja tallennetut ajoitusarvot. |
| events | Tallennetut tapahtumarivit ja hyötykuorman raakamuotoiset tai jäsennetyt kentät tapahtumapäätepisteen näkyvyys- ja muotorajoitusten mukaisesti. |
| uploads | Asiakirjojen metatiedot: numeerinen tunniste, upload_type, file_name, file_extension, date_created ja suhteellinen download_url. URL-osoitteen käyttö edellyttää edelleen tilin todentamista. |
Tulkitse yhteenvetoa ja metatietoja
Johdettu tila määräytyy ensisijaisesti tilan In Progress, sitten tilan Pending, tämän jälkeen tilan Completed ja lopuksi tilan Rejected perusteella. Varatilana käytetään arvoa Pending. Yhteenvedon tila voi olla Completed, vaikka mukana olisi hylättyjä numeroita. Tarkista laskurit ja numeroiden tilat sen sijaan, että olettaisit jokaisen numeron siirron valmistuneen.
Vastaus sisältää asiakirjojen metatiedot, ei tiedostojen tavusisältöä. Siinä ei ole sivutusta eikä inkrementaalisen haun kohdistinta. Tieto- ja luettelokyselyt ovat erillisiä lukuoperaatioita, eivät yksi taatusti transaktionaalisesti yhtenäinen tilannekuva. Päivämäärät palautetaan tallennettuina arvoina ilman dokumentoitua aikavyöhykemuunnosta. Käytä projektireiteissä kenttää uniqueid; projektin numeerista tunnistetta ei voi käyttää sen sijasta.
Virheet ja rajoitukset
Tarkista sekä HTTP-vastaus että status.code/status.msg. Jos projekti puuttuu, on poistettu tai ei kuulu tilille, palautetaan API-koodi 404 ja ilmoitus siitä, ettei projektia löytynyt. Myös todentamisvaatimukset ja lähde-IP-osoitteen rajoitukset ovat voimassa. Esimerkit eivät lähetä todellista pyyntöä, eikä onnistunut vastaus todista, että operaattori olisi hyväksynyt tai suorittanut numeronsiirron.
Vaikutukset ja työnkulku
Tämä on ensisijainen tietoreitti, jota nykyisen portaalin numeronsiirtotilausten näkymä käyttää. Portaali muuntaa kentät käyttöliittymäänsä varten ja muodostaa oman asiakaskohtaisen tietovalikoimansa. Älä oleta, että raaka API-vastaus on sama kuin portaalin JSON-tiedot tai esitystapa. Tarkastettu tietokäsittelijä ei muuta projektia eikä käynnistä suoraan operaattorille lähetettävää pyyntöä tai veloitusta.