Lewati ke konten utama

Session Link

Session Link icon
API developer

Dapatkan tautan langsung ke percakapan pelanggan dari sistem Anda sendiri; pelanggan dan percakapan dibuat jika belum ada.

  • WhatsApp
  • Instagram
  • REST API

Ringkasan​

Satu panggilan API dengan kanal dan nomor telepon atau email pelanggan mengembalikan tautan yang membuka percakapan pelanggan itu di MonoChat. Jika pelanggan atau percakapan belum ada, keduanya dibuat.

Taruh tautan di CRM, help desk, atau layar pesanan Anda, dan tim Anda langsung berpindah dari sana ke chat.

Sorotan​

  • Buka atau buat. Berlaku untuk pelanggan di kanal WhatsApp, Instagram, atau kanal lain tertentu, menurut nomor telepon atau email.
  • Arahkan sekalian. Tugaskan percakapan ke agen, menurut id atau email, atau ke grup kerja dalam panggilan yang sama.
  • Pelanggan sama, percakapan sama. Memanggilnya lagi untuk pelanggan dan kanal yang sama mengembalikan percakapan yang sudah ada.

Pasang dan siapkan​

  1. Pasang Session Link dari Pengaturan › MonoStore › Aplikasi, atau buka tautan instalasi app.monochat.ai/apps/vvKJe8Nbp4EQNy2KA. Jika Anda belum punya akun MonoChat, tautan ini memungkinkan Anda mendaftar terlebih dahulu dan memasang aplikasinya untuk Anda.
  2. Buat token API di Profil › Token API. Token hanya ditampilkan sekali, jadi salin segera. Lihat Token API.
  3. Buka Pengaturan › Session Link API. Dokumentasi di sana menampilkan alamat endpoint workspace Anda yang tepat dan contoh permintaan yang siap disalin. Coba contohnya dengan salah satu kanal Anda.
  4. Tambahkan tombol "Chat di WhatsApp" ke CRM, help desk, atau layar pesanan Anda yang memanggil API dan membuka url yang dikembalikan.
catatan
  • Tautan ini membuka MonoChat bagi orang yang sudah masuk dan berhak melihat percakapan itu.
  • Panggilan ini hanya membuka percakapan; tidak mengirim pesan ke pelanggan. Gunakan WhatsApp Template API untuk menulis lebih dulu.

Fitur​

Jawabannya berisi tautan yang membuka percakapan di MonoChat dan id percakapan.

Pelanggan dibuat bila perlu​

Pelanggan baru dibuat dengan nama depan dan nama belakang yang Anda kirim; jawabannya memberi tahu apakah pelanggan sudah dikenal.

Penugasan​

Tugaskan ke agen menurut id atau email, atau ke grup kerja.

Layar dokumentasi​

Referensi API dengan alamat endpoint workspace Anda yang tepat dan contoh permintaan yang siap disalin.

Referensi API​

Panggilannya adalah POST dengan isi JSON, diautentikasi dengan token API.

POST https://app.monochat.ai/api/<slug>/custom-functions/<app-folder>/methods/session-link.js
Authorization: Bearer <API_TOKEN>
Content-Type: application/json
  • <slug> adalah tenant slug workspace Anda, bagian setelah /tenants/ di alamat MonoChat Anda.
  • <app-folder> adalah folder tempat aplikasi dipasang. Layar Pengaturan › Session Link API menampilkan alamat lengkap dengan keduanya sudah terisi.
  • Buat token di Profil › Token API. Lihat Token API.

Kolom permintaan​

KolomWajibDeskripsi
connectorBrandyaJenis kanal, misalnya whatsapp atau instagram.
channelUsernameyaUsername kanal Anda di MonoChat, misalnya nomor WhatsApp Anda tanpa +.
customer.identityTypeyaphoneNumber atau email.
customer.identityyaNomor telepon pelanggan (kode negara, tanpa +) atau alamat email.
customer.firstname, customer.lastnametidakDipakai saat pelanggan baru di MonoChat. Default -.
assignment.typetidakagent (id pengguna agen), agentIdentity (email agen) atau workgroup (id grup kerja).
assignment.valuedengan assignment.typeId atau email tujuan penugasan percakapan.

Contoh permintaan​

curl --location 'https://app.monochat.ai/api/<slug>/custom-functions/<app-folder>/methods/session-link.js' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
"connectorBrand": "whatsapp",
"channelUsername": "905334445566",
"customer": {
"identityType": "phoneNumber",
"identity": "905306667788",
"firstname": "Ayşe",
"lastname": "Yılmaz"
},
"assignment": { "type": "agentIdentity", "value": "sarah@yourcompany.com" }
}'

Respons​

{
"result": {
"url": "https://app.monochat.ai/tenants/<slug>?tab=messages&sessionTab=all&filter=…&_id=<sessionId>",
"sessionId": "Zeii7vpeeFFnsJepZ",
"isOldUser": true
}
}
KolomDeskripsi
urlMembuka percakapan di MonoChat.
sessionIdId percakapan. Pelanggan yang sama di kanal yang sama selalu mendapat percakapan yang sama.
isOldUserfalse jika pelanggan dibuat oleh panggilan ini.

Error​

Panggilan yang gagal menjawab dengan status error dan sebuah pesan:

PesanPenyebab
connectorBrand, channelUsername and customer fields are requiredKolom tingkat atas yang wajib tidak ada.
customer.identityType must be one of: phoneNumber, emailidentityType tidak ada atau bernilai lain.
customer.identity field is requiredNomor telepon atau email pelanggan tidak ada.
Channel not foundTidak ada kanal jenis itu dengan username tersebut di workspace Anda.
Customer Channel not foundPelanggan tidak dapat dicocokkan dengan identitas kanal.
Agent user not foundTidak ada agen dengan email yang diberikan di assignment.value.
401Header Authorization tidak ada atau token tidak valid.

Tangkapan layar​

FAQ​

Tidak. Ia hanya membuka atau membuat percakapan dan mengembalikan tautan ke percakapan itu. Untuk menulis lebih dulu ke pelanggan, gunakan aplikasi WhatsApp Template API.

Dengan kanal apa saja ini bekerja?​

WhatsApp, Instagram, dan kanal lain yang terhubung ke workspace MonoChat Anda. Anda menyebutkan jenis kanal dan username kanal Anda dalam permintaan.

Apakah akan membuat percakapan ganda?​

Tidak. Pelanggan yang sama di kanal yang sama selalu mendapat percakapan yang sama.

Orang yang sudah masuk ke MonoChat dan berhak melihat percakapan itu.