CNAM-integration

Referens för CNAM REST API

Begär ett uppringarnamn över HTTPS och hantera resultat, avgift och fel.

Välj sökningens beteende

Nivå	Offentligt pris per fråga	Vad den gör
Starter	0,0026 US$	Använder egen och cachad information om uppringarnamn.
Standard	0,0037 US$	Gör en nätverkssökning i realtid för varje fråga.
Mixed	0,004 US$	Försöker först med en sökning i realtid och faller sedan tillbaka på data från Starter när inget namn hittas.

Den valda tjänsten avgör sökningens beteende; Mixed är inte en sökning som använder cache först. Granska den prisnivå som är tilldelad ditt konto innan produktionsanvändning. Ett uppringarnamn är inget bevis på identitet eller ägande.

Skicka en autentiserad sökning

Slutpunkt: GET https://api.multitel.net/v3/cnam/NUMBER. Ange telefonnummer i internationellt format med endast siffror och inklusive landskod, utan skiljetecken eller inledande plustecken. Kör detta från din applikationsserver med godkända API-uppgifter.

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

Ange de två miljövariablerna via hemlighetskonfiguration på serversidan. En tilldelad bearer-uppgift är ett alternativ endast när den åtkomsten är aktiverad och dess käll-IP-begränsningar är uppfyllda. Lägg aldrig en API-hemlighet i en publik webbläsarbundle.

Guide för API-autentisering och första förfrågan

Läs JSON-svaret

Det här svaret är illustrativt. Det returnerade namnet och avgiften beror på sökningen och den valda tjänsten.

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

status.code: Applikationens resultatkod; normalisera sträng- och numeriska värden innan du jämför med 200.
status.msg: Det tillhörande meddelandet om utfall eller avvisning.
response.number: Det sökta numret.
response.name: Det tillgängliga uppringarnamnet.
response.cost: Avgiften som rapporterats för den här frågan; behandla den som ett decimalbelopp.
response.balance: Det rapporterade kontosaldot, när det finns.

Resultat utan namn och fel

En lyckad förfrågan garanterar inte ett användbart uppringarnamn. Hantera ett tomt namn, ett nummer som returneras i stället för ett namn och en avvisad sökning. Applikationskod 403 kan beskriva otillräckligt saldo, ett otillåtet köp eller ett nummer utan resultat; granska meddelandet.

Kontrollera både HTTP-status och JSON-fältet status innan du läser response.name. Svarsobjektet kan saknas vid fel. Ett saknat namn bör inte hindra att det normala samtalet dirigeras.

Fakturering, nya försök och skillnaden mot att uppdatera nummerpresentation

En ny sökning kan medföra en frågeavgift. Dessa sökningsgränssnitt dokumenterar ingen idempotensnyckel, så ett nytt försök kan bli en andra debiterbar fråga. Använd begränsad backoff vid transport- eller tjänstefel, åtgärda kontofel först och stäm av de rapporterade frågeavgifterna. Cacha endast under en period som passar din applikation; uppringarnamn kan ändras.

En CNAM-sökning läser ett namn. Den ändrar inte det namn som visas på dina utgående samtal. En LIDB-uppdatering av uppringarnamn är en separat operation med egna fält, egen auktorisering, eget pris och egen behandling.

Guide för CNAM-integration i kontot Få hjälp med integrationen