Gauti numerių perkėlimo projekto duomenis

Prieiga prie paskyros ir projekto

Naudokite įgalintą API paskyrą, jungdamiesi per HTTPS iš leidžiamo IP adreso. Projektas turi priklausyti tai paskyrai ir negali būti ištrintas. Naudokite unikalų projekto identifikatorių iš numerių perkėlimo užsakymo eigos, o ne skaitinį duomenų bazės identifikatorių ar telefono numerį. Sudarydami užklausą, projekto identifikatoriui taikykite URL kodavimą.

Užklausa

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID"

Šį atsakymą laikykite konfidencialiu

Visame atsakyme pateikiami operatoriaus, iš kurio perkeliami numeriai, atsiskaitymo duomenys, įskaitant išsaugotą billing_pin, atsiskaitymo paskyros, telefono, adreso, įmonės ir įgalioto kontaktinio asmens duomenis. API šių laukų nemaskuoja. Jei jūsų darbo eigai pakanka būsenos arba numerių sąrašo, užklauskite tik jų. Nesaugokite viso išsamaus atsakymo naršyklės saugykloje, analitikos sistemose ar viešuose žurnaluose ir neįtraukite jo į pagalbos tarnybai siunčiamas ekrano kopijas; rodykite tik tuos laukus, kurių reikia prieigos teisę turinčiam klientui.

Atsakymo struktūra

Išgalvotas pasirinktų laukų pavyzdys; atsakyme gali būti pateikta ir papildomų laukų.

{
  "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": []
  }
}

Šis pavyzdys sąmoningai nepilnas: jame praleisti visi atsiskaitymo prisijungimo duomenys ir asmeniniai kontaktiniai duomenys. Tai, kad jų nėra pavyzdyje, nereiškia, kad tikrame atsakyme jie paslepiami.

Išsamių projekto duomenų skyriai
Skyrius	Turinys
project	Skaitinis eilutės identifikatorius, unikalus projekto identifikatorius, projekto pavadinimas, vieta, išsaugoti atsiskaitymo, kontaktiniai ir adreso duomenys, sukūrimo laikas ir apskaičiuota būsena. Senasis operatoriaus, iš kurio perkeliami numeriai, laukas rašomas loosing_carrier.
counts	Bendras numerių eilučių skaičius ir būsenų Pending, In Progress, Completed bei Rejected skaitikliai.
numbers	Toks pat numerių duomenų rinkinys kaip projekto numerių sąrašo galiniame taške, įskaitant kliento komentarus ir išsaugotas planavimo reikšmes.
events	Išsaugotos įvykių eilutės ir neapdoroti bei išanalizuoti duomenų turinio laukai, kuriems taikomi įvykių galinio taško matomumo ir formato apribojimai.
uploads	Dokumentų metaduomenys: skaitinis identifikatorius, upload_type, file_name, file_extension, date_created ir santykinis download_url. Norint pasiekti šį URL, vis tiek būtina paskyros autentifikacija.

Suvestinės ir metaduomenų aiškinimas

Apskaičiuojant būseną, pirmenybė teikiama In Progress, tada Pending, tada Completed, tada Rejected; jei netinka nė viena iš jų, naudojama Pending. Suvestinės būsena Completed galima ir tada, kai yra atmestų numerių. Patikrinkite skaitiklius ir numerių būsenas, užuot manę, kad visų numerių perkėlimas baigtas.

Atsakyme pateikiami dokumentų metaduomenys, o ne failų baitai. Jame nėra nei puslapiavimo, nei prieauginio duomenų gavimo žymeklio. Išsamių duomenų ir sąrašo užklausos yra atskiros skaitymo operacijos, o ne viena duomenų momentinė kopija, kurios nuoseklumas garantuojamas transakcija. Datos lieka tokios, kokios išsaugotos; laiko juostos konvertavimas nėra dokumentuotas. Projekto maršrutams naudokite uniqueid; jo negalima pakeisti skaitiniu projekto identifikatoriumi.

Klaidos ir apribojimai

Patikrinkite ir HTTP atsakymą, ir status.code/status.msg. Jei projekto nėra, jis ištrintas arba nepriklauso paskyrai, grąžinamas API kodas 404 su pranešimu, kad projektas nerastas. Taip pat taikomi autentifikavimo ir šaltinio IP adreso apribojimai. Pavyzdžiai nesiunčia tikros užklausos, o sėkmingas atsakymas neįrodo, kad operatorius priėmė arba užbaigė perkėlimą.

Poveikis ir darbo eiga

Tai pagrindinis išsamių duomenų maršrutas, kurį dabartinis portalas naudoja numerių perkėlimo užsakymo rodinyje. Portalas susieja laukus su savo naudotojo sąsaja ir pritaiko savo klientui skirtą duomenų atranką; nemanykite, kad neapdorotas API atsakymas yra toks pat kaip portalo JSON ar jo pateikiamas vaizdas. Peržiūrėta išsamių duomenų apdorojimo funkcija nekeičia projekto ir tiesiogiai nei inicijuoja užklausos operatoriui, nei taiko mokesčio.