Utvecklare

GET/v3/lnp/project/{uniqueid}

Hämta ett nummerporteringsprojekt

Hämta projektuppgifter, nummer, historik och dokumentmetadata i ett enda privat svar för kontot.

På denna sida
  1. Åtkomst till konto och projekt
  2. Begäran
  3. Behandla detta svar som konfidentiellt
  4. Svarets struktur
  5. Tolka sammanfattningen och metadata
  6. Fel och begränsningar
  7. Effekter och arbetsflöde

Åtkomst till konto och projekt

Använd ett aktiverat API-konto via HTTPS från en tillåten IP-adress. Projektet måste tillhöra det kontot och får inte vara raderat. Använd projektets unika ID från arbetsflödet för porteringsbeställningar, inte dess numeriska databas-ID eller ett telefonnummer. URL-koda projektets ID när du skapar en begäran.

Begäran

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

Behandla detta svar som konfidentiellt

Det fullständiga svaret innehåller faktureringsuppgifter för den operatör som numret flyttas från, bland annat det lagrade värdet för billing_pin, faktureringskonto, telefonnummer, adress, företag och uppgifter om behörig kontaktperson. API:et maskerar inte dessa fält. Begär endast status eller nummerlista när det är allt ditt arbetsflöde behöver. Spara inte det fullständiga detaljsvaret i webbläsarlagring, analysverktyg, offentliga loggar eller skärmbilder för support, och visa endast de fält som en behörig kund behöver.

Svarets struktur

Fiktivt exempel med utvalda fält; fler fält kan returneras.

{
  "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": []
  }
}

Detta avsiktligt ofullständiga exempel utelämnar alla autentiseringsuppgifter för fakturering och alla personliga kontaktuppgifter. Att de utelämnas i exemplet innebär inte att de döljs i det verkliga svaret.

Avsnitt i projektinformationen
AvsnittInnehåll
projectNumeriskt rad-ID, unikt projekt-ID, projektnamn, plats, lagrade fakturerings-, kontakt- och adressuppgifter, tidpunkt för skapande samt härledd status. Det äldre fältet för operatören som numret flyttas från stavas loosing_carrier.
countsTotalt antal nummerrader och räknare för Pending, In Progress, Completed och Rejected.
numbersSamma urval av nummeruppgifter som i ändpunkten för projektets nummerlista, inklusive kundkommentarer och lagrade schemaläggningsvärden.
eventsLagrade händelserader och fält med rått eller tolkat nyttolastinnehåll, med de begränsningar för synlighet och format som gäller för händelseändpunkten.
uploadsDokumentmetadata: numeriskt ID, upload_type, file_name, file_extension, date_created och en relativ download_url. URL:en kräver fortfarande autentisering med kontot.

Tolka sammanfattningen och metadata

Den härledda statusen prioriterar In Progress, därefter Pending, sedan Completed och sist Rejected, med Pending som reservvärde. En sammanfattning med status Completed kan förekomma samtidigt som vissa nummer har avvisats. Kontrollera räknarna och numrens status i stället för att anta att porteringen har slutförts för varje nummer.

Svaret innehåller dokumentmetadata, inte filernas byteinnehåll. Det saknar sidindelning och markör för inkrementell hämtning. Detalj- och listfrågorna är separata läsningar, inte en enda ögonblicksbild med garanterad transaktionskonsistens. Datum återges som lagrade värden utan någon dokumenterad tidszonskonvertering. Använd uniqueid för projektets anropsvägar; det numeriska projekt-ID:t kan inte användas i dess ställe.

Fel och begränsningar

Kontrollera både HTTP-svaret och status.code/status.msg. Om projektet saknas, har raderats eller inte tillhör kontot returneras API-koden 404 med ett meddelande om att projektet inte hittades. Krav på autentisering och begränsningar för källans IP-adress gäller också. Exemplen gör ingen faktisk begäran, och ett lyckat svar bevisar inte att en operatör har godkänt eller slutfört en nummerflytt.

Effekter och arbetsflöde

Detta är den kanoniska anropsväg för detaljer som används av den nuvarande portalens vy för porteringsbeställningar. Portalen mappar fält för sitt användargränssnitt och gör sitt eget urval av uppgifter för kunden; anta inte att det råa API-svaret är identiskt med portalens JSON eller presentation. Den granskade detaljhanteraren ändrar inte projektet och initierar inte direkt någon begäran till en operatör eller någon debitering.