Lista särskilda nummertyper och priser för ett land

Lokala nummer hittas med getcountries och getareas. För nationella nummer, frisamtalsnummer, nummer med delad samtalskostnad, globala nummer och mobilnummer anropar du other med landets ISO-kod.

• Grupperna visas i en fast ordning, och grupper utan poster utelämnas.
• Varje post listar prisplanerna för ditt konto i prices. Välj en plan utifrån dess channels, monthly_price, setup_price, per_minute och free_minutes, och spara dess price_id för beställning när beställningsändpunkten kräver det.
• Om needs_registration har ett värde som utvärderas som sant, läs restrictions före beställning. Behandla texten som visningsinnehåll som inte är betrott.
• Följ next_function: v3/getnumbers/{uuid} låter dig välja ett specifikt nummer, och v3/order/{uuid} beställer direkt från posten.
• En tom response-lista med koden 200 betyder att inga särskilda nummertyper hittades vid tidpunkten för begäran. Om katalogen tillfälligt inte gick att nå kan svaret vara ofullständigt eller sakna giltigt JSON-format, så försök igen senare.
• Länder som inte finns i katalogen ger koden 404 utan motsvarande HTTP-status. Kontrollera alltid status.code.

Begäran

Krävs: HTTP Basic eller en Bearer-token (se Autentisering och API-svar). Misslyckad autentisering besvaras med HTTP 401 innan uppslagningen körs.

GET med isocode i sökvägen. Om sökvägssegmentet utelämnas läses i stället ett formulärkodat isocode-fält.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/other/FR'

Svar

Standardstruktur för svaret. Vid lyckat resultat är status.code 200, status.msg är tomt och status.results är antalet grupper. response är en lista med grupper. Gruppfält: group_key (normaliserad typnyckel: national, tollfree, sharedcost, global, mobile eller en annan alfanumerisk nyckel med små bokstäver); group_name (visningsnamn); group_type_uuid (opak typidentifierare); items. Grupperna sorteras i ordningen national, tollfree, sharedcost, global, mobile, därefter övriga nycklar efter group_name. Grupper utan items utelämnas, liksom typen för lokala nummer. För US utelämnas mobilgruppen om ditt konto inte är aktiverat för mobilnummer i US. Posterna sorteras efter name (utan hänsyn till stora och små bokstäver), därefter efter prefix. Postfält: uuid (opak postidentifierare som används i next_function); area_uuid (opak identifierare för kataloggruppen); country_uuid (opak landsidentifierare); prefix (fullständigt prefix som börjar med '+' och landsnumret); name (katalognamn; citationstecken kan vara escape-kodade med omvänt snedstreck); metered, overflow och needs_registration (flaggor som kan vara av typen boolean eller number; behandla alla värden som utvärderas som sanna som ja); restrictions (tomt när ingen registrering krävs, annars kravtext som kan innehålla HTML-radbrytningar och en länk, omgivande citationstecken och escape-kodade tecken; behandla den som visningstext som inte är betrodd); state (för US, CA och PR en delstatskod, eller en tom lista om ingen är känd; för andra länder landets ISO-kod); country_iso; is_mobile (1 i mobilgruppen, annars 0); number_type (samma som group_key); available (antal av typen integer som katalogen rapporterar för posten, 0 när det inte rapporteras); sms_coverage (1 om någon funktion nämner SMS eller MMS); returns_numbers (1 när specifika nummer kan listas); next_function ('v3/getnumbers/{uuid}' när returns_numbers är 1, annars 'v3/order/{uuid}'); prices; features (lista med strängar som beskriver funktioner); group_key; group_type_uuid. Varje post i prices har price_id (opak planidentifierare), is_customer_custom (true när anpassad prissättning gäller för ditt konto; endast för planer utan inkluderade kanaler), per_minute och free_minutes (strängar med decimaltal), setup_price och monthly_price (strängar med två decimaler) samt channels (antal inkluderade kanaler av typen integer). Poster utan någon prisplan utelämnas. Högst 1000 katalogposter per nummertyp beaktas per begäran. Om ingen typ har några poster är response en tom lista med status.results lika med 0. Om uppslagningen i den aktuella katalogen misslyckas kan svaret avvika från denna struktur, eller så kan grupper saknas.

Exempel på svarsstruktur; varken aktuella kontouppgifter eller en aktuell prisoffert.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

Fel

• 500: msg 'ISO Code parameter is required': isocode saknas eller är tomt. Detta är ett fel i begäran som går att rätta till. Ingen motsvarande HTTP-status anges.
• 404: msg 'Error: no such country': landet är okänt eller inte kopplat till katalogen för särskilda nummer. Ingen motsvarande HTTP-status anges.
• 401: Autentisering saknas eller misslyckades. Skickas med HTTP-status 401.

Tillgänglighet och sidoeffekter

• Gör ingen beställning. Koden för denna ändpunkt innehåller inget debiteringssteg.
• Uppdaterar kataloguppgifterna och prisofferterna för ditt konto och ersätter tidigare offerter för samma planer. Hur beställningsändpunkterna använder dessa offerter dokumenteras separat.
• Priserna är specifika för ditt konto och kan omfatta anpassad prissättning. Svaret anger ingen valuta.
• Gör uppslagningar i katalogen i realtid och kan därför vara långsammare än andra anrop för att hitta nummer. Resultaten kan ändras mellan anrop.