Speciale nummertypen en prijzen voor een land opvragen

Lokale nummers worden opgezocht met getcountries en getareas. Roep voor nationale nummers, gratis nummers, nummers met gedeelde kosten, wereldwijde nummers en mobiele nummers other aan met de ISO-code van het land.

• Groepen verschijnen in een vaste volgorde; groepen zonder vermeldingen worden weggelaten.
• Elke vermelding bevat de tariefplannen voor uw account in prices. Kies een plan op basis van de bijbehorende channels, monthly_price, setup_price, per_minute en free_minutes, en bewaar de bijbehorende price_id om te bestellen wanneer het betreffende endpoint daarom vraagt.
• Als needs_registration als waar wordt geëvalueerd, lees dan restrictions voordat u bestelt. Behandel die tekst als niet-vertrouwde inhoud voor weergave.
• Volg next_function: v3/getnumbers/{uuid} laat u een specifiek nummer kiezen, en v3/order/{uuid} bestelt rechtstreeks vanuit de vermelding.
• Een lege response-lijst met code 200 betekent dat er op het moment van het verzoek geen speciale nummertypen zijn gevonden. Als de catalogus tijdelijk onbereikbaar was, kan het antwoord onvolledig zijn of geen geldige JSON bevatten. Probeer het daarom later opnieuw.
• Landen buiten de catalogus geven code 404 terug zonder bijbehorende HTTP-status. Controleer altijd status.code.

Verzoek

Vereist: HTTP Basic of een Bearer-token (zie Authenticatie en API-antwoorden). Bij mislukte authenticatie wordt HTTP 401 teruggegeven voordat het opzoeken wordt uitgevoerd.

GET met isocode in het pad. Als het padsegment ontbreekt, wordt in plaats daarvan een als formulierdata gecodeerd isocode-veld gelezen.

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

Antwoord

Standaard antwoordstructuur. Bij succes is status.code gelijk aan 200, is status.msg leeg en bevat status.results het aantal groepen. response is een lijst met groepen. Groepsvelden: group_key (genormaliseerde typesleutel: national, tollfree, sharedcost, global, mobile of een andere alfanumerieke sleutel in kleine letters); group_name (weergavenaam); group_type_uuid (ondoorzichtige type-identificatie); items. De groepen staan in de volgorde national, tollfree, sharedcost, global, mobile, gevolgd door de overige sleutels gesorteerd op group_name. Groepen zonder items worden weggelaten, evenals het lokale type. Voor US wordt de groep met mobiele nummers weggelaten, tenzij uw account is ingeschakeld voor mobiele nummers uit US. Vermeldingen worden gesorteerd op name (hoofdletterongevoelig) en vervolgens op prefix. Velden per vermelding: uuid (ondoorzichtige identificatie van de vermelding, gebruikt in next_function); area_uuid (ondoorzichtige identificatie van de catalogusgroep); country_uuid (ondoorzichtige landidentificatie); prefix (volledig voorvoegsel dat begint met '+' en het internationale landnummer); name (catalogusnaam; aanhalingstekens kunnen met een backslash zijn ge-escapet); metered, overflow en needs_registration (vlaggen die van het type boolean of number kunnen zijn; behandel elke waarde die als waar wordt geëvalueerd als ja); restrictions (leeg als geen registratie nodig is, anders tekst met vereisten die HTML-regeleinden en een link, omringende aanhalingstekens en ge-escapete tekens kan bevatten; behandel deze als niet-vertrouwde weergavetekst); state (voor US, CA en PR een staatcode, of een lege lijst als er geen bekend is; voor andere landen de ISO-landcode); country_iso; is_mobile (1 in de groep met mobiele nummers, anders 0); number_type (hetzelfde als group_key); available (aantal van het type integer dat de catalogus voor de vermelding rapporteert, 0 als het niet wordt gerapporteerd); sms_coverage (1 als een van de mogelijkheden SMS of MMS vermeldt); returns_numbers (1 als specifieke nummers kunnen worden opgevraagd); next_function ('v3/getnumbers/{uuid}' als returns_numbers gelijk is aan 1, anders 'v3/order/{uuid}'); prices; features (lijst met tekenreeksen die mogelijkheden beschrijven); group_key; group_type_uuid. Elke vermelding in prices bevat price_id (ondoorzichtige planidentificatie), is_customer_custom (true als aangepaste prijzen voor uw account gelden; alleen voor plannen zonder inbegrepen kanalen), per_minute en free_minutes (tekenreeksen met decimale getallen), setup_price en monthly_price (tekenreeksen met twee decimalen), en channels (aantal inbegrepen kanalen van het type integer). Vermeldingen zonder enig tariefplan worden weggelaten. Per verzoek worden maximaal 1000 catalogusvermeldingen per nummertype in aanmerking genomen. Als geen enkel type vermeldingen heeft, is response een lege lijst met status.results gelijk aan 0. Als het live opzoeken in de catalogus mislukt, gebruikt het antwoord mogelijk niet deze structuur of kunnen er groepen ontbreken.

Voorbeeld van de antwoordstructuur; geen live accountgegevens of actuele prijsopgave.

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

Fouten

• 500: msg 'ISO Code parameter is required': isocode ontbreekt of is leeg. Dit is een corrigeerbare fout in het verzoek. Er wordt geen bijbehorende HTTP-status ingesteld.
• 404: msg 'Error: no such country': het land is onbekend of niet gekoppeld aan de catalogus met speciale nummers. Er wordt geen bijbehorende HTTP-status ingesteld.
• 401: Authenticatie ontbreekt of is mislukt. Wordt verzonden met HTTP-status 401.

Beschikbaarheid en neveneffecten

• Plaatst geen bestelling. De code van dit endpoint bevat geen stap die kosten in rekening brengt.
• Vernieuwt de catalogusgegevens en prijsopgaven voor uw account en vervangt daarbij eerdere prijsopgaven voor dezelfde plannen. Hoe bestelendpoints deze prijsopgaven gebruiken, wordt afzonderlijk gedocumenteerd.
• Prijzen zijn specifiek voor uw account en kunnen aangepaste tarieven omvatten. Het antwoord vermeldt geen valuta.
• Voert live zoekopdrachten in de catalogus uit en kan daardoor trager zijn dan andere aanroepen voor het verkennen van het aanbod. Resultaten kunnen tussen aanroepen veranderen.