Bagaimana cara mengirim pesan di Saluran API

Karena API Channel tidak mendukung pembuatan kontak secara implisit. LivedDesk menggunakan API Channel dalam tiga langkah:

Buat kontak
Buat percakapan berdasarkan informasi kontak
Kirim pesan

Buat Kontak

Titik Akhir API

https://livedesk-api.engagelab.com/api/v2/accounts/contacts

Contoh Permintaan

curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/contacts \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ { "inbox_id": 407, "name": "Test", // Optional "email": "alice@acme.inc", "phone_number": "+123456789", "avatar_url": "https://example.com/avatar.png", "identifier": "1234567890", }

              
              curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/contacts \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
{
    "inbox_id": 407,
    "name": "Test",                   // Optional
    "email": "alice@acme.inc",
    "phone_number": "+123456789", 
    "avatar_url": "https://example.com/avatar.png",
    "identifier": "1234567890",
}

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Field	Type	Description
Authorization	string	Gunakan `Authorization: Basic base64(API Key:API Secret)` untuk otentikasi. Silakan pergi ke halaman API Key untuk mendapatkan API Key dan API Secret, dan gabungkan dengan tanda titik dua sebelum mengenkripsi Base64.
Content-Type	application/json	Jenis data, gunakan application/json untuk pesan teks biasa.

Parameter Body Permintaan

Field	Type	Required	Description
inbox_id	String	Yes	channel ID. Sesuai dengan Channel ID di "Pengaturan Proyek-Channel-Channel tertentu-Pengaturan".
name	String	No	Nama kontak.
email	String	No	Alamat email.
phone_number	String	No	Metode kontak.
avatar_url	String	No	Tautan lampiran.
identifier	String	No	Pengidentifikasi pengguna.

Contoh Respons

{ "payload": { "contact": { "additional_attributes": {}, "availability_status": "offline", "email": null, "id": 2219259, "name": "Test", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "created_at": 1766571703, "contact_inboxes": [] }, "contact_inbox": { "inbox": null, "source_id": null } } }

              
              {
    "payload": {
        "contact": {
            "additional_attributes": {},
            "availability_status": "offline",
            "email": null,
            "id": 2219259,
            "name": "Test",
            "phone_number": null,
            "blocked": false,
            "identifier": null,
            "thumbnail": "",
            "custom_attributes": {},
            "created_at": 1766571703,
            "contact_inboxes": []
        },
        "contact_inbox": {
            "inbox": null,
            "source_id": null
        }
    }
}

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Field	Type	Required	Description
additional_attributes	Object	No	Atribut lampiran.
availability_status	String	No	Status online, default adalah offline.
email	String	No	Alamat email.
id	String	No	ID kontak.
name	String	No	Nama
phone_number	String	No	Nomor telepon.
blocked	String	No	Apakah terkunci, default adalah false.
identifier	String	No	Pengidentifikasi pengguna.
thumbnail	String	No	Pengidentifikasi pengguna.
custom_attributes	String	No	Atribut pelanggan.
created_at	String	No	Tanda waktu pembuatan.
contact_inboxes	Array	No	Pengidentifikasi pengguna.
inbox	String	No	channel channel.
source_id	String	No	ID Sumber.

Buat Percakapan

Titik Akhir API

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

Contoh Permintaan

curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/conversations \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ { "inbox_id": 407, // Required "contact_id": 2219256, // Either contact_id or source_id can be passed, but it must correctly identify the sender "source_id": "123456789" }

              
              curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/conversations \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
{
  "inbox_id": 407,              // Required
  "contact_id": 2219256,        // Either contact_id or source_id can be passed, but it must correctly identify the sender
  "source_id": "123456789"
}

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Field	Type	Description
Authorization	string	Gunakan `Authorization: Basic base64(API Key:API Secret)` untuk otentikasi. Silakan pergi ke halaman API Key untuk mendapatkan API Key dan API Secret, dan gabungkan dengan tanda titik dua sebelum mengenkripsi Base64.
Content-Type	application/json	Jenis data, gunakan application/json untuk pesan teks biasa.

Parameter Body Permintaan

Field	Type	Required	Description
inbox_id	String	Yes	channel ID. Sama dengan ID yang digunakan dalam antarmuka pembuatan kontak.
contact_id	String	No	ID kontak. id dari respons antarmuka pembuatan kontak
source_id	String	No	ID Sumber.

Contoh Respons

{ "meta": { "sender": { "additional_attributes": {}, "availability_status": "offline", "email": null, "id": 2219256, "name": "Test", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "created_at": 1766571624 }, "channel": "Channel::Api", "hmac_verified": false }, "id": 40, "messages": [], "account_id": 17623000010928, "uuid": "660ce36f-46bb-4153-948c-8a26e6dab634", "inbox_id": 407, "additional_attributes": {}, "agent_last_seen_at": 0, "assignee_last_seen_at": 0, "can_reply": true, "contact_last_seen_at": 0, "custom_attributes": {}, "labels": [], "muted": false, "snoozed_until": null, "status": "open", "priority": null, "conversation_category": "chat", "chat_mode": "private_chat", "is_forum": false, "created_at": 1766572062, "updated_at": 1766572062.5803902, "timestamp": 1766572062, "first_reply_created_at": 0, "unread_count": 0, "last_non_activity_message": null, "last_activity_at": 1766572062, "waiting_since": 1766572062, "sla_policy_id": null, "ticket_id": null, "over_limit": false, "content_preview": { "content": null, "message_type": null, "created_at": null }, "platform": { "channel_type": "Channel::Api", "inbox_name": "JennyApi", "inbox_id": 407 }, "account_info": { "contact_name": "Test", "contact_email": null, "contact_phone": null, "contact_id": 2219256, "contact_avatar": "" }, "assignment": { "assignee_id": null, "assignee_name": null, "assignee_email": null, "team_id": null, "team_name": null } }

              
              {
    "meta": {
        "sender": {
            "additional_attributes": {},
            "availability_status": "offline",
            "email": null,
            "id": 2219256,
            "name": "Test",
            "phone_number": null,
            "blocked": false,
            "identifier": null,
            "thumbnail": "",
            "custom_attributes": {},
            "created_at": 1766571624
        },
        "channel": "Channel::Api",
        "hmac_verified": false
    },
    "id": 40,
    "messages": [],
    "account_id": 17623000010928,
    "uuid": "660ce36f-46bb-4153-948c-8a26e6dab634",
    "inbox_id": 407,
    "additional_attributes": {},
    "agent_last_seen_at": 0,
    "assignee_last_seen_at": 0,
    "can_reply": true,
    "contact_last_seen_at": 0,
    "custom_attributes": {},
    "labels": [],
    "muted": false,
    "snoozed_until": null,
    "status": "open",
    "priority": null,
    "conversation_category": "chat",
    "chat_mode": "private_chat",
    "is_forum": false,
    "created_at": 1766572062,
    "updated_at": 1766572062.5803902,
    "timestamp": 1766572062,
    "first_reply_created_at": 0,
    "unread_count": 0,
    "last_non_activity_message": null,
    "last_activity_at": 1766572062,
    "waiting_since": 1766572062,
    "sla_policy_id": null,
    "ticket_id": null,
    "over_limit": false,
    "content_preview": {
        "content": null,
        "message_type": null,
        "created_at": null
    },
    "platform": {
        "channel_type": "Channel::Api",
        "inbox_name": "JennyApi",
        "inbox_id": 407
    },
    "account_info": {
        "contact_name": "Test",
        "contact_email": null,
        "contact_phone": null,
        "contact_id": 2219256,
        "contact_avatar": ""
    },
    "assignment": {
        "assignee_id": null,
        "assignee_name": null,
        "assignee_email": null,
        "team_id": null,
        "team_name": null
    }
}

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Field	Type	Required	Description
meta	Object	No	Objek metadata.
sender	Object	No	Informasi pengirim.
additional_attributes	Object	No	Atribut tambahan.
availability_status	String	No	Status ketersediaan.
email	Null	No	Email.
id	Number	No	ID kontak.
name	String	No	Nama pengirim.
phone_number	Null	No	Nomor telepon.
blocked	Boolean	No	Apakah diblokir.
identifier	Null	No	Pengidentifikasi atribut pengguna.
thumbnail	String	No	Thumbnail.
custom_attributes	Object	No	Atribut kustom.
created_at	Number	No	Tanda waktu pembuatan percakapan.
channel	String	No	Jenis channel.
hmac_verified	Boolean	No	Status verifikasi HMAC.
id	Number	No	ID percakapan.
messages	Array	No	Array pesan.
account_id	Number	No	ID Proyek
uuid	String	No	Pengidentifikasi unik.
inbox_id	Number	No	ID Channel.
additional_attributes	Object	No	Atribut tambahan.
agent_last_seen_at	Number	No	Waktu terakhir agen diproses.
assignee_last_seen_at	Number	No	Waktu terakhir assignee diproses.
can_reply	Boolean	No	Apakah dapat membalas.
contact_last_seen_at	Number	No	Waktu terakhir kontak dilihat.
custom_attributes	Object	No	Atribut kustom.
labels	Array	No	Array label.
muted	Boolean	No	Apakah dibisukan.
snoozed_until	Null	No	Sampai kapan dijeda.
status	String	No	Status.
priority	Null	No	Prioritas.
conversation_category	String	No	Kategori percakapan.
chat_mode	String	No	Mode chat.
is_forum	Boolean	No	Apakah itu forum.
created_at	Number	No	Tanda waktu pembuatan.
updated_at	Number	No	Tanda waktu pembaruan.
timestamp	Number	No	Tanda waktu.
first_reply_created_at	Number	No	Waktu pembuatan balasan pertama.
unread_count	Number	No	Jumlah belum dibaca.
last_non_activity_message	Null	No	Pesan non-aktivitas terakhir.
last_activity_at	Number	No	Waktu aktivitas terakhir.
waiting_since	Number	No	Waktu mulai menunggu.
sla_policy_id	Null	No	ID kebijakan SLA.
ticket_id	Null	No	ID tiket.
over_limit	Boolean	No	Apakah melebihi batas.
content_preview	Object	No	Preview konten.
content_preview.content	Null	No	Konten preview.
content_preview.message_type	Null	No	Jenis pesan.
content_preview.created_at	Null	No	Waktu pembuatan.
platform	Object	No	Informasi platform.
channel_type	String	No	Jenis channel.
inbox_name	String	No	Nama inbox.
inbox_id	Number	No	ID inbox.
account_info	Object	No	Informasi akun.
contact_name	String	No	Nama kontak.
contact_email	Null	No	Email kontak.
contact_phone	Null	No	Telepon kontak.
contact_id	Number	No	ID kontak.
contact_avatar	String	No	Avatar kontak.
assignment	Object	No	Informasi penugasan.
assignee_id	Null	No	ID assignee.
assignee_name	Null	No	Nama assignee.
assignee_email	Null	No	Email assignee.
team_id	Null	No	ID tim.
team_name	Null	No	Nama tim.

Kirim Pesan

Titik Akhir API

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

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": "Customer service sends a message, is it normal?", "private": false, "message_type": "incoming", "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": "Customer service sends a message, is it normal?",  
    "private": false,
    "message_type": "incoming",
    "content_attributes": {
        "in_reply_to": 29   
    }
}'

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Field	Type	Description
Authorization	string	Gunakan `Authorization: Basic base64(API Key:API Secret)` untuk otentikasi. Silakan pergi ke halaman API Key untuk mendapatkan API Key dan API Secret, dan gabungkan dengan tanda titik dua sebelum mengenkripsi Base64.
Content-Type	application/json	Jenis data, gunakan application/json untuk pesan teks biasa.

Parameter Body Permintaan

Field	Type	Required	Description
content	String	No	channel ID. Sesuai dengan Channel ID di "Pengaturan Proyek-Channel-Channel tertentu-Pengaturan".
private	String	No	Nama kontak.
message_type	String	No	Jenis pesan, outgoing atau incoming. Mewakili pengiriman layanan pelanggan atau pengiriman pengguna masing-masing. Default ke outgoing jika tidak dilewatkan.
content_attributes	String	No	Atribut konten.
in_reply_to	String	No	Konten balasan.