Számhordozási projekt állapotának ellenőrzése

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

Engedélyezett IP-címről, HTTPS protokollon keresztül használjon egy aktív API-fiókot. 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/status"

Ez a végpont nem olvas be kéréstörzset, lapozási paramétereket vagy dátumszűrőt.

Válasz

Kitalált válaszpélda.

{
  "status": {
    "code": 200,
    "msg": "Project Status"
  },
  "response": {
    "uniqueid": "PROJECT_EXAMPLE",
    "status": 2,
    "status_str": "Completed",
    "counts": {
      "total": 2,
      "pending": 0,
      "in_progress": 0,
      "completed": 1,
      "rejected": 1
    }
  }
}

A külső status.code az API eredményét jelzi. A különálló response.status a projekt számhordozási állapotának származtatott összesítése. Ne tévessze össze a kettőt.

Az összesítés nem az összes szám közös eredménye

Az összesítés értéke In Progress, ha bármelyik szám ebben az állapotban van; egyébként Pending, majd Completed, végül Rejected, az első olyan állapot szerint, amelyhez tartozik szám. Ha egyetlen ismert állapot sem található, az alapértelmezett érték Pending. Ezért a befejezett és elutasított számokat egyaránt tartalmazó projekt Completed értéket jelez, miközben továbbra is vannak benne elutasított számok.

Mielőtt az egész projektet befejezettnek tekintené, mindig ellenőrizze a darabszámokat és az egyes számok listáját. counts.total minden, a projekt egy számához tartozó sort beleszámít; a többi számláló csak a négy ismert állapotértéket fedi le, így más értékek jelenlétekor az összegük eltérhet a teljes darabszámtól. A számokat nem tartalmazó projekt minden számlálója nulla, összesített állapota pedig Pending.

A számhordozási állapot értelmezése

Őrizze meg a numerikus állapotot, és kezelje az ismeretlen értékeket is. Ismeretlen megnevezés esetén a tárolt érték jelenik meg; új megnevezés nem garantált. A tárolt befejezési állapot vagy ütemezett dátum önmagában nem ellenőrzi a bejövő hívások útválasztását vagy a számhoz tartozó összes szolgáltatást.

Hibák és korlátok

Ellenőrizze mind a HTTP-választ, mind a következő mezőket: status.code/status.msg. Hiányzó, törölt vagy nem a fiókhoz tartozó projekt esetén a visszaadott API-kód 404, a hozzá tartozó üzenet pedig azt jelzi, hogy a projekt nem található. A hitelesítési és a forrás IP-címére vonatkozó korlátozások szintén érvényesek. A példák nem hajtanak végre é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

Ez a végpont a projekt tárolt darabszámait olvassa ki. Az áttekintett kezelőben nem nyújt be számhordozási kérelmet, nem módosít állapotot, nem kezdeményez hívást, és nem terheli meg a fiókot. Nem biztosít valós idejű szolgáltatói állapotlekérdezést vagy webhook-feliratkozást.