Webhook-Rückrufereignisse
Unterhaltung erstellt
Wenn ein Benutzer durch Aufruf der API erfolgreich eine neue Unterhaltung erstellt, empfängt die für den API-Kanal konfigurierte Webhook-Adresse ein Rückrufereignis für die Erstellung der Unterhaltung.
{
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"can_reply": true,
"channel": "Channel::Api",
"contact_inbox": {
"id": 42213404,
"contact_id": 42218348,
"inbox_id": 523,
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588",
"created_at": "2026-01-21T03:26:49.012Z",
"updated_at": "2026-01-21T03:26:49.012Z",
"hmac_verified": false,
"pubsub_token": "4Urn7N5A974k6C2H7Xeva8Ni"
},
"id": 89,
"inbox_id": 523,
"messages": [],
"labels": [],
"meta": {
"sender": {
"additional_attributes": {},
"custom_attributes": {},
"email": "alice@acme.inc",
"id": 42218348,
"identifier": null,
"name": "Test",
"phone_number": "+123456789",
"thumbnail": "",
"blocked": false,
"type": "contact"
},
"assignee": null,
"team": null,
"hmac_verified": false,
"channel": "Channel::Api"
},
"status": "open",
"custom_attributes": {},
"snoozed_until": null,
"unread_count": 0,
"first_reply_created_at": null,
"priority": null,
"waiting_since": 1768967324,
"conversation_category": "chat",
"chat_mode": "private_chat",
"ticket_info": null,
"agent_last_seen_at": 0,
"contact_last_seen_at": 0,
"last_activity_at": 1768967324,
"timestamp": 1768967324,
"created_at": 1768967324,
"updated_at": 1768967324.268219,
"event": "conversation_created"
}
{
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"can_reply": true,
"channel": "Channel::Api",
"contact_inbox": {
"id": 42213404,
"contact_id": 42218348,
"inbox_id": 523,
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588",
"created_at": "2026-01-21T03:26:49.012Z",
"updated_at": "2026-01-21T03:26:49.012Z",
"hmac_verified": false,
"pubsub_token": "4Urn7N5A974k6C2H7Xeva8Ni"
},
"id": 89,
"inbox_id": 523,
"messages": [],
"labels": [],
"meta": {
"sender": {
"additional_attributes": {},
"custom_attributes": {},
"email": "alice@acme.inc",
"id": 42218348,
"identifier": null,
"name": "Test",
"phone_number": "+123456789",
"thumbnail": "",
"blocked": false,
"type": "contact"
},
"assignee": null,
"team": null,
"hmac_verified": false,
"channel": "Channel::Api"
},
"status": "open",
"custom_attributes": {},
"snoozed_until": null,
"unread_count": 0,
"first_reply_created_at": null,
"priority": null,
"waiting_since": 1768967324,
"conversation_category": "chat",
"chat_mode": "private_chat",
"ticket_info": null,
"agent_last_seen_at": 0,
"contact_last_seen_at": 0,
"last_activity_at": 1768967324,
"timestamp": 1768967324,
"created_at": 1768967324,
"updated_at": 1768967324.268219,
"event": "conversation_created"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Parameter des Ereignisses zur Unterhaltungserstellung
| Field | Type | Required | Description |
|---|---|---|---|
| account | Object | No | Kontoinformationen |
| id | Number | No | Projekt-ID |
| name | String | No | Projektname |
| additional_attributes | Object | No | Zusätzliche Attribute |
| can_reply | Boolean | No | Gibt an, ob eine Antwort möglich ist |
| channel | String | No | Kanaltyp, z. B. api, email usw. |
| contact_inbox | Object | No | Kontaktinformationen |
| id | Number | No | ID der Tabelle contact_inbox, die die Beziehung zwischen Kontakt und Kanal aufzeichnet |
| contact_id | Number | No | Kontakt-ID |
| inbox_id | Number | No | Kanal-ID |
| source_id | String | No | Quell-ID der Unterhaltung, z. B. die user_id von Telegram |
| created_at | String | No | Erstellungszeit |
| updated_at | String | No | Aktualisierungszeit |
| hmac_verified | Boolean | No | Status der HMAC-Verifizierung |
| pubsub_token | String | No | Publish-Subscribe-Token |
| id | Number | No | Unterhaltungs-ID |
| inbox_id | Number | No | Kanal-ID |
| messages | Array | No | Nachrichtenliste |
| labels | Array | No | Liste der Bezeichnungen |
| meta | Object | No | Metainformationen |
| sender | Object | No | Absenderinformationen |
| additional_attributes | Object | No | Zusätzliche Attribute des Absenders |
| custom_attributes | Object | No | Benutzerdefinierte Attribute des Absenders |
| String | No | E-Mail-Adresse des Absenders | |
| id | Number | No | Interne ID des Absenders in liveDesk |
| identifier | String | No | Absenderkennung |
| name | String | No | Name des Absenders |
| phone_number | String | No | Telefonnummer des Absenders |
| thumbnail | String | No | Avatar des Absenders |
| blocked | Boolean | No | Gibt an, ob der Absender blockiert ist |
| type | String | No | Absendertyp |
| assignee | Object | No | Informationen zum zugewiesenen Kundendienstmitarbeiter |
| team | Object | No | Informationen zum zugewiesenen Kundendienstteam |
| hmac_verified | Boolean | No | Status der HMAC-Verifizierung |
| channel | String | No | Kanaltyp |
| status | String | No | Unterhaltungsstatus, z. B. open, closed usw. |
| custom_attributes | Object | No | Benutzerdefinierte Attribute |
| snoozed_until | String | No | Bis zu einem bestimmten Zeitpunkt zurückgestellt |
| unread_count | Number | No | Anzahl ungelesener Nachrichten |
| first_reply_created_at | String | No | Erstellungszeit der ersten Antwort |
| priority | String | No | Priorität |
| waiting_since | Number | No | Zeitpunkt, seit dem gewartet wird |
| conversation_category | String | No | Unterhaltungskategorie |
| chat_mode | String | No | Chatmodus |
| ticket_info | Object | No | Ticketinformationen |
| agent_last_seen_at | Number | No | Zeitpunkt der letzten Sichtung durch den Agenten |
| contact_last_seen_at | Number | No | Zeitpunkt der letzten Sichtung durch den Kontakt |
| last_activity_at | Number | No | Zeitpunkt der letzten Aktivität |
| timestamp | Number | No | Zeitstempel |
| created_at | Number | No | Erstellungszeit |
| updated_at | Number | No | Aktualisierungszeit |
| event | String | No | Ereignistyp |
Unterhaltung aktualisiert
Dieses Ereignis wird ausgelöst, wenn ein beliebiges Attribut der Unterhaltung aktualisiert wird.
{
"event": "conversation_updated",
"changed_attributes": [
{
"updated_at": {
"previous_value": "2026-01-21T04:04:56.548Z",
"current_value": "2026-01-21T04:04:56.601Z"
}
},
{
"first_reply_created_at": {
"previous_value": null,
"current_value": "2026-01-21T04:04:56.544Z"
}
},
{
"waiting_since": {
"previous_value": "2026-01-21T03:48:44.268Z",
"current_value": null
}
}
]
// <...Conversation Attributes> Inhalt der Unterhaltungsattribute
}
{
"event": "conversation_updated",
"changed_attributes": [
{
"updated_at": {
"previous_value": "2026-01-21T04:04:56.548Z",
"current_value": "2026-01-21T04:04:56.601Z"
}
},
{
"first_reply_created_at": {
"previous_value": null,
"current_value": "2026-01-21T04:04:56.544Z"
}
},
{
"waiting_since": {
"previous_value": "2026-01-21T03:48:44.268Z",
"current_value": null
}
}
]
// <...Conversation Attributes> Inhalt der Unterhaltungsattribute
}
Diesen Codeblock im schwebenden Fenster anzeigen
Parameter des Ereignisses zur Unterhaltungsaktualisierung
| Field | Type | Required | Description |
|---|---|---|---|
| event | String | No | Ereignistyp |
| changed_attributes | Array | No | Liste der geänderten Attribute |
| field_name | Object | No | Name des geänderten Feldes |
| previous_value | String | No | Wert vor der Änderung |
| current_value | String | No | Wert nach der Änderung |
Unterhaltungsstatus geändert
Dieses Ereignis wird ausgelöst, wenn sich der Unterhaltungsstatus ändert.
{
"event": "conversation_status_changed"
// <...Conversation Attributes> Inhalt der Unterhaltungsattribute
}
{
"event": "conversation_status_changed"
// <...Conversation Attributes> Inhalt der Unterhaltungsattribute
}
Diesen Codeblock im schwebenden Fenster anzeigen
Nachricht erstellt
Dieses Ereignis wird ausgelöst, wenn ein Benutzer oder ein Kundendienstmitarbeiter eine Nachricht sendet.
{
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"content_attributes": {},
"content_type": "text",
"content": "Hello, what can I help you with?",
"conversation": {
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"can_reply": true,
"channel": "Channel::Api",
"contact_inbox": {
"id": 42213404,
"contact_id": 42218348,
"inbox_id": 523,
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588",
"created_at": "2026-01-21T03:26:49.012Z",
"updated_at": "2026-01-21T03:26:49.012Z",
"hmac_verified": false,
"pubsub_token": "4Urn7N5A974k6C2H7Xeva8Ni"
},
"id": 89,
"inbox_id": 523,
"messages": [
{
"id": 2187685,
"content": "Hello, what can I help you with?",
"account_id": 17629000001207,
"inbox_id": 523,
"conversation_id": 89,
"message_type": 1,
"created_at": 1768968296,
"updated_at": "2026-01-21T04:04:56.544Z",
"private": false,
"status": "sent",
"source_id": null,
"content_type": "text",
"content_attributes": {},
"sender_type": "User",
"sender_id": 41,
"external_source_ids": {},
"additional_attributes": {},
"processed_message_content": "Hello, what can I help you with?",
"sentiment": {},
"sorting_id": null,
"original_message_id": null,
"conversation_topic_id": null,
"topic_id": null,
"conversation": {
"assignee_id": null,
"unread_count": 0,
"last_activity_at": 1768968296,
"contact_inbox": {
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588"
}
},
"sender": {
"id": 41,
"name": "support",
"available_name": "support",
"avatar_url": "",
"type": "user",
"availability_status": null,
"thumbnail": ""
}
}
],
"labels": [],
"meta": {
"sender": {
"additional_attributes": {},
"custom_attributes": {},
"email": "alice@acme.inc",
"id": 42218348,
"identifier": null,
"name": "Test",
"phone_number": "+123456789",
"thumbnail": "",
"blocked": false,
"type": "contact"
},
"assignee": null,
"team": null,
"hmac_verified": false,
"channel": "Channel::Api"
},
"status": "open",
"custom_attributes": {},
"snoozed_until": null,
"unread_count": 0,
"first_reply_created_at": null,
"priority": null,
"waiting_since": 1768967324,
"conversation_category": "chat",
"chat_mode": "private_chat",
"ticket_info": null,
"agent_last_seen_at": 0,
"contact_last_seen_at": 0,
"last_activity_at": 1768968296,
"timestamp": 1768968296,
"created_at": 1768967324,
"updated_at": 1768968296.5483441
},
"created_at": "2026-01-21T04:04:56.544Z",
"id": 2187685,
"inbox": {
"id": 523,
"name": "Test01"
},
"message_type": "outgoing",
"conversation_topic_id": null,
"private": false,
"sender": {
"id": 41,
"name": "support",
"email": "support@jiguang.cn",
"type": "user",
"availability": "online"
},
"source_id": null,
"user_id": 42213404,
"contact_id": 42218348,
"participants": null,
"event": "message_created"
}
{
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"content_attributes": {},
"content_type": "text",
"content": "Hello, what can I help you with?",
"conversation": {
"account": {
"id": 17629000001207,
"name": "1112"
},
"additional_attributes": {},
"can_reply": true,
"channel": "Channel::Api",
"contact_inbox": {
"id": 42213404,
"contact_id": 42218348,
"inbox_id": 523,
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588",
"created_at": "2026-01-21T03:26:49.012Z",
"updated_at": "2026-01-21T03:26:49.012Z",
"hmac_verified": false,
"pubsub_token": "4Urn7N5A974k6C2H7Xeva8Ni"
},
"id": 89,
"inbox_id": 523,
"messages": [
{
"id": 2187685,
"content": "Hello, what can I help you with?",
"account_id": 17629000001207,
"inbox_id": 523,
"conversation_id": 89,
"message_type": 1,
"created_at": 1768968296,
"updated_at": "2026-01-21T04:04:56.544Z",
"private": false,
"status": "sent",
"source_id": null,
"content_type": "text",
"content_attributes": {},
"sender_type": "User",
"sender_id": 41,
"external_source_ids": {},
"additional_attributes": {},
"processed_message_content": "Hello, what can I help you with?",
"sentiment": {},
"sorting_id": null,
"original_message_id": null,
"conversation_topic_id": null,
"topic_id": null,
"conversation": {
"assignee_id": null,
"unread_count": 0,
"last_activity_at": 1768968296,
"contact_inbox": {
"source_id": "1d484823-da29-4086-a7ba-d65ad0ebb588"
}
},
"sender": {
"id": 41,
"name": "support",
"available_name": "support",
"avatar_url": "",
"type": "user",
"availability_status": null,
"thumbnail": ""
}
}
],
"labels": [],
"meta": {
"sender": {
"additional_attributes": {},
"custom_attributes": {},
"email": "alice@acme.inc",
"id": 42218348,
"identifier": null,
"name": "Test",
"phone_number": "+123456789",
"thumbnail": "",
"blocked": false,
"type": "contact"
},
"assignee": null,
"team": null,
"hmac_verified": false,
"channel": "Channel::Api"
},
"status": "open",
"custom_attributes": {},
"snoozed_until": null,
"unread_count": 0,
"first_reply_created_at": null,
"priority": null,
"waiting_since": 1768967324,
"conversation_category": "chat",
"chat_mode": "private_chat",
"ticket_info": null,
"agent_last_seen_at": 0,
"contact_last_seen_at": 0,
"last_activity_at": 1768968296,
"timestamp": 1768968296,
"created_at": 1768967324,
"updated_at": 1768968296.5483441
},
"created_at": "2026-01-21T04:04:56.544Z",
"id": 2187685,
"inbox": {
"id": 523,
"name": "Test01"
},
"message_type": "outgoing",
"conversation_topic_id": null,
"private": false,
"sender": {
"id": 41,
"name": "support",
"email": "support@jiguang.cn",
"type": "user",
"availability": "online"
},
"source_id": null,
"user_id": 42213404,
"contact_id": 42218348,
"participants": null,
"event": "message_created"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Parameter des Ereignisses zur Nachrichtenerstellung
| Field | Type | Required | Description |
|---|---|---|---|
| account | Object | No | Kontoinformationen |
| id | Number | No | Projekt-ID |
| name | String | No | Projektname |
| additional_attributes | Object | No | Zusätzliche Attribute |
| content_attributes | Object | No | Inhaltsattribute |
| content_type | String | No | Inhaltstyp |
| content | String | No | Nachrichteninhalt |
| conversation | Object | No | Unterhaltungsinformationen |
| created_at | String | No | Erstellungszeit |
| id | Number | No | Nachrichten-ID |
| inbox | Object | No | Kanalinformationen |
| id | Number | No | Kanal-ID |
| name | String | No | Kanalname |
| message_type | String | No | Nachrichtentyp |
| conversation_topic_id | String | No | ID des Unterhaltungsthemas |
| private | Boolean | No | Gibt an, ob die Nachricht privat ist |
| sender | Object | No | Absenderinformationen |
| id | Number | No | Absender-ID |
| name | String | No | Name des Absenders |
| String | No | E-Mail-Adresse des Absenders | |
| type | String | No | Absendertyp |
| availability | String | No | Verfügbarkeitsstatus des Absenders |
| source_id | String | No | Quell-ID |
| participants | Object | No | Teilnehmerinformationen |
| event | String | No | Ereignistyp |
Nachricht aktualisiert
Dieses Ereignis wird ausgelöst, wenn der Nachrichteninhalt in der Unterhaltung aktualisiert wird.
{
"event": "message_updated"
// <...Message Attributes> Inhalt der Nachrichtenattribute
}
{
"event": "message_updated"
// <...Message Attributes> Inhalt der Nachrichtenattribute
}
Diesen Codeblock im schwebenden Fenster anzeigen
