Ontwikkelaars

GET/v3/cnam/{number}

De naam van een beller opzoeken

Vraag een beschikbare bellersnaam op en lees meer over accounttarieven, vervangende waarden en limieten voor herhaalde pogingen.

Op deze pagina
  1. De naam van een beller opzoeken
  2. Verzoek
  3. Antwoord
  4. Kosten en afstemming
  5. Fouten en herhaalde pogingen
  6. Andere nummerbewerkingen

De naam van een beller opzoeken

Vraag de beschikbare bellersnaam voor een telefoonnummer op. Deze zoekopdracht wordt in de productieomgeving uitgevoerd en kan kosten voor uw account veroorzaken, ook als het resultaat uit de cache van de dienst komt. De naam die bij uitgaande oproepen vanaf een nummer in uw bezit wordt weergegeven, wordt hiermee niet gewijzigd.

Een geretourneerde naam is geen bewijs van identiteit, eigendom van het nummer of toestemming om te bellen. Namen kunnen ontbreken, verouderd of afgekort zijn, of bestaan uit een geografische aanduiding of het telefoonnummer als vervangende waarde.

Verzoek

Gebruik uw ingeschakelde API-account vanaf het daarvoor toegestane bron-IP-adres. Bewaar inloggegevens in een geheimenopslag aan de serverzijde. Het voorbeeld gebruikt omgevingsvariabelen en een fictief Noord-Amerikaans nummer; plaats geen inloggegevens in URL's of openbaar toegankelijke browsercode.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/cnam/12025550123

Geef het volledige nummer op als cijfers, inclusief landcode, bijvoorbeeld elf cijfers die beginnen met 1 voor Noord-Amerika. Reken er niet op dat de verwerkingscode leestekens of een plusteken normaliseert. Een verzoekinhoud of regiokeuze is niet vereist. Vraag MultiTEL welke dekking voor uw beoogde gebruik wordt ondersteund.

Antwoord

De waarden dienen alleen als voorbeeld; het bedrag is geen prijsopgave.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE NAME",
    "cost": 0.0037,
    "balance": 9.9963
  }
}
Velden voor het opzoeken van bellersnamen
VeldBetekenis
numberHet opgevraagde nummer.
nameDe beschikbare naam of vervangende tekst. Dit is geen identiteitsverificatie.
costDe voor het account of de dienst ingestelde opzoekprijs die dit uitvoeringspad rapporteert. Gebruik het actuele accounttarief, niet de voorbeeldwaarde.
balanceHet saldo dat voor het antwoord is berekend. Dit is geen nieuwe transactionele opvraging van het accountsaldo.

Kosten en afstemming

Voor resultaten met een naam wordt de voor het account ingestelde CNAM-prijs in rekening gebracht. Een herhaalde opvraag of een opvraag uit de cache kan opnieuw kosten veroorzaken; er is geen idempotentiesleutel beschikbaar. Controleer het actuele accounttarief voordat u geautomatiseerde opvragingen inschakelt.

Er is een bekende beperking in het antwoord bij een lege naam in de cache: de verwerkingscode kan API-code 200 retourneren met een lege naam, kosten die niet nul zijn en een verlaagd berekend saldo, hoewel dat uitvoeringspad niets van het account afschrijft. Beschouw dat antwoord op zichzelf niet als bewijs van een afschrijving. Vergelijk de gegevens met de factureringsgegevens van het account en een nieuwe saldo-opvraging, en neem bij onduidelijke resultaten contact op met de ondersteuning.

De controle van het prepaidtegoed vereist momenteel een saldo van minimaal 0.004 vóór de opvraging, ongeacht de ingestelde prijs per opvraging. Een account waarvoor aankopen zijn uitgeschakeld, wordt ook geweigerd. Deze controles maken dit eindpunt niet tot een API voor prijsopgaven of bestedingslimieten.

Fouten en herhaalde pogingen

Controleer zowel de HTTP-status als status.code/status.msg in JSON. API-code 403 kan wijzen op onvoldoende prepaidtegoed, een aankoopverbod, een probleem met de accountautorisatie of het ontbreken van een gevonden bellersnaam. Het uitvoeringspad zonder naam kan de code als tekenreeks retourneren. Bekijk het bericht in plaats van elke 403 als onjuiste inloggegevens te beschouwen. Configuratieconflicten kunnen API-code 500 opleveren.

Een time-out kan optreden nadat een opvraging waarvoor kosten gelden al is uitgevoerd. Gebruik alleen een beperkt aantal herhaalde pogingen met oplopende wachttijden als dat voor uw toepassing passend is, en stem pogingen met een onzekere uitkomst eerst af. Blijf een geweigerd nummer of een verzoek dat door accountrechten of saldo is mislukt niet opnieuw proberen. Een antwoordcache in uw eigen toepassing kan herhaalde verzoeken verminderen, met inachtneming van uw overeenkomst en nauwkeurigheidseisen.

Andere nummerbewerkingen

Deze leesbewerking staat los van het bijwerken van de naam voor uitgaande oproepen/LIDB, een vermelding in een telefoongids of bellerregistratie. Voor die bewerkingen gelden eigen verplichte velden, autorisatievereisten en kosten. Gebruik dekkingscontrole van nummertoewijzingen voor een controle in de prefixtabel of nummerzoekfunctie voor nummers die kunnen worden besteld. Geen van deze bewerkingen bewijst dat een beller is wie die beweert te zijn.