Kunci API

Dikemas kini

Lokasi: Tetapan > Integrasi > Kunci API

Kegunaannya:

"Berikan program luaran kunci tersendiri untuk menghantar melalui SyBox — token WhatsApp tidak pernah meninggalkan pelayan, dan kunci yang bocor boleh dibatalkan dengan mudah." Sistem ERP, sistem jualan (POS) atau program desktop anda menggunakan kunci SyBox. Ia tidak memerlukan maklumat kelayakan WhatsApp sebenar anda.

Perkara yang boleh dilakukan oleh program dengan kunci ini (diterangkan pada halaman Dokumentasi Pembangun awam):

  • Menghantar mesej WhatsApp daripada nombor anda yang disambungkan. Ia menggunakan format permintaan yang sama seperti WhatsApp Cloud API milik Meta, jadi program yang sedia ada hanya perlukan alamat baharu dan kunci SyBox. Teks, templat, imej, dokumen dan mesej interaktif semuanya disokong. Maklum balas dan ralat dipulangkan sama persis seperti yang diberikan oleh Meta.
  • Memfailkan kes daripada sistem anda sendiri, contohnya aduan yang direkodkan dalam ERP anda. Pelanggan mestilah sudah wujud dalam SyBox.
  • Mengimport SMS daripada telefon ke dalam peti masuk.
  • Memulakan automasi anda daripada sistem lain (kunci jenis "Mulakan automasi").
  • Mencari, membaca dan mengubah kenalan anda daripada sistem lain (kunci jenis "Baca dan kemas kini kenalan").

Siapa yang boleh membukanya: pentadbir utama, dan ahli pasukan dengan kebenaran "Urus saluran".

Suis "Gerbang API":

Di bahagian atas skrin kunci API terdapat suis bernama "Gerbang API". Ia dimatikan secara lalai. Semasa ia dimatikan, tiada kunci yang berfungsi dan anda tidak boleh mencipta kunci baharu. Jika anda mencuba, anda akan melihat "Gerbang API dimatikan. Hidupkannya dengan suis di bahagian atas skrin ini sebelum membuat kunci." Suis disimpan sebaik sahaja anda mengkliknya.

Cara menghidupkan gerbang dan mencipta kunci

  1. Pergi ke Tetapan > Integrasi > Kunci API.
  2. Hidupkan suis "Gerbang API".
  3. Klik "Baharu key".
    Settings, API keys: keys that let another program send through SyBox, and the "New key" button
  4. Pilih "Jenis kunci API":
    • "Hantar through WhatsApp": program menghantar mesej kepada pelanggan anda.
    • "Buka kes": program membuka kes dalam SyBox. Ia tidak boleh menghantar mesej.
    • "Import SMS daripada telefon": telefon memajukan mesej SMS ke dalam peti masuk.
    • "Mulakan automasi": program memulakan automasi yang tetapan "Bermula apabila" adalah "Program lain memanggil SyBox" (POST /v1/automation dengan "phone" pelanggan, serta "event" dan "data" pilihan). Ia tidak boleh menghantar mesej. Lihat Tetapan > AI dan automasi > Automasi.
    • "Baca dan kemas kini kenalan": program mencari kenalan, membaca satu kenalan, dan mengubah nama, emel, medan kenalan serta labelnya (POST /v1/contacts/search, /get, /update dan /labels). Ia tidak boleh menghantar mesej. Kunci ini bertindak sebagai individu yang menciptanya: ia hanya melihat kenalan yang boleh dilihat oleh individu tersebut, ia hanya berfungsi jika individu tersebut boleh membuka senarai kenalan dan melihat nombor, dan ia hanya boleh mengubah kenalan jika individu tersebut boleh mengeditnya. Jika individu tersebut dimatikan, kunci akan berhenti berfungsi.
  5. Isikan "Nama peranti atau program", contohnya "Komputer Pejabat" atau "Sistem Perakaunan". Berikan kunci tersendiri bagi setiap peranti atau program.
  6. Bagi kunci jenis "Hantar through WhatsApp", tetapkan juga:
    • "Dihantar daripada": nombor WhatsApp yang digunakan oleh kunci ini untuk menghantar (wajib).
    • "Benarkan mesej teks bebas": hidup atau mati.
    • "Benarkan templat yang diluluskan": hidup atau mati. Sekurang-kurangnya satu daripada dua pilihan ini mesti dihidupkan, jika tidak anda akan melihat "Benarkan sekurang-kurangnya teks bebas atau templat — jika tidak, kunci tidak boleh menghantar apa-apa."
    • "Benarkan penghantaran fail media": hidup atau mati.
    • "Templat" (pilihan): nama templat, dipisahkan dengan koma. Biarkan kosong untuk membenarkan sebarang templat.
    • "Negara penerima yang dibenarkan" (pilihan): kod negara dua huruf, contohnya MY,SG,ID. Biarkan kosong untuk membenarkan mana-mana negara.
    • "Penghantaran dibenarkan dari" ... "Kepada": waktu kunci dibenarkan menghantar. Biarkan kedua-duanya sama jika tiada had masa. Waktu adalah mengikut waktu tempatan ruang kerja.
    • "Had mesej harian (0 = tanpa had)".
  7. Bagi kunci "Import SMS daripada telefon", tetapkan "Hanya kenalan dan pelanggan". Apabila dihidupkan, SMS daripada nombor lain akan kekal pada telefon dan tidak sampai ke peti masuk. Matikan hanya jika telefon itu digunakan semata-mata untuk urusan kerja.
  8. Klik Simpan.
  9. Tetingkap akan memaparkan "URL Asas" dan "Kunci API". Salin kedua-duanya sekarang. "Salin kunci ini sekarang — ia hanya dipaparkan sekali." Masukkan maklumat tersebut ke dalam tetapan program anda.

Maklumat yang dipaparkan pada kad kunci:

  • Nama kunci, dan nombor yang digunakan untuk menghantar (atau lencana jenisnya, bagi kunci yang tidak menghantar mesej).
  • Aksara terakhir kunci, supaya anda boleh membezakan antara kunci.
  • "Terakhir digunakan", dengan tarikh dan masa, atau "tidak pernah".
  • Sebarang had yang aktif: "Teks bebas sahaja", "Templat sahaja", "tiada media", "Templat", negara yang dibenarkan, waktu penghantaran, dan had harian yang ditunjukkan sebagai dihantar hari ini / had / hari. Kunci SMS yang menerima semua nombor memaparkan "Semua nombor".

Cara menukar, menjeda atau memadam kunci

  1. Klik Edit pada kad kunci. Anda boleh menukar nama, nombor dan hadnya. Jenis kunci tidak boleh diubah selepas dicipta, dan kunci sebenar tidak akan ditunjukkan lagi.
    To change, pause or delete a key: "Edit" marked on the screen in SyBox
  2. Klik Dayakan / Nyahdayakan untuk menghentikan kunci buat sementara waktu.
  3. Klik Padam, kemudian sahkan: "Padam kunci API ini? Sebarang program yang masih menggunakannya akan berhenti berfungsi serta-merta."
Saya kehilangan kunci API saya. Bolehkah saya melihatnya semula?

Tidak boleh. Ia hanya dipaparkan sekali sahaja. Cipta kunci baharu, masukkan ke dalam program anda, kemudian padam kunci lama.

Saya rasa kunci saya telah bocor. Apa yang perlu saya buat?

Padam kunci tersebut, atau nyahdayakannya dengan segera. Hanya kunci itu yang akan berhenti berfungsi. Nombor WhatsApp dan kunci anda yang lain tidak terjejas.

Senarai "Dihantar daripada" kosong.

Senarai ini hanya menunjukkan nombor WhatsApp yang telah disambungkan dan diaktifkan. Sambungkan nombor terlebih dahulu di bawah Tetapan > Pemesejan > Saluran.

Program saya ditolak semasa menghantar mesej.

Pastikan suis "Gerbang API" dihidupkan dan kunci berstatus aktif. Semak juga had pada kunci: teks bebas berbanding templat, media, templat yang dibenarkan, negara yang dibenarkan, waktu penghantaran dan had harian. Peraturan WhatsApp sendiri juga masih terpakai. Contohnya, teks bebas hanya boleh dihantar dalam tempoh 24 jam dari mesej terakhir pelanggan.

Bolehkah kunci "Buka kes" juga menghantar mesej?

Tidak boleh, ia direka begitu demi keselamatan. Kunci yang memfailkan kes tidak boleh menghantar mesej kepada pelanggan, dan kunci penghantaran tidak boleh memfailkan kes. Gunakan kunci berasingan untuk setiap tugas.

Saya mempunyai kunci lama dengan jenis "Terima daripada program luaran". Adakah ia masih berfungsi?

Ya, kunci sedia ada daripada jenis tersebut masih berfungsi. Kunci baharu bagi jenis itu tidak boleh dicipta lagi. Gunakan jenis "Buka kes" untuk tujuan tersebut.