Gaan ’n nommeroordragprojek se status na

Toegang tot die rekening en projek

Gebruik ’n geaktiveerde API-rekening oor HTTPS vanaf ’n toegelate IP-adres. Die projek moet aan daardie rekening behoort en mag nie geskrap wees nie. Gebruik die projek se unieke ID uit die werkvloei vir nommeroordragbestellings, nie sy numeriese databasis-ID of ’n telefoonnommer nie. Pas URL-kodering op die projek-ID toe wanneer jy ’n versoek opstel.

Versoek

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

Hierdie eindpunt lees geen versoekliggaam, paginering of datumfilter nie.

Antwoord

Voorbeeld van ’n fiktiewe 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
    }
  }
}

Die buitenste status.code gee die API-resultaat aan. Die afsonderlike response.status is die projek se afgeleide opsomming van nommeroordrag. Moenie die twee verwar nie.

’n Opsomming is nie ’n resultaat vir al die nommers nie

Die opsomming kies In Progress as enige nommer daardie status het, anders Pending, anders Completed, anders Rejected. As geen bekende status ooreenstem nie, word Pending by verstek gebruik. ’n Projek met nommers waarvan die oordrag voltooi is én nommers waarvan die oordrag afgekeur is, gee dus Completed aan, hoewel dit steeds afgekeurde nommers bevat.

Gaan altyd die tellings en die lys van individuele nommers na voordat jy besluit dat die hele projek afgehandel is. counts.total sluit elke ry vir ’n projeknommer in; die ander tellers dek slegs die vier bekende statuswaardes en hul som is moontlik nie gelyk aan die totaal wanneer ander waardes voorkom nie. ’n Projek met geen nommers nie gee nultellings en ’n opsomming van Pending aan.

Verstaan die nommeroordragstatus

Behou die numeriese status en maak voorsiening vir onbekende waardes. Vir onbekende etikette word die gestoorde waarde gebruik; ’n nuwe etiket word nie gewaarborg nie. ’n Gestoorde voltooiingstatus of geskeduleerde datum toets nie op sigself inkomende roetering of elke diens op die nommer nie.

Foute en beperkings

Gaan sowel die HTTP-antwoord na as status.code/status.msg. ’n Projek wat ontbreek, geskrap is of nie aan die rekening behoort nie, lewer API-kode 404 met ’n boodskap dat die projek nie gevind is nie. Outentisering en beperkings op die bron-IP-adres geld ook. Die voorbeelde stuur nie ’n werklike versoek nie, en ’n suksesvolle antwoord is nie bewys dat ’n telekommunikasieoperateur ’n oordrag aanvaar of voltooi het nie.

Uitwerking

Hierdie eindpunt lees gestoorde projektellings. In die nagegane hanteerder dien dit nie ’n oordrag in, verander dit nie ’n status, begin dit nie ’n oproep en debiteer dit nie die rekening nie. Dit bied geen intydse herhaalde navrae aan die telekommunikasieoperateur of intekening op webhaakkennisgewings nie.