Programeri

GET/v3/lnp/project/{uniqueid}/status

Provjerite status projekta prijenosa brojeva

Pročitajte sažetak projekta i broj brojeva po statusu bez dohvaćanja vjerodajnica za naplatu.

Na ovoj stranici
  1. Pristup računu i projektu
  2. Zahtjev
  3. Odgovor
  4. Sažetak nije rezultat za sve brojeve
  5. Tumačenje statusa prijenosa brojeva
  6. Pogreške i ograničenja
  7. Učinci

Pristup računu i projektu

Upotrijebite omogućen API račun putem protokola HTTPS s dopuštene IP adrese. Projekt mora pripadati tom računu i ne smije biti izbrisan. Upotrijebite jedinstveni identifikator projekta iz postupka naručivanja prijenosa brojeva, a ne njegov numerički identifikator iz baze podataka ili telefonski broj. Pri sastavljanju zahtjeva kodirajte identifikator projekta za URL.

Zahtjev

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

Ova krajnja točka ne čita tijelo zahtjeva, parametre podjele na stranice ni filtar po datumu.

Odgovor

Izmišljeni primjer odgovora.

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

Vanjsko polje status.code prikazuje rezultat API poziva. Zasebno polje response.status predstavlja izvedeni sažetak prijenosa brojeva za projekt. Nemojte ih zamijeniti.

Sažetak nije rezultat za sve brojeve

Za sažetak se odabire In Progress ako bilo koji broj ima taj status, u suprotnom Pending, zatim Completed, a zatim Rejected. Ako nema podudaranja s poznatim statusom, zadana je vrijednost Pending. Stoga projekt koji sadrži i brojeve čiji je prijenos dovršen i odbijene brojeve prikazuje Completed, iako još sadrži odbijene brojeve.

Uvijek provjerite brojčane podatke i popis pojedinačnih brojeva prije nego što zaključite da je cijeli projekt završen. counts.total uključuje svaki redak s brojem u projektu; ostali brojači obuhvaćaju samo četiri poznate vrijednosti statusa i njihov zbroj možda neće odgovarati ukupnom broju ako postoje druge vrijednosti. Projekt bez brojeva prikazuje nulu u svim brojačima i Pending kao sažetak.

Tumačenje statusa prijenosa brojeva

Poznate vrijednosti statusa brojeva
VrijednostOznaka
0Pending
1In Progress
2Completed
9Rejected

Zadržite numerički status i omogućite obradu nepoznatih vrijednosti. Za nepoznate oznake upotrebljava se pohranjena vrijednost; nova oznaka nije zajamčena. Pohranjeni status dovršetka ili zakazani datum sami po sebi ne provjeravaju usmjeravanje dolaznih poziva ni svaku uslugu na broju.

Pogreške i ograničenja

Provjerite i HTTP odgovor i status.code/status.msg. Ako projekt ne postoji, izbrisan je ili ne pripada računu, vraća se API kod 404 s porukom da projekt nije pronađen. Primjenjuju se i autentifikacija te ograničenja izvorne IP adrese. Primjeri ne šalju stvarni zahtjev, a uspješan odgovor nije dokaz da je telekomunikacijski operator prihvatio ili dovršio prijenos.

Učinci

Ova krajnja točka čita pohranjene brojčane podatke projekta. U pregledanom obrađivaču ne podnosi zahtjev za prijenos, ne mijenja status, ne pokreće poziv i ne tereti račun. Ne omogućuje provjeravanje stanja kod operatora u stvarnom vremenu ni pretplatu na webhook obavijesti.