Referensi SDK

Setiap Telybot SDK — Android, iOS, React Native, Flutter, Ionic — menerapkan kontrak kecil yang sama. Jika Anda pernah menggunakan salah satunya, Anda sudah memahami semuanya.

API

Buka dengan pertanyaan. Berikan pertanyaan ke show dan pertanyaan itu masuk ke kotak pesan chat; pelanggan membacanya dan mengetuk kirim. Dibawa di #fragment tautan, sehingga tidak pernah sampai ke log server. Hingga 500 karakter, dalam satu baris.

Chat di dalam layar Anda sendiri. Android KeydaBotView, iOS KeydaBot.makeChatViewController atau SwiftUI KeydaBotView, React Native <KeydaBotChat />, Flutter KeydaBotChat, dan embedWidget() dari paket Ionic. Tidak ada tombol tutup — navigasi layar Anda adalah jalan keluarnya. Di Android, Kembali menutup item atau keranjang yang terbuka dulu: React Native dan Flutter melakukannya untuk Anda selama chat adalah layar paling depan, dan dengan KeydaBotView native, penanganan Kembali Anda memanggil goBack() miliknya.

Pelanggan Anda yang sudah masuk. Berikan nama, nomor telepon, atau email pelanggan ke SDK dan chat mengisi apa yang sudah diketahui aplikasi Anda. Detailnya ditawarkan, tidak pernah dikirim: muncul di formulir “bicara dengan orang”, pesanan, janji, dan pertanyaan sambutan yang menanyakan nama, telepon, atau email, lalu pelanggan yang mengirimkannya. Detail itu dibawa di #fragment tautan dan merupakan pernyataan aplikasi Anda, bukan identitas terverifikasi. Nilai yang akan ditolak chat tidak disertakan: nama lebih dari 80 karakter, nomor telepon tanpa 8 sampai 15 digit, alamat email tanpa domain yang benar. Chat layar penuh Ionic terbuka di browser sistem, yang menyimpan alamat di riwayatnya, sehingga tidak menerimanya; widget tersematnya menerima.

Balasan saat chat ditutup. Saat pelanggan meminta bicara dengan orang lalu menutup chat, jawaban Anda dari dasbor menunggu di percakapan. SDK untuk Android, iOS, React Native, dan Flutter memeriksanya saat aplikasi Anda kembali ke latar depan dan memberi tahu aplikasi Anda, sehingga Anda bisa menampilkan titik di tombol chat sampai pelanggan membuka chat. SDK hanya menanyakan chat yang pelanggannya meminta orang dalam 14 hari terakhir. Chat yang tetap dimuat aplikasi Anda di luar pandangan, seperti tab Bantuan di latar belakang, tidak dihitung sudah dibaca: titik tetap ada sampai pelanggan melihatnya. Ini bukan notifikasi push: balasan baru terlihat saat aplikasi dibuka.

Memang sengaja tidak ada yang lain. Tidak ada API pengiriman pesan dan tidak ada panggilan identitas pengguna — karena keduanya belum bekerja dari ujung ke ujung, dan metode yang tidak bekerja lebih buruk daripada yang tidak ada.

URL yang dibuka setiap SDK

{baseUrl}/chat/{clientId}

baseUrl menggunakan standar https://telybot.com dan dapat ditimpa di setiap platform, untuk penahapan (staging) atau instalasi mandiri (self-hosted).

Mengapa menggunakan web view dan apa ruginya bagi Anda

Ada satu antarmuka obrolan, yang disajikan oleh platform, dan setiap permukaan memuatnya.

Yang Anda dapatkan: perubahan yang dibuat pemilik di dasbor — warna aksen, pesan sambutan, nama bot, penayangan langsung — menjangkau setiap aplikasi secara instan, tanpa rilis. Perbaikan diterapkan di mana-mana sekaligus. Obrolan identik di semua platform.

Biayanya: obrolan memerlukan koneksi internet. Belum ada mode offline dan belum ada pemberitahuan push.

Kami lebih baik Anda mengetahuinya sebelum Anda merilisnya daripada menyadarinya sesudahnya.

Jaminan yang diberikan oleh setiap SDK

1. Navigasi keluar. Tautan ke asal mana pun akan terbuka di peramban sistem alih-alih menggantikan obrolan. Tanpa ini, satu ketukan pada tautan footer akan mengakhiri percakapan pelanggan tanpa jalan kembali.
2. Kontinuitas percakapan. Penyimpanan DOM aktif, sehingga pelanggan yang menutup aplikasi dan kembali akan mendapati percakapan mereka di tempat terakhir (selama 24 jam).
3. Papan ketik tidak akan pernah menutupi kolom input.
4. Area aman dihargai — tidak ada obrolan yang digambar di bawah takik atau indikator beranda.
5. Tidak ada kegagalan yang berdampak pada aplikasi Anda. Pemuatan yang gagal akan menampilkan tombol coba lagi.
6. Tanpa analitik, tanpa pengenal perangkat, tanpa dependensi pihak ketiga. Menambahkan SDK Telybot tidak akan menambahkan pelacak ke aplikasi Anda.
7. Kembali menutup dulu apa yang sedang dilihat pelanggan. Di Android, Kembali di atas item, keranjang, atau janji yang terbuka menutup itu dulu, baru kemudian chat (SDK 0.2.0 dan yang lebih baru).

Di dalam chat

Semua ini berasal dari halaman yang dihosting, sehingga sampai ke setiap aplikasi tanpa pembaruan SDK:

• Pesan sambutan dengan tombol saran, dalam bahasa yang disetel untuk bot.
• Percakapan disimpan di perangkat selama 24 jam, dan chat tidak membuat id pengunjung. Di situs web, percakapan bertahan selama satu tab browser. (Chat layar penuh SDK Ionic memerlukan 0.2.0 untuk ini.)
• Pesanan dan janji, jika bisnis menerimanya: keranjang, tanggal dan jam janji, tautan untuk menelepon bisnis saat pesanan atau janji sudah terlalu lama menunggu, dan “Tambahkan ke kalender” untuk janji yang sudah dikonfirmasi.
• Lampiran: foto (JPEG, PNG, WebP, GIF) dan file PDF, DOCX, TXT, CSV, dan MD. SDK Android dan Flutter memerlukan 0.1.4 atau lebih baru untuk tombol lampiran, dan Flutter memerlukan 0.2.0 untuk dokumen.
• “Tambahkan ke kalender” adalah tautan ke file .ics. iOS membukanya di Kalender sebagai kalender yang bisa dilanggani. Android menawarkan aplikasi kalender ponsel jika aplikasi itu mengimpor file .ics — Google Kalender saat ini bisa — dan jika tidak, browser mengunduh filenya.

Format Client id

kb_live_ followed by 8-48 hexadecimal characters

Apa pun yang lain ditolak saat inisialisasi alih-alih membuka 404 di depan pelanggan. Client ID bersifat publik secara desain — terlihat di situs web mana pun yang menyematkan widget — dan tidak memiliki kemampuan untuk membaca atau mengubah akun Anda. Lihat batasan dan keamanan.

Sumber

Publik, berlisensi MIT: github.com/telybotai/telybot-Sdks. Kontrak bersama yang wajib dipatuhi setiap paket ada di CONTRACT.md di bagian atas repositori tersebut.