Hent et porteringsprosjekt

Tilgang til konto og prosjekt

Bruk en aktivert API-konto over HTTPS fra en tillatt IP-adresse. Prosjektet må tilhøre denne kontoen og må ikke være slettet. Bruk prosjektets unike ID fra arbeidsflyten for porteringsbestillinger, ikke den numeriske database-ID-en eller et telefonnummer. URL-kod prosjekt-ID-en når du bygger en forespørsel.

Forespørsel

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

Behandle dette svaret som konfidensielt

Det fullstendige svaret inneholder faktureringsopplysninger hos avgivende operatør, inkludert den lagrede verdien for billing_pin, faktureringskonto, telefon, adresse, selskap og opplysninger om autorisert kontaktperson. API-et maskerer ikke disse feltene. Be bare om statusen eller nummerlisten når det er alt arbeidsflyten trenger. Hold det fullstendige detaljsvaret utenfor nettleserlagring, analysesystemer, offentlige logger og skjermbilder til kundestøtte, og vis bare feltene som en autorisert kunde trenger.

Svarstruktur

Oppdiktet eksempel med utvalgte felt; flere felt kan bli returnert.

{
  "status": {
    "code": 200,
    "msg": "Project Detail"
  },
  "response": {
    "project": {
      "id": 11,
      "uniqueid": "PROJECT_EXAMPLE",
      "project_name": "Example transfer",
      "location": "US",
      "status": 0,
      "status_str": "Pending"
    },
    "counts": {
      "total": 0,
      "pending": 0,
      "in_progress": 0,
      "completed": 0,
      "rejected": 0
    },
    "numbers": [],
    "events": [],
    "uploads": []
  }
}

Dette bevisst ufullstendige eksemplet utelater alle autentiseringsopplysninger for fakturering og personlige kontaktopplysninger. At de er utelatt fra eksemplet, betyr ikke at de skjules i det faktiske svaret.

Deler i prosjektdetaljene
Del	Innhold
project	Numerisk rad-ID, unik prosjekt-ID, prosjektnavn, lokasjon, lagrede fakturerings-, kontakt- og adresseopplysninger, opprettelsestidspunkt og avledet status. Det eldre feltet for avgivende operatør er stavet loosing_carrier.
counts	Totalt antall nummerrader og tellere for Pending, In Progress, Completed og Rejected.
numbers	Det samme utvalget av nummeropplysninger som i endepunktet for prosjektets nummerliste, inkludert kundekommentarer og lagrede planleggingsverdier.
events	Lagrede hendelsesrader og felt med rå og parsede nyttelastdata, underlagt hendelsesendepunktets begrensninger for synlighet og format.
uploads	Dokumentmetadata: numerisk ID, upload_type, file_name, file_extension, date_created og en relativ download_url. URL-en krever fortsatt kontoautentisering.

Tolk sammendraget og metadataene

Den avledede statusen prioriterer In Progress, deretter Pending, så Completed og til slutt Rejected, med Pending som reserveverdi. Sammendragsstatusen Completed kan forekomme selv om noen numre er avvist. Kontroller tellerne og nummerstatusene i stedet for å anta at porteringen er fullført for alle numrene.

Svaret inneholder dokumentmetadata, ikke filenes byteinnhold. Det har verken paginering eller en inkrementell markør. Detalj- og listespørringene er separate lesinger, ikke ett øyeblikksbilde med garantert transaksjonskonsistens. Datoer beholdes slik de er lagret, uten noen dokumentert tidssonekonvertering. Bruk uniqueid i prosjektruter; den numeriske prosjekt-ID-en kan ikke brukes som erstatning.

Feil og begrensninger

Kontroller både HTTP-svaret og status.code/status.msg. Et prosjekt som mangler, er slettet eller ikke tilhører kontoen, returnerer API-kode 404 med en melding om at prosjektet ikke ble funnet. Krav til autentisering og begrensninger for kilde-IP gjelder også. Eksemplene sender ingen reell forespørsel, og et vellykket svar er ikke bevis på at en operatør har godtatt eller fullført en portering.

Virkninger og arbeidsflyt

Dette er den kanoniske detaljruten som brukes i den nåværende portalens visning av porteringsbestillinger. Portalen tilordner felt til brukergrensesnittet og bruker sitt eget utvalg av opplysninger for kunden; ikke anta at det rå API-svaret er identisk med portalens JSON eller presentasjon. Den gjennomgåtte behandlingsfunksjonen for detaljer endrer ikke prosjektet og starter heller ikke direkte en forespørsel til operatøren eller en belastning.