Kirim Pesan

Pengembang dapat mengirim pesan ke percakapan tertentu melalui API.

Metode Permintaan

POST

URL Permintaan

https://livedesk-api.engagelab.com/api/v2/accounts/conversations/:conversation_id/messages

Autentikasi

Silakan lihat penjelasan autentikasi pada Gambaran Umum API untuk detail lebih lanjut.

Permintaan Teks

Contoh Permintaan

curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/conversations/:conversation_id/messages' \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ -d '{ "content": "Agent mengirim pesan, apakah normal?", "private": false, "content_attributes": { "in_reply_to": 29 } }'

              
              curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/conversations/:conversation_id/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
    "content": "Agent mengirim pesan, apakah normal?",  
    "private": false,
    "content_attributes": {
        "in_reply_to": 29   
    }
}'

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Field	Tipe	Deskripsi
Authorization	string	Gunakan `Authorization: Basic base64(API Key:API Secret)` untuk autentikasi. Silakan kunjungi halaman API Key untuk mendapatkan API Key dan API Secret, lalu hubungkan dengan tanda titik dua sebelum dienkode Base64.
Content-Type	application/json	Jenis data, gunakan application/json untuk pesan teks biasa.

Parameter Path

Field	Tipe	Wajib	Deskripsi
conversation_id	string	Ya	ID Percakapan.

Parameter Body Permintaan

Field	Tipe	Wajib	Deskripsi
content	String	Ya	Isi pesan.
private	Boolean	Tidak	Apakah pesan bersifat privat, default adalah false.
content_attributes	Object	Tidak	Atribut konten, seperti menentukan ID pesan dengan field `in_reply_to` saat membalas pesan.

Contoh Respons Teks

Respons Berhasil

{ "id": 3030, "content": "Agent mengirim pesan, apakah normal?", "inbox_id": 79, "conversation_id": 141, "message_type": 1, "content_type": "text", "status": "sent", "content_attributes": {}, "created_at": 1762331029, "private": false, "source_id": null, "sorting_id": 4, "sender": { "id": 3, "name": "TEST", "available_name": "TEST", "avatar_url": "", "type": "user", "availability_status": "offline", "thumbnail": "" } }

              
              {
    "id": 3030,
    "content": "Agent mengirim pesan, apakah normal?",
    "inbox_id": 79,
    "conversation_id": 141,
    "message_type": 1,
    "content_type": "text",
    "status": "sent",
    "content_attributes": {},
    "created_at": 1762331029,
    "private": false,
    "source_id": null,
    "sorting_id": 4,
    "sender": {
        "id": 3,
        "name": "TEST",
        "available_name": "TEST",
        "avatar_url": "",
        "type": "user",
        "availability_status": "offline",
        "thumbnail": ""
    }
}

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Field	Tipe	Deskripsi
id	Int	ID Pesan.
content	String	Isi pesan.
inbox_id	Int	ID Kotak Masuk.
conversation_id	Int	ID Percakapan.
message_type	Int	Tipe pesan.
content_type	String	Jenis konten.
status	String	Status pesan, seperti "sent", "delivered", dll.
content_attributes	Object	Atribut konten.
created_at	Int	Stempel waktu pembuatan pesan.
private	Boolean	Apakah pesan bersifat privat.
source_id	Int	ID Sumber.
sorting_id	Int	ID Pengurutan.
sender	Object	Informasi pengirim.
id	Int	ID Pengirim.
name	String	Nama pengirim.
available_name	String	Nama tampilan pengirim.
avatar_url	String	URL avatar pengirim.
type	String	Tipe pengirim (misal: user).
availability_status	String	Status online pengirim (misal: offline).
thumbnail	String	Thumbnail pengirim.

Permintaan Gambar/Audio/Berkas

Contoh Permintaan

curl -X POST "https://livedesk.engagelab.com/api/v2/accounts/conversations/:conversation_id/messages" \ -H "Authorization: Basic base64(api_key:api_secret)" \ -F "attachments[]=@/path/to/your/file.jpg" \ -F "content=Gambar detail seperti berikut"

              
              curl -X POST "https://livedesk.engagelab.com/api/v2/accounts/conversations/:conversation_id/messages" \
  -H "Authorization: Basic base64(api_key:api_secret)" \
  -F "attachments[]=@/path/to/your/file.jpg" \
  -F "content=Gambar detail seperti berikut"

Tampilkan blok kode ini di jendela mengambang

Parameter Path

Field	Tipe	Wajib	Deskripsi
conversation_id	string	Ya	ID Percakapan.

Contoh Respons Gambar/Audio/Berkas

Respons Berhasil

{ "id": 3031, "content": "Gambar detail seperti berikut", "inbox_id": 79, "conversation_id": 141, "message_type": 1, "content_type": "text", "status": "sent", "content_attributes": {}, "created_at": 1762331762, "private": false, "source_id": null, "sorting_id": 5, "sender": { "id": 3, "name": "Wenjie Yu", "available_name": "Wenjie Yu", "avatar_url": "", "type": "user", "availability_status": "offline", "thumbnail": "" }, "attachments": [ { "id": 199, "message_id": 3031, "file_type": "image", "account_id": 14, "extension": null, "data_url": "https://livedesk.engagelab.com/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBamNUIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--727ba7469d64f90790d242c743f254b5c9013fe1/android-icon-48x48.png", "thumb_url": "https://livedesk.engagelab.com/rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2RTNKbGMybDZaVjkwYjE5bWFXeHNXd2RwQWZvdyIsImV4cCI6bnVsbCwicHVyIjoidmFyaWF0aW9uIn19--63c890cbf173eb3dc92a8786fcc3e120c329852d/android-icon-48x48.png", "file_size": 589136, "width": null, "height": null } ] }

              
              {
    "id": 3031,
    "content": "Gambar detail seperti berikut",
    "inbox_id": 79,
    "conversation_id": 141,
    "message_type": 1,
    "content_type": "text",
    "status": "sent",
    "content_attributes": {},
    "created_at": 1762331762,
    "private": false,
    "source_id": null,
    "sorting_id": 5,
    "sender": {
        "id": 3,
        "name": "Wenjie Yu",
        "available_name": "Wenjie Yu",
        "avatar_url": "",
        "type": "user",
        "availability_status": "offline",
        "thumbnail": ""
    },
    "attachments": [
        {
            "id": 199,
            "message_id": 3031,
            "file_type": "image",
            "account_id": 14,
            "extension": null,
            "data_url": "https://livedesk.engagelab.com/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBamNUIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--727ba7469d64f90790d242c743f254b5c9013fe1/android-icon-48x48.png",
            "thumb_url": "https://livedesk.engagelab.com/rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2RTNKbGMybDZaVjkwYjE5bWFXeHNXd2RwQWZvdyIsImV4cCI6bnVsbCwicHVyIjoidmFyaWF0aW9uIn19--63c890cbf173eb3dc92a8786fcc3e120c329852d/android-icon-48x48.png",
            "file_size": 589136,
            "width": null,
            "height": null
        }
    ]
}

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Field	Tipe	Deskripsi
id	Int	ID Pesan.
content	String	Isi pesan.
inbox_id	Int	ID Kotak Masuk.
conversation_id	Int	ID Percakapan.
message_type	Int	Tipe pesan.
content_type	String	Jenis konten.
status	String	Status pesan, seperti "sent", "delivered", dll.
content_attributes	Object	Atribut konten.
created_at	Int	Stempel waktu pembuatan pesan.
private	Boolean	Apakah pesan bersifat privat.
source_id	Int	ID Sumber.
sorting_id	Int	ID Pengurutan.
sender	Object	Informasi pengirim.
id	Int	ID Pengirim.
name	String	Nama pengirim.
available_name	String	Nama tampilan pengirim.
avatar_url	String	URL avatar pengirim.
type	String	Tipe pengirim (misal: user).
availability_status	String	Status online pengirim (misal: offline).
thumbnail	String	Thumbnail pengirim.
attachments	Array	Daftar informasi lampiran.
id	Int	ID Lampiran.
message_id	Int	ID pesan yang dimiliki.
file_type	String	Jenis file (misal: image).
account_id	Int	ID Akun.
extension	String	Ekstensi file.
data_url	String	URL file.
thumb_url	String	URL thumbnail (khusus tipe gambar).
file_size	Int	Ukuran file (byte).
width	Int	Lebar file (khusus tipe gambar).
height	Int	Tinggi file (khusus tipe gambar).