CNAM-integrasie

CNAM REST-API-verwysing

Versoek 'n bellernaam oor HTTPS en hanteer die resultaat, koste en foute.

Kies die opsoekgedrag

VlakOpenbare prys per navraagWat dit doen
StarterUSD 0,0026Gebruik eie bellernaaminligting en bellernaaminligting wat in die kas gestoor is.
StandardUSD 0,0037Doen vir elke navraag 'n intydse netwerkopsoek.
MixedUSD 0,004Probeer eers 'n intydse opsoek en val dan terug op Starter-data wanneer geen naam gevind word nie.

Die gekose diens bepaal die opsoekgedrag; Mixed is nie 'n opsoek wat eers die kas gebruik nie. Gaan die tarief na wat aan jou rekening toegewys is voordat jy dit in produksie gebruik. 'n Bellernaam is nie bewys van identiteit of eienaarskap nie.

Stuur 'n geoutentiseerde opsoekversoek

Eindpunt: GET https://api.multitel.net/v3/cnam/NUMBER. Gebruik internasionale telefoonnommers in syferformaat, insluitend die landkode, sonder leestekens of 'n voorafgaande plusteken. Voer dit vanaf jou toepassingsbediener uit met goedgekeurde API-aanmeldbesonderhede.

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

Verskaf die twee omgewingsveranderlikes deur die bediener se geheimekonfigurasie. Uitgereikte bearer-aanmeldbesonderhede is slegs 'n alternatief wanneer daardie toegang geaktiveer is en die bron-IP-beperkings daarvan nagekom word. Plaas nooit 'n API-geheim in 'n openbare blaaierbundel nie.

Gids vir API-stawing en die eerste versoek

Lees die JSON-antwoord

Hierdie antwoord is illustratief. Die teruggestuurde naam en koste hang af van die opsoek en die gekose diens.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE CALLER",
    "cost": "0.004",
    "balance": "24.9960"
  }
}
status.code
Toepassingsresultaatkode; normaliseer string-/numeriese waardes voordat jy met 200 vergelyk.
status.msg
Die gepaardgaande uitkoms- of afwysingsboodskap.
response.number
Die nommer wat nagevra is.
response.name
Die beskikbare bellernaam.
response.cost
Die koste wat vir hierdie navraag gerapporteer is; behandel dit as 'n desimale bedrag.
response.balance
Die gerapporteerde rekeningsaldo, wanneer teenwoordig.

Geen-naam-resultate en foute

'n Suksesvolle versoek waarborg nie 'n bruikbare bellernaam nie. Hanteer 'n leë naam, 'n nommer wat in die plek van 'n naam teruggestuur word en 'n afgewysde opsoek. Toepassingskode 403 kan onvoldoende krediet, 'n verbode aankoop of 'n nommer sonder resultaat beskryf; ondersoek die boodskap.

Gaan beide die HTTP-status en die JSON-status na voordat jy response.name raadpleeg. Die antwoordobjek kan by 'n fout afwesig wees. 'n Ontbrekende naam moet nie verhoed dat die normale oproep gerouteer word nie.

Fakturering, herprobeerslae en die verskil met die opdatering van beller-ID

'n Nuwe opsoek kan 'n navraagkoste meebring. Hierdie opsoekkoppelvlakke dokumenteer nie 'n idempotensiesleutel nie, dus kan 'n nuwe herprobeerslag 'n tweede faktureerbare navraag wees. Gebruik begrensde wagtye tussen herprobeerslae (backoff) vir vervoer-/diensfoute, los rekeningfoute eers op en versoen die gerapporteerde navraagkoste. Gebruik slegs 'n kas vir 'n tydperk wat by jou toepassing pas; bellernaamdata kan verander.

'n CNAM-opsoek lees 'n naam. Dit verander nie die naam wat op jou uitgaande oproepe vertoon word nie. 'n LIDB-bellernaamopdatering is 'n afsonderlike bewerking met eie velde, magtiging, prys en verwerking.