Számhordozási projekt lekérése

Hozzáférés a fiókhoz és a projekthez

Használjon engedélyezett API-fiókot HTTPS-kapcsolaton keresztül, engedélyezett IP-címről. A projektnek ehhez a fiókhoz kell tartoznia, és nem lehet törölt. A számhordozási megrendelés munkafolyamatából származó egyedi projektazonosítót használja, ne a projekt numerikus adatbázis-azonosítóját vagy egy telefonszámot. A kérés összeállításakor alkalmazzon URL-kódolást a projektazonosítóra.

Kérés

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

Kezelje bizalmasan ezt a választ

A teljes válasz tartalmazza az átadó szolgáltatóhoz kapcsolódó számlázási adatokat, köztük a következő tárolt adatokat: billing_pin, számlázási fiók, telefonszám, cím, céges adatok és a meghatalmazott kapcsolattartó adatai. Az API nem maszkolja ezeket a mezőket. Csak az állapotot vagy a telefonszámlistát kérje le, ha a munkafolyamatához ennyi is elegendő. Ne helyezze a teljes részletes választ böngészőtárhelyre, analitikai rendszerekbe, nyilvános naplókba vagy ügyféltámogatási képernyőképekre, és csak azokat a mezőket jelenítse meg, amelyekre a jogosult ügyfélnek szüksége van.

A válasz szerkezete

Kitalált példa néhány kiválasztott mezővel; a válasz további mezőket is tartalmazhat.

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

Ez a szándékosan részleges példa nem tartalmaz számlázási hitelesítő adatokat és személyes kapcsolattartási adatértékeket. Attól, hogy ezek kimaradtak a példából, a tényleges válasz még nem takarja ki őket.

A projektadatok részei
Rész	Tartalom
project	Numerikus sorazonosító, egyedi projektazonosító, projektnév, hely, tárolt számlázási, kapcsolattartási és címadatok, létrehozási idő és származtatott állapot. Az átadó szolgáltatóra vonatkozó örökölt mező neve a következő írásmóddal szerepel: loosing_carrier.
counts	A telefonszámokat tartalmazó sorok teljes száma, valamint a Pending, In Progress, Completed és Rejected állapotok számlálói.
numbers	A projekt telefonszámlistáját lekérő végponttal megegyező telefonszám-adatmezők, beleértve az ügyfél megjegyzéseit és a tárolt ütemezési értékeket.
events	Tárolt eseménysorok és nyers, illetve feldolgozott üzenettörzsmezők, az eseményvégpont láthatósági és formátumbeli korlátainak megfelelően.
uploads	Dokumentum-metaadatok: numerikus azonosító, upload_type, file_name, file_extension, date_created és egy relatív download_url. Az URL eléréséhez továbbra is szükséges a fiók hitelesítése.

Az összesítés és a metaadatok értelmezése

A származtatott állapot elsőbbségi sorrendje: In Progress, majd Pending, utána Completed, végül Rejected; ha egyik sem alkalmazható, az alapérték Pending. A Completed összesített állapot mellett is lehetnek elutasított telefonszámok. Ellenőrizze a számlálókat és a telefonszámok állapotát ahelyett, hogy feltételezné, hogy minden telefonszám hordozása befejeződött.

A válasz dokumentum-metaadatokat tartalmaz, nem a fájlok bájtjait. Nincs lapozás vagy a növekményes lekéréshez használható kurzor. A részletes adatok és a listák lekérdezése külön olvasási művelet, nem pedig egyetlen, garantáltan tranzakciósan konzisztens pillanatkép. A dátumok a tárolt értékek maradnak, dokumentált időzóna-átváltás nélkül. A projektútvonalakhoz a uniqueid értékét használja; a numerikus projektazonosító nem használható helyette.

Hibák és korlátok

Ellenőrizze a HTTP-választ és a következő mezőket is: status.code/status.msg. Ha a projekt nem létezik, törölték, vagy nem a fiókhoz tartozik, a válasz 404-es API-kódot és a projekt hiányát jelző üzenetet tartalmaz. A hitelesítési és a forrás-IP-címre vonatkozó korlátozások szintén érvényesek. A példák nem indítanak élő kérést, és a sikeres válasz nem bizonyítja, hogy egy szolgáltató elfogadta vagy befejezte a számhordozást.

Hatások és munkafolyamat

Ez az a kanonikus részletes lekérdezési útvonal, amelyet a jelenlegi portál számhordozási megrendelési nézete használ. A portál a felhasználói felületéhez leképezi a mezőket, és saját, az ügyfélnek szánt adatmező-válogatását alkalmazza; ne feltételezze, hogy a nyers API-válasz megegyezik a portál JSON-adataival vagy megjelenítésével. Az áttekintett részletesadat-kezelő nem módosítja a projektet, és közvetlenül nem indít szolgáltatói kérést vagy díjterhelést.