Panduan Memulai Cepat Saluran Kustom

Integrasi ini memungkinkan tim Anda untuk mengobrol dengan pelanggan melalui Saluran pesan apa pun melalui implementasi khusus.

Menghubungkan Saluran Kustom

Langkah 1: Buka Pengaturan > Saluran

Langkah 2: Klik Tambahkan Saluran > Saluran Kustom > Hubungkan

Langkah 3: Masukkan URL Webhook tujuan tempat pesan keluar akan dikirim.

Langkah 4: Pilih jenis ID untuk Saluran > klik Berikutnya

Jenis ID digunakan untuk identifikasi pengguna dan digunakan untuk berkomunikasi dengan server integrasi khusus Anda.

Ada dua jenis ID yang tersedia:

1. Nomor Telepon: Gunakan ini jika penyedia layanan pesan mengenali Kontak berdasarkan Nomor Telepon mereka.

   1. Format contoh: +60177872890

2. ID Kustom: Gunakan ini jika penyedia layanan pesan mengenali Kontak berdasarkan ID yang dibuat khusus.

   1. Panjang karakter maksimum adalah 50.

   2. AZ,az,0-9,_,=,+,/dan@diperbolehkan.

Langkah 5: Dialog berikut akan memberikanID Saluran,Token API, danURL Webhookmisalnya

1. ID Saluran:gfd8g7fd89dgfd

2. Token API:aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd

3. Tautan webhook:https://app.respond.io/custom/channel/webhook/

   Menggunakan jenis ID Nomor Telepon memungkinkan Anda memulai percakapan dan mengirim pesan pertama ke Kontak.

Kirim Pesan ke respond.io

URL Webhookdigunakan untuk mengeposkanPesan,Gema Pesan, danTanda Terima Pesanke platform respond.io.

Kode yang disediakan akan memicu webhook pada respond.io, membuat Kontak jika perlu dan menyimpan pesan di bawah Kontak tersebut.

Contoh Pesan

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'authorization: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'cache-control: no-cache' \\  
  -H 'content-type: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "type": "message",  
      "mId": "xcvzzxcxczxczxc",  
      "timestamp": 2132131321000,  
      "message": {  
        "type": "text",  
        "text": "Halo Dunia"  
      }  
    }  
  \],  
  "contact": {  
    "firstName": "John",  
    "lastName": "Doe",  
    "profilePic": "",  
    "countryCode": "MY",  
    "email": "john@respond.io",  
    "phone": "+60177872890",  
    "language": "en"  
  }  
}'

Contoh untuk Pesan Gema

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'authorization: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'cache-control: no-cache' \\  
  -H 'content-type: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "type": "message_echo",  
      "mId": "xcvzzxcxczxczxc",  
      "timestamp": 2132131321000,  
      "message": {  
        "type": "text",  
        "text": "Halo Dunia"  
      }  
    }  
  \],  
  "contact": {  
    "firstName": "John",  
    "lastName": "Doe",  
    "profilePic": "",  
    "countryCode": "MY",  
    "email": "john@respond.io",  
    "phone": "+60177872890",  
    "language": "en"  
  }  
}'

Contoh Tanda Terima Pesan

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'otorisasi: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'cache-control: no-cache' \\  
  -H 'content-type: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "type": "message_status",  
      "mId": "xcvzzxcxczxczxc",  
      "timestamp": 2132131321000,  
      "status": {  
        "value": "terkirim|terkirim|terbaca|gagal",  
        "message": "Kesalahan: Pengiriman gagal karena token tidak valid"  
      }  
    }  
  \]  
}'

Respons - Sukses (Status HTTP → 200)

"Oke"

Menangani Pesan Keluar dari respond.io

respond.io akan memanggil titik akhir<API Base URL>/message

Pastikan Anda menerapkan kode Pesan Keluar pada rute /message di server web Anda.

Berikut adalah contoh cURL dari respond.io yang memanggil titik akhir:

curl -X POST \\  
  /pesan \\  
  -H 'otorisasi: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'cache-control: no-cache' \\  
  -H 'content-type: application/json' \\  
  -d '{  
	"channelId": "gfd8g7fd89dgfd",  
	"contactId": "+60177872890",  
	"message": {  
		"type": "text",  
		"text": "Halo Dunia"  
	}  
}'

Respons - Sukses (Status HTTP → 200)

{  
	"menit": "1640141607842"  
}

Autentikasi perlu dilakukan di titik akhir sebelum mengirim pesan ke Penyedia Layanan Pesan.

Berikut adalah contoh penggunaan middleware Express untuk tujuan ini:

const {validationResult} = require('express-validator');

const validateToken = (req, res, next) => {
    const apiToken = <>;
    const bearerToken = req.headers.otorisasi;

    if (!bearerToken)
        return res.send(401);

    const token = bearerToken.substring(7, bearerToken.length);

    if (apiToken !== token) {
        return res.send(401);
    }
    next();
};

module.exports = {
    validateToken
};

Kami'telah menyertakan contoh Saluran Kustom yang dapat Anda uji di server Anda. Lihat proyek GitHub kami di sini.

Tipe Pesan

Contoh untuk Teks

{  
  "ketik": "teks",  
  "teks": "Selamat datang di respond.io",  
}

Contoh untuk File Media

{  
  "type": "lampiran",  
  "lampiran": {  
    "type": "gambar|video|audio|file",  
    "url": "https://abc/japan.png",  
    "mimeType": "image/png",  
    "fileName":"logo perusahaan.png",  
    "description": "logo perusahaan terkini"  
  }  
}

Pastikan bahwa URL lampiran tidak dipaksa diunduh oleh browser Header respons HTTP's Content-Disposition seharusnya memiliki nilai default, yaitu inline.

Contoh untuk Lokasi

{  
  "type": "location",  
  "latitude": 0.123456,  
  "longitude": -0.1234,  
  "address": "Sky Suites, Jalan P. Ramlee, Kuala Lumpur, 50250 Kuala Lumpur, Wilayah Persekutuan Kuala Lumpur"  
}

Contoh untuk Balasan Cepat

{  
  "type": "quick_reply",  
  "title": "Pilih bahasa yang Anda inginkan",    
  "replies": [  
    "Bahasa Melayu",  
    "Bahasa Inggris"  
  ]  
}

Kode Kesalahan

Kesalahan (Status HTTP → 4xx)

Konfigurasi Saluran

Langkah 1: Klik Pengaturan > Saluran

Langkah 2: Temukan Saluran Kustom > klik Kelola

Langkah 3: Di halaman Konfigurasi Saluran Kustom Anda akan melihat konfigurasi berikut:

• Ikon Saluran - Unggah gambar yang berfungsi sebagai ikon untuk Saluran Kustom Anda.

• Nama Saluran - Nama Saluran dapat diubah dan digunakan secara internal untuk mengidentifikasi Saluran.

• URL webhook untuk pesan keluar — URL webhook untuk pesan keluar ke Saluran ini.

• URL webhook untuk pesan masuk — URL webhook untuk pesan masuk ke Saluran ini.

• Jenis ID — Ini digunakan untuk identifikasi pengguna dan digunakan untuk berkomunikasi dengan server integrasi khusus Anda.

• ID Saluran — ID Saluran Unik untuk mengidentifikasi Saluran Kustom Anda.

• Token API — Pengidentifikasi unik yang digunakan untuk mengautentikasi pengguna untuk mengakses API.

Langkah 4: Klik Simpan Perubahan untuk memperbarui konfigurasi Saluran Kustom.

FAQ dan Pemecahan Masalah

Bisakah saya menghubungkan obrolan dari platform lain menggunakan Saluran Kustom?

Ya kamu bisa. Berikut tiga langkah yang harus diikuti:

1. Di respond.io, masukkan URL webhook tujuan dari platform lain ke dalam kolom URL webhook untuk pesan masuk .

2. Pada platform lain, siapkan URL webhook yang menunjuk ke respond.io, yang memungkinkan Kontak mengirimkan pesan kembali kepada Anda.

3. Anda'akan memerlukan Server Integrasi Kustom untuk menginterpretasikan API dari respond.io dan platform lainnya, yang memungkinkan pertukaran pesan di antara keduanya.

Pastikan untuk mengonfirmasi dengan platform lain bahwa dua langkah pertama dapat dilakukan.

FAQ untuk Webhook Saluran Kustom

Mengapa webhook mengembalikan status 200 meskipun pesan gagal terkirim ke respond.io?

Saat menghubungkan Saluran Kustom, pesan yang dikirim ke respond.io melalui webhook akan selalu segera mengembalikan kode status 200, terlepas dari apakah pesan tersebut berhasil diteruskan ke respond.io. Hal ini karena sifat webhook yang dirancang untuk mengembalikan respons langsung tanpa memverifikasi keberhasilan pengiriman pesan.