Zjištění stavu projektu přenosu čísel

Přístup k účtu a projektu

Použijte aktivovaný účet API přes HTTPS z povolené IP adresy. Projekt musí patřit tomuto účtu a nesmí být odstraněn. Použijte jedinečný identifikátor projektu z procesu objednávky přenosu čísel, nikoli jeho číselný databázový identifikátor nebo telefonní číslo. Při sestavování požadavku zakódujte identifikátor projektu pro použití v URL.

Požadavek

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

Tento koncový bod nečte tělo požadavku, parametry stránkování ani filtr podle data.

Odpověď

Smyšlený příklad odpovědi.

{
  "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
    }
  }
}

Vnější pole status.code uvádí výsledek API. Samostatné pole response.status představuje odvozený souhrnný stav přenosu čísel v projektu. Tato dvě pole nezaměňujte.

Souhrnný stav není výsledkem pro všechna čísla

Souhrnný stav se nastaví na In Progress, pokud má tento stav alespoň jedno číslo; jinak na Pending, jinak na Completed a jinak na Rejected. Pokud žádné číslo nemá některý ze známých stavů, použije se výchozí hodnota Pending. Projekt obsahující čísla s dokončeným i zamítnutým přenosem proto vykazuje Completed, přestože stále obsahuje čísla se zamítnutým přenosem.

Než usoudíte, že je celý projekt dokončen, vždy zkontrolujte počty a seznam jednotlivých čísel. counts.total zahrnuje každý řádek s číslem projektu; ostatní počty zahrnují pouze čtyři známé hodnoty stavu, a pokud se vyskytují i jiné hodnoty, jejich součet nemusí odpovídat celkovému počtu. Projekt bez čísel vykazuje nulové počty a souhrnný stav Pending.

Výklad stavu přenosu čísel

Zachovejte číselnou hodnotu stavu a počítejte i s neznámými hodnotami. U neznámých označení se použije uložená hodnota; nové označení není zaručeno. Samotný uložený stav dokončení ani naplánované datum neověřují směrování příchozích hovorů ani všechny služby na daném čísle.

Chyby a omezení

Zkontrolujte jak odpověď HTTP, tak status.code/status.msg. Pokud projekt neexistuje, byl odstraněn nebo nepatří danému účtu, vrátí se kód API 404 se zprávou, že projekt nebyl nalezen. Platí také požadavky na ověření totožnosti a omezení zdrojové IP adresy. Příklady neodesílají skutečný požadavek a úspěšná odpověď není důkazem, že operátor přenos přijal nebo dokončil.

Účinky

Tento koncový bod čte uložené počty projektu. Ve zkontrolované obslužné funkci neodesílá žádost o přenos, nemění stav, nezahajuje hovor ani nestrhává prostředky z účtu. Neposkytuje dotazování operátora v reálném čase ani přihlášení k odběru oznámení přes webhook.