API developer

Kirim DM dengan satu POST.

REST API untuk CRM Anda di paket Business: kontak, percakapan, kesepakatan, tugas, kampanye, dan pesan di Telegram, X, serta kotak masuk sosial. Autentikasi Bearer, kunci dengan cakupan akses, idempotensi, header batas permintaan, dan webhook keluar. Tidak perlu SDK.

  • JSON lewat HTTPS
  • Respons berlatensi rendah
  • Dirancang agar andal

Terakhir diperbarui:

Pilih stack Anda

Endpoint yang sama. Empat bahasa.

Satu kontrak JSON. Salin, tempel, langsung rilis. Spesifikasi OpenAPI lengkap mencakup setiap endpoint, setiap error, dan setiap payload webhook.

curl -X POST https://api.pinlyx.com/v1/telegram/messages \  -H "Authorization: Bearer csk_live_***" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{"accountId":7421,"username":"sarah_miller","text":"Selamat bergabung"}'

Referensi lengkap dan katalog error ada di docs.pinlyx.com/api

Autentikasi

Kunci dengan cakupan akses. Hak akses minimum sebagai bawaan.

Buat kunci API dengan cakupan yang tepat: hanya-baca untuk dasbor analitik, cakupan tulis untuk pengirim di produksi, cakupan kelola untuk otomatisasi operasional. Ganti kunci tanpa downtime; kunci lama dan baru berlaku bersamaan selama masa peralihan sehingga tidak ada yang rusak.

  • Autentikasi Bearer

    Kirim Authorization: Bearer csk_live_… di setiap permintaan. Kunci produksi dan kunci uji dibedakan secara visual sehingga alur produksi tetap aman.

  • Izin berbasis cakupan

    Pilih cakupan sesedikit mungkin yang dibutuhkan sebuah kunci. Kunci dasbor yang bocor tidak akan pernah bisa mengirim pesan.

  • Rotasi tanpa downtime

    Terbitkan kunci pengganti, deploy, lalu cabut kunci lama. Keduanya berlaku selama masa tumpang tindih, jadi tidak ada lonjakan error 401 sekaligus.

Pengirim produksiAktif
csk_live_a4f9_
Cakupan akses
  • contacts:readMelihat, mencari, dan membaca kontak beserta percakapannya.
  • telegram:readMemeriksa status pesan Telegram yang sedang antre.
  • analytics:readMenarik statistik funnel, kampanye, dan akun.
  • telegram:sendMengantrekan pesan Telegram dari akun Anda sendiri.
  • contacts:writeMembuat, memperbarui, dan memberi tag pada kontak.
  • sequences:writeMendaftarkan kontak ke kampanye, menjeda, dan melanjutkannya.
  • webhooks:writeMendaftarkan dan merotasi endpoint webhook.
Keandalan

Kontrol beban yang memberi tahu Anda segalanya.

Dengan kunci idempotensi, percobaan ulang selalu aman: pesan yang sama tidak akan pernah terkirim dua kali. Header batas permintaan memberi tahu klien Anda kapan harus melambat, sebelum error 429 sempat muncul.

Respons · 200 OK187 ms
X-RateLimit-Limit
60
# permintaan per menit, per kunci
X-RateLimit-Remaining
48
# sisa kuota di jendela waktu saat ini
X-RateLimit-Reset
1778077380
# waktu Unix saat jendela waktu direset
Retry-After
12
# saat 429, tunggu sekian detik
  • Kunci idempotensi

    Kirim Idempotency-Key di setiap operasi tulis. Percobaan ulang dengan kunci yang sama dalam 24 jam akan mengembalikan respons awal, bukan mengirim ulang.

  • Batas permintaan per kunci

    Setiap kunci API mengizinkan 60 permintaan per menit secara bawaan, dan bisa diatur per kunci. Pengiriman Telegram lalu mengikuti ritme akun itu sendiri: secara bawaan 20 pesan per jam dengan jeda 10 detik, plus penundaan otomatis saat terkena flood-wait.

  • Katalog error yang stabil

    Setiap error mengembalikan Error yang stabil untuk dijadikan dasar logika, plus Message yang mudah dibaca untuk ditampilkan ke pengguna, dalam bentuk JSON yang sama di semua endpoint.

Webhook

Webhook keluar untuk setiap event.

Terima 31 event CRM secara real time. Tanda tangan HMAC-SHA256, percobaan ulang otomatis dengan exponential backoff, dan log pengiriman tempat Anda bisa mengulang pengiriman mana pun.

Event lainnya
  • message.sent
  • contact.created
  • pipeline.stage_changed
  • sequence.completed
  • outreach.replied
  • task.completed
  • support.ticket.created
  • subscription.changed
POSTyour-handlerterkirim
{  "event": "message.received",  "id": "8c1f4b9e2d7a4c03b5e6f1a2",  "deliveredAt": "2026-05-06T14:32:18Z",    "channel": "telegram",    "contactId": 8821,    "counterparty": "@sarah_miller",    "text": "Halo, bisa kirimkan demonya?"}
Verifikasi saat diterimaNode.js
const sig = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');if ('sha256=' + sig !== headers['x-webhook-signature']) return 401;

Siap kapan pun Anda siap

Bangun dengan Pinlyx. Rilis dalam hitungan menit.

Di paket Business, buat kunci di panel, tempel perintah curl, lalu lihat pesan Anda masuk ke antrean. Referensi OpenAPI mendokumentasikan setiap endpoint dan error.

  • Tersedia di paket Business
  • Kunci dibuat di panel
  • Webhook bertanda tangan HMAC