Ontwikkelaars

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

De status van een nummerporteringsproject controleren

Bekijk het projectoverzicht en de aantallen per status zonder inloggegevens voor facturering op te halen.

Op deze pagina
  1. Toegang tot account en project
  2. Verzoek
  3. Antwoord
  4. Een samenvatting geeft niet het resultaat voor alle nummers weer
  5. De porteringsstatus begrijpen
  6. Fouten en beperkingen
  7. Effecten

Toegang tot account en project

Gebruik een ingeschakeld API-account via HTTPS vanaf een toegestaan IP-adres. Het project moet bij dat account horen en mag niet verwijderd zijn. Gebruik de unieke project-ID uit het proces voor het aanvragen van nummerportering, niet de numerieke database-ID of een telefoonnummer. Pas URL-codering toe op de project-ID wanneer u een verzoek samenstelt.

Verzoek

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

Dit eindpunt leest geen verzoekinhoud, paginering of datumfilter.

Antwoord

Fictief voorbeeld van een antwoord.

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

Het buitenste veld status.code geeft het resultaat van de API-aanroep weer. Het afzonderlijke veld response.status bevat de afgeleide samenvattende porteringsstatus van het project. Verwar deze twee velden niet.

Een samenvatting geeft niet het resultaat voor alle nummers weer

De samenvatting kiest In Progress als een nummer die status heeft, anders Pending, anders Completed en anders Rejected. Als geen bekende status wordt gevonden, wordt standaard Pending gebruikt. Een project met zowel voltooide als afgewezen nummerporteringen meldt daarom Completed, terwijl het nog steeds nummers met een afgewezen portering bevat.

Controleer altijd de aantallen en de lijst met afzonderlijke nummers voordat u besluit dat het hele project is afgerond. counts.total telt elke rij met een projectnummer mee; de overige tellers omvatten alleen de vier bekende statuswaarden en tellen mogelijk niet op tot het totaal als er andere waarden voorkomen. Een project zonder nummers geeft nulwaarden voor de tellers en een samenvattende status Pending terug.

De porteringsstatus begrijpen

Bekende statuswaarden voor nummers
WaardeAanduiding
0Pending
1In Progress
2Completed
9Rejected

Bewaar de numerieke status en zorg dat onbekende waarden verwerkt kunnen worden. Bij een onbekende aanduiding wordt de opgeslagen waarde gebruikt; een nieuwe aanduiding is niet gegarandeerd. Een opgeslagen voltooiingsstatus of geplande datum vormt op zichzelf geen controle van de routering van inkomende oproepen of van alle diensten op het nummer.

Fouten en beperkingen

Controleer zowel het HTTP-antwoord als status.code/status.msg. Bij een ontbrekend of verwijderd project, of een project dat niet bij het account hoort, wordt API-code 404 teruggegeven met een melding dat het project niet is gevonden. Ook authenticatie en beperkingen voor het bron-IP-adres zijn van toepassing. De voorbeelden voeren geen echt verzoek uit en een geslaagd antwoord bewijst niet dat een operator een portering heeft geaccepteerd of voltooid.

Effecten

Dit eindpunt leest de opgeslagen projectaantallen. In de beoordeelde handler dient het geen porteringsaanvraag in, wijzigt het geen status, start het geen oproep en schrijft het geen geld van het account af. Het biedt geen realtime opvragingen bij de operator of abonnement op webhooks.