CNAM-integratie

CNAM REST-API-referentie

Vraag een bellernaam op via HTTPS en verwerk het resultaat, de kosten en fouten.

Kies het opzoekgedrag

Niveau	Openbare prijs per opvraging	Wat het doet
Starter	US$ 0,0026	Gebruikt eigen en in de cache opgeslagen bellernaaminformatie.
Standard	US$ 0,0037	Voert voor elke opvraging een realtime netwerkopzoeking uit.
Mixed	US$ 0,004	Probeert eerst een realtime opzoeking en valt terug op gegevens van Starter wanneer er geen naam wordt gevonden.

De gekozen dienst bepaalt het opzoekgedrag; Mixed is geen opzoeking waarbij eerst de cache wordt geraadpleegd. Controleer het tarief dat aan uw account is toegewezen voordat u het in productie gebruikt. Een bellernaam is geen bewijs van identiteit of eigendom.

Verstuur een geauthenticeerde opzoeking

Endpoint: GET https://api.multitel.net/v3/cnam/NUMBER. Gebruik het telefoonnummer in internationaal formaat inclusief landcode, met alleen cijfers en zonder leestekens of een plusteken vooraan. Voer dit uit vanaf uw applicatieserver met goedgekeurde API-inloggegevens.

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/cnam/12025550123"

Lever de twee omgevingsvariabelen aan via serverzijdige geheimenconfiguratie. Een toegewezen bearer-credential is alleen een alternatief wanneer die toegang is ingeschakeld en aan de bron-IP-beperkingen is voldaan. Plaats nooit een API-geheim in een openbare browserbundel.

Gids voor API-authenticatie en de eerste aanvraag

Lees de JSON-respons

Deze respons is illustratief. De geretourneerde naam en de kosten zijn afhankelijk van de opzoeking en de gekozen dienst.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE CALLER",
    "cost": "0.004",
    "balance": "24.9960"
  }
}

status.code: Applicatieresultaatcode; normaliseer tekenreeks- en numerieke waarden voordat u ze met 200 vergelijkt.
status.msg: Het bijbehorende resultaat- of afwijzingsbericht.
response.number: Het opgevraagde nummer.
response.name: De beschikbare bellernaam.
response.cost: De voor deze opvraging gerapporteerde kosten; behandel ze als een decimaal bedrag.
response.balance: Het gerapporteerde accountsaldo, indien aanwezig.

Resultaten zonder naam en fouten

Een geslaagde aanvraag garandeert geen bruikbare bellernaam. Behandel een lege naam, een nummer dat in plaats van een naam wordt geretourneerd en een afgewezen opzoeking. Applicatiecode 403 kan duiden op onvoldoende tegoed, een niet-toegestane aankoop of een nummer zonder resultaat; controleer het bericht.

Controleer zowel de HTTP-status als de JSON-status voordat u response.name raadpleegt. Het responsobject kan bij een fout ontbreken. Een ontbrekende naam mag de normale routering van het gesprek niet verhinderen.

Facturatie, nieuwe pogingen en het verschil met het bijwerken van de beller-ID

Een nieuwe opzoeking kan een opvragingskost met zich meebrengen. Deze opzoekinterfaces documenteren geen idempotentiesleutel, dus een nieuwe poging kan een tweede factureerbare opvraging zijn. Gebruik beperkte backoff bij transport- of servicefouten, los accountfouten eerst op en reconcilieer de gerapporteerde opvragingskosten. Cache alleen gedurende een periode die past bij uw applicatie; gegevens over bellernamen kunnen veranderen.

Een CNAM-opzoeking leest een naam uit. Ze wijzigt niet de naam die bij uw uitgaande gesprekken wordt getoond. Een LIDB-bijwerking van de bellernaam is een aparte bewerking met eigen velden, autorisatie, prijs en verwerking.

CNAM-integratiegids van het account Hulp bij integratie vragen