Hlavní navigace

CallerScope
Prověřit číslo

API PRO VÝVOJÁŘE

Integrujte důvěru, kterou lze vysvětlit.

Stabilní caller-intelligence API s oddělenými test/live klíči, čitelným schématem a bezpečnou cestou k prvnímu výsledku.

ŘÍZENÝ PŘEDPRODUKČNÍ PŘÍSTUP

Od klíče k prvnímu výsledku.

Jedno stabilní API pro vysvětlitelné hodnocení volajících. Začněte na vyhrazené testovací fixture, oddělte každou aplikaci a do produkce přejděte až po schválení organizace.

Stáhnout OpenAPI 3.1Prohlédnout smlouvu
cURLGET · TEST FIXTURE
curl --fail-with-body \
  --request GET \
  --url 'https://callerscope.com/api/v1/numbers/%2B12025550100' \
  --header "Authorization: Bearer $CALLERSCOPE_API_KEY" \
  --header 'Accept: application/json'

Proměnnou nastavte pouze ve svém serverovém prostředí.

  1. 01

    Získejte testovací přístup

    Správce organizace vytvoří klíč jen pro jednu aplikaci a prostředí.

  2. 02

    Uložte klíč na serveru

    Klíč patří do správce tajemství — nikdy do prohlížeče, mobilní aplikace ani repozitáře.

  3. 03

    Ověřte vyhrazený příklad

    Testovací prostředí vrací jen syntetická data; níže uvedené číslo je mezinárodně vyhrazená ukázka.

DŮVĚRYHODNÁ HRANICE

Klíč CallerScope. Nikdy klíč databáze.

Vlastní CNAME NoCodeBackend mění adresu veřejné projekce, nikoli její oprávnění. B2B požadavky vždy končí u brány CallerScope, která vynucuje tenant, rozsah, prostředí, kvótu, normalizované schéma a audit.

01

Váš server

Posílá samostatný klíč aplikace.

02

CallerScope API

Ověří tenant, rozsah a kvótu.

03

Sanitizovaný výsledek

Vrátí stabilní smlouvu bez soukromých polí.

cs_test_…

Test

Pouze vyhrazené syntetické fixture. Nikdy nečte živá data tenantů.

cs_live_…

Live

Sanitizovaná produkční data po schválení organizace a aktivaci tarifu.

API v1 · JSON

Malá smlouva. Jasné stavy.

Stav, závažnost, jistota a aktuálnost jsou oddělené dimenze. Neznámý výsledek je platná odpověď, nikoli skryté nebezpečí ani chyba.

JSONILUSTRATIVNÍ ODPOVĚĎ FIXTURE
{
  "data": {
    "e164": "+12025550100",
    "state": "suspicious",
    "severity": "medium",
    "confidence": "high",
    "freshness": "current",
    "reasonCodes": [
      "RESERVED_TEST_FIXTURE",
      "MULTIPLE_SOURCE_FAMILIES"
    ],
    "reportCount": 7,
    "sourceCount": 3,
    "updatedAt": "2026-01-01T00:00:00.000Z"
  },
  "meta": {
    "requestId": "req_[request-id]",
    "schemaVersion": 1
  }
}
data.state
unknown · limited · nuisance · suspicious · high_risk · mixed · verified_business · stale
data.severity
none · low · medium · high; u minimálního stavu unknown se vynechává
data.confidence
insufficient · low · medium · high
data.freshness
current · aging · stale · unknown; u minimálního stavu unknown se vynechává
data.reasonCodes
stabilní strojově čitelné důvody bez soukromých důkazů
data.reportCount / sourceCount
pouze sanitizované souhrnné počty; ve stavu unknown volitelné
meta
requestId · schemaVersion

KONCOVÉ BODY

Jednotlivě nebo dávkou.

Dávka zachovává pořadí a účtuje jednu jednotku za číslo. Chyba jedné položky nezakrývá ostatní výsledky.

25čísel v dávce

MetodaCestaOprávněníMěření
GET/api/v1/numbers/{e164}numbers:read1 jednotka
POST/api/v1/numbers/batchnumbers:read1–25 jednotek
GET/api/v1/usageusage:readnejvýše 93 dní
WorkspaceAPI klíče a webhookysprávce organizacesamostatný audit
cURLPOST · 1 RESERVED ITEM
curl --fail-with-body \
  --request POST \
  --url 'https://callerscope.com/api/v1/numbers/batch' \
  --header "Authorization: Bearer $CALLERSCOPE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"numbers":["+12025550100"]}'

PROVOZ

Klíče, které lze bezpečně měnit.

Každá aplikace a prostředí mají vlastní životní cyklus. Kompromitovaný klíč lze odvolat bez rotace upstream infrastruktury.

429Retry-After bez odhalení interní kapacity
  1. 01

    Vytvořit

    Zvolte aplikaci, test/live prostředí, minimální rozsahy a volitelnou expiraci. Prostý klíč se zobrazí pouze jednou.

  2. 02

    Pozorovat

    Sledujte bezpečné agregace využití podle organizace, prostředí a dne — bez hledaných telefonních čísel.

  3. 03

    Rotovat

    Nasaďte náhradní klíč během omezeného 24hodinového překryvu a poté ověřte provoz na novém klíči.

  4. 04

    Odvolat

    Každý klíč lze samostatně okamžitě zneplatnit. Další klíče nezvyšují kvótu organizace.

Minimální oprávnění

Samostatný klíč pro každou aplikaci a prostředí; povolte jen potřebné rozsahy.

Bezpečné uložení

Tajemství držte ve správci klíčů. Vylučte je z logů, analytiky, chybových hlášení a klientských bundle.

Omezená opakování

Nastavte timeout, respektujte Retry-After a u idempotentních workspace operací opakujte stejný X-Idempotency-Key.

WEBHOOKS

Důležité změny, ne hlučný stream.

Webhooky jsou spravované v organizačním workspace, doručované alespoň jednou a podepsané samostatným tajemstvím. Příjemce musí ověřit podpis nad nezměněným tělem a deduplikovat ID události.

  • number.assessment.changed
  • number.severe_evidence.corroborated
  • business.verification.changed
  • remedy.outcome.changed

STABILITA

Verze, které lze plánovat.

/v1

Stabilní hlavní verze

Kompatibilní rozšíření mohou přibývat. Nekompatibilní změna vyžaduje novou hlavní cestu.

schemaVersion

Čitelné schéma

Každá odpověď uvádí verzi schématu a requestId pro bezpečnou podporu bez logování čísla.

Deprecation

Oznámené ukončení

X-CallerScope-Api-Version a X-CallerScope-Api-Deprecated popisují životní cyklus. Ukončení doplní konkrétní datum Sunset a migrační cestu.

PRODUKČNÍ PŘÍSTUP ZATÍM NENÍ OTEVŘENÝ

Navrhněme bezpečné nasazení.

Produkční přístup k API zatím není otevřený. Napište nám, jak chcete CallerScope využívat, a probereme dostupnost přístupu.

Probrat API přístupPro firmy