Tallker API v1

კონტაქტების API

კონტაქტების API. დააკავშირეთ სერვერული სისტემები, გადასცით კონტაქტები და შეკვეთები და უსაფრთხოდ ამოიცანით widget-ის მომხმარებელი.

POST/api/v1/public/contacts/upsertscope: contacts:write

How it works

1Создайте ключ со scope contacts:write.
2Передайте стабильный external_id и хотя бы имя, email или телефон.
3Сохраните возвращённый id Tallker либо продолжайте обращаться по external_id.

მაგალითები

fetch("https://tallker.com/api/v1/public/contacts/upsert", {
  method: "POST", headers: { Authorization: "Bearer " + process.env.TALLKER_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({ external_id: "customer_18452", name: "Ivan", email: "ivan@example.com" })
});

Parameters and requirements

external_idобязательноУникальный ID контакта в вашей системе

nameусловноИмя; требуется одно из name, email или phone

emailнеобязательноКорректный email

phoneнеобязательно7–15 цифр, нормализуется в международный формат

company / metadataнеобязательноКомпания и произвольный JSON

Result

{"id":"…","external_id":"customer_18452","created":false}

ლიმიტები და იდემპოტენტურობა

120 requests / minute · HTTP 429 · Retry-After · Idempotency-Key 24h

უსაფრთხოება

Чтение: GET /api/v1/public/contacts/{external_id}, scope contacts:read.

При совпадении external_id обновляется тот же контакт; неизвестные JSON-поля отклоняются.

OpenAPI 3.1