Integrace CNAM

Reference CNAM REST API

Vyžádejte si jméno volajícího přes HTTPS a zpracujte výsledek, poplatek a chyby.

Zvolte chování vyhledávání

Úroveň	Veřejná cena za dotaz	Co dělá
Starter	0,0026 US$	Používá vlastní informace o jménech volajících a informace z mezipaměti.
Standard	0,0037 US$	Při každém dotazu provádí vyhledávání v síti v reálném čase.
Mixed	0,004 US$	Nejprve zkusí vyhledávání v reálném čase a pokud nenajde žádné jméno, vrátí se k datům úrovně Starter.

Chování vyhledávání určuje zvolená služba; Mixed není vyhledávání, které nejprve používá mezipaměť. Před produkčním použitím zkontrolujte sazbu přiřazenou k vašemu účtu. Jméno volajícího není důkazem totožnosti ani vlastnictví.

Odešlete požadavek na vyhledání s ověřením přístupu

Koncový bod: GET https://api.multitel.net/v3/cnam/NUMBER. Použijte telefonní čísla v mezinárodním formátu, pouze číslice včetně kódu země, bez interpunkce a bez úvodního znaménka plus. Spouštějte požadavek z aplikačního serveru pomocí schválených přihlašovacích údajů API.

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

Obě proměnné prostředí poskytněte prostřednictvím konfigurace tajných údajů na straně serveru. Poskytnutý přístupový token typu bearer je alternativou pouze tehdy, když je tento přístup povolen a jsou splněna jeho omezení zdrojových IP adres. Nikdy nevkládejte tajný klíč API do veřejně dostupného balíčku pro prohlížeč.

Průvodce ověřováním API a prvním požadavkem

Přečtěte odpověď ve formátu JSON

Tato odpověď je ilustrativní. Vrácené jméno a poplatek závisejí na vyhledávání a zvolené službě.

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

status.code: Aplikační kód výsledku; před porovnáním s 200 sjednoťte textové a číselné hodnoty.
status.msg: Doprovodná zpráva o výsledku nebo odmítnutí.
response.number: Dotazované číslo.
response.name: Dostupné jméno volajícího.
response.cost: Poplatek hlášený za tento dotaz; berte jej jako desetinnou částku.
response.balance: Hlášený zůstatek účtu, pokud je k dispozici.

Výsledky bez jména a chyby

Úspěšný požadavek nezaručuje užitečné jméno volajícího. Ošetřete prázdné jméno, číslo vrácené místo jména a odmítnuté vyhledávání. Aplikační kód 403 může popisovat nedostatečný kredit, zakázaný nákup nebo číslo bez výsledku; zkontrolujte zprávu.

Před přístupem k response.name zkontrolujte jak stav HTTP, tak status v JSON. Objekt odpovědi může být při chybě nepřítomen. Chybějící jméno by nemělo bránit směrování běžného hovoru.

Fakturace, opakování a rozdíl oproti aktualizaci identifikace volajícího

Nové vyhledávání může způsobit poplatek za dotaz. Tato rozhraní pro vyhledávání nedokumentují klíč idempotence, takže nový pokus může být druhým zpoplatněným dotazem. Při selhání přenosu nebo služby používejte omezený počet opakovaných pokusů s prodlužováním čekací doby, nejprve vyřešte chyby účtu a zkontrolujte vykázané poplatky za dotazy. Data ukládejte do mezipaměti jen na dobu vhodnou pro vaši aplikaci; údaje o jménech volajících se mohou měnit.

Vyhledávání CNAM jméno pouze čte. Nemění jméno zobrazované u vašich odchozích hovorů. Aktualizace jména volajícího v LIDB je samostatná operace s vlastními poli, autorizací, cenou a zpracováním.

Průvodce integrací CNAM pro účet Získat pomoc s integrací