Udviklere

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

Kontrollér status for et nummerporteringsprojekt

Læs projektoversigten og antallet af numre pr. status uden at hente legitimationsoplysninger til fakturering.

På denne side
  1. Adgang til konto og projekt
  2. Anmodning
  3. Svar
  4. En oversigt er ikke et resultat for samtlige numre
  5. Fortolk status for nummerportering
  6. Fejl og begrænsninger
  7. Virkninger

Adgang til konto og projekt

Brug en aktiveret API-konto via HTTPS fra en tilladt IP-adresse. Projektet skal tilhøre den pågældende konto og må ikke være slettet. Brug projektets entydige ID fra arbejdsgangen til bestilling af nummerportering, ikke dets numeriske database-ID eller et telefonnummer. URL-kod projektets ID, når du opbygger en anmodning.

Anmodning

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

Dette endepunkt læser hverken anmodningsindhold, sideinddeling eller datofilter.

Svar

Fiktivt eksempel på et svar.

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

Det ydre felt status.code angiver resultatet fra API. Det særskilte felt response.status er projektets afledte statusoversigt for nummerportering. Forveksl ikke de to.

En oversigt er ikke et resultat for samtlige numre

Oversigten vælger In Progress, hvis et nummer har denne status, ellers Pending, ellers Completed, ellers Rejected. Hvis ingen kendt status matcher, bruges Pending som standard. Et projekt, der indeholder både numre med gennemført portering og afviste numre, angiver derfor Completed, selv om det stadig indeholder afviste numre.

Kontrollér altid antallene og listen over de enkelte numre, før du vurderer, at hele projektet er afsluttet. counts.total omfatter hver række med et projektnummer; de øvrige tællere dækker kun de fire kendte statusværdier, og summen af dem svarer muligvis ikke til det samlede antal, hvis der findes andre værdier. Et projekt uden numre angiver nul i alle tællere og Pending i oversigten.

Fortolk status for nummerportering

Kendte statusværdier for numre
VærdiBetegnelse
0Pending
1In Progress
2Completed
9Rejected

Bevar den numeriske status, og håndtér også ukendte værdier. Ved ukendte betegnelser bruges den lagrede værdi; der er ingen garanti for en ny betegnelse. En lagret status for gennemført portering eller en planlagt dato tester ikke i sig selv indgående routing eller alle tjenester på nummeret.

Fejl og begrænsninger

Kontrollér både HTTP-svaret og status.code/status.msg. Hvis projektet mangler, er slettet eller ikke tilhører kontoen, returneres API-kode 404 med en meddelelse om, at projektet ikke blev fundet. Krav om autentificering og begrænsninger for kilde-IP gælder også. Eksemplerne sender ikke en anmodning til den aktive tjeneste, og et vellykket svar er ikke bevis på, at en teleoperatør har accepteret eller gennemført en nummerportering.

Virkninger

Dette endepunkt læser lagrede antal for projektet. I den gennemgåede behandlingsfunktion indsender det ikke en nummerportering, ændrer ikke en status, starter ikke et opkald og debiterer ikke kontoen. Det tilbyder hverken forespørgsler til teleoperatøren i realtid eller abonnement på webhooks.