Lys die voorraad aangekoopte nommers

Lys die rekords van aangekoopte nommers waarvan die gestoorde eienaar ooreenstem met die rekening wat deur jou API-aanmeldbesonderhede verteenwoordig word. Die teenwoordigheid van 'n rekord is iets anders as 'n geslaagde toets met 'n werklike oproep.

Versoek

Gebruik API-aanmeldbesonderhede aan die bedienerkant oor HTTPS. Die voorbeelde lees aanmeldbesonderhede uit omgewingsveranderlikes; hulle bevat geen werkende aanmeldbesonderhede nie. Kontroleer status.code in die JSON-liggaam sowel as die HTTP-status. Hierdie verouderde hanteerders stel nie konsekwent 'n HTTP-foutstatus vir 'n toepassingsfout nie.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory"

Gebruik die opsionele padvorm om volgens 'n enkele gestoorde telefoonnommer te filtreer:

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory/12025550100"

Gebruik die gestoorde internasionale telefoonnommer as syfers, met die landkode ingesluit. Moenie 'n PBX-uitbreiding, nommer-UUID, gebied-ID of voorvoegsel-ID in die plek daarvan deurgee nie. Die verskafte nommer kies 'n bestaande rekord; dit koop of stel nie een op nie.

Antwoord

Die response-lid is by sukses altyd 'n skikking, ook wanneer die padvorm vir 'n enkele nommer gebruik word. status.results is die lengte van die skikking.

Dit is 'n illustrasie van die antwoordstruktuur, nie rekeningdata of 'n huidige pryskwotasie nie.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "number": "12025550100",
      "uuid": "NUMBER_UUID",
      "description": "Main reception",
      "isocode": "US",
      "config": {
        "uri": "sip:reception@example.com",
        "uri2": "",
        "uri3": "",
        "forward_destination": "",
        "sms_uri": "",
        "sms_forward_destination": ""
      },
      "features": {
        "voice": "1",
        "sms": "1",
        "mms": "0"
      },
      "status": {
        "capacity": {
          "assigned_channels": "2",
          "used_channels": "0",
          "overflow": "0",
          "overage_charge": "0.01"
        },
        "origination": {
          "origination_trunk_id": "ORIGINATION_ID",
          "origination_trunk_name": "ORIGINATION_NAME",
          "origination_country_iso": "US",
          "origination_continent_iso": "NA",
          "origination_continent_name": "North America"
        },
        "service_active": "1",
        "force_codec": "",
        "force_dtmf": ""
      },
      "billing": {
        "cnam": "0",
        "overflow": "0",
        "autorenew": "1",
        "persistent": "0",
        "date_created": "2026-01-01 00:00:00"
      },
      "price": {
        "setup_price": "0.00",
        "monthly_price": "1.00",
        "per_minute": "0.01",
        "free_minutes": "0",
        "remaining_minutes": "0"
      }
    }
  ]
}

Nommer-velde wat teruggestuur word
Veld	Betekenis
`number, uuid, description, isocode`	Die gestoorde telefoonnommer, ondeursigtige nommeridentifiseerder, beskrywing en landkode.
`config`	Gestoorde velde vir stemoproepbestemmings, eksterne aanstuur, die SMS-bestemming en SMS-aanstuur. Hierdie eindpunt wysig hulle nie.
`features`	Gestoorde vlae vir stemoproep-, SMS- en MMS-vermoëns. Daar is geen waarborg dat verouderde gestoorde vlae JSON-booleaanse waardes is nie.
`status.capacity`	Waardes vir toegewysde en gebruikte kanale, die oorloopinstelling en die gestoorde heffing vir oorskryding. Dit is gestoorde metadata, nie 'n nuwe kapasiteitskwotasie of 'n toets met 'n werklike oproep nie.
`status.origination`	Gestoorde metadata oor oproepoorsprong. Behandel identifiseerders as ondeursigtig; moenie toepassingslogika uit interne name aflei nie.
`status.service_active, force_codec, force_dtmf`	Gestoorde velde vir aktivering en media-opstelling. 'n Vlag alleen bewys nie dat inkomende aflewering suksesvol is nie.
`billing`	Gestoorde waardes vir CNAM, oorloop, hernuwing, volhouding en skepping. Die lees daarvan verander nie hernuwing of ander faktureringinstellings nie.
`price`	Gestoorde opstelpryse, maandelikse pryse, pryse per minuut en minuuttoelaes. Die hanteerder verskaf geen geldeenheidveld of nuwe kwotasie nie. Moenie die geldeenheid uit die voorbeeldwaardes aflei of hulle as 'n huidige aankoopkwotasie gebruik nie.

Filtrering en bladsyverdeling

Hierdie hanteerder het geen bladsyverdeling, beperking op bladsygrootte of uitdruklike sorteervolgorde nie. Dit stuur alle rekords wat nie nietig verklaar is nie en deur sy navraag gekies word, terug. Dit implementeer nie 'n filter vir slegs aktiewe dienste of 'n afsonderlike aansig vir geargiveerde nommers nie. Moenie aanneem dat die volgorde van teruggestuurde rekords stabiel is nie.

Geen ooreenstemmende nommers nie

As die rekening geen ooreenstemmende rekords het wat nie nietig verklaar is nie, bevat die JSON-liggaam status.code 404 en 'n boodskap wat die volgende bevat: no numbers found. Dit stuur nie 'n leë skikking met 'n suksesstatus terug nie. Die boodskap bevat 'n bronverwysingsagtervoegsel wat kliënte nie as 'n stabiele identifiseerder moet ontleed nie.

Volgende stappe

Gebruik numberinfo wanneer jy die bykomende verouderde registrasie- en nommerverwysingsvelde vir een nommer benodig. Kontroleer die bestemmings vir stemoproepe en boodskappe voordat jy enige roete deur 'n afsonderlike opstelbewerking verander.