ライブチャット
LiveChat と連携して会話の管理やメッセージ送信などを行う
トリガー
このノードでフローを開始できるイベントです。トリガーを選択 から追加します。
会話作成
新しい会話が作成されたときにトリガーされる
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば conversation.id は $trigger.output.conversation.id です。
{
"conversation": {
"id": "string",
"orgId": "string",
"name": "string",
"memos": [
{
"id": "string",
"text": "string",
"created": "string",
"sender": {}
}
],
"tags": [
"string"
],
"status": "string",
"statusUpdatedAt": "string",
"created": "string",
"isAssigned": false,
"ocsChannel": "string",
"platform": {},
"teamId": "string",
"autoClosedConversation": false
},
"message": "string",
"enduser": {
"id": "string",
"recurrent": false
},
"team": {
"id": "string"
},
"assignee": {
"id": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
conversation | 任意 | |
conversation.id | テキスト | 会話の一意識別子 |
conversation.orgId | テキスト | 組織のID |
conversation.name | テキスト | 会話名 |
conversation.memos[] | リスト | メモの配列 |
conversation.memos[].id | テキスト | メモの一意識別子 |
conversation.memos[].text | テキスト | メモの本文 |
conversation.memos[].created | テキスト | メモが作成されたタイムスタンプ |
conversation.memos[].sender | 任意 | |
conversation.memos[].sender.id | テキスト | 送信者の一意識別子 |
conversation.memos[].sender.name | テキスト | 送信者名 |
conversation.memos[].sender.email | テキスト | 送信者のメールアドレス |
conversation.tags[] | リスト | タグの配列 |
conversation.status | テキスト | 会話のステータス |
conversation.statusUpdatedAt | テキスト | ステータスが更新された時刻 |
conversation.created | テキスト | 会話が作成されたタイムスタンプ |
conversation.isAssigned | はい / いいえ | 会話が担当者に割り当てられているかどうか |
conversation.ocsChannel | テキスト | 会話のOCSチャンネル |
conversation.platform | 任意 | |
conversation.platform.name | テキスト | プラットフォーム名 |
conversation.platform.channelId | テキスト | チャンネルのID |
conversation.platform.channelName | テキスト | チャンネル名 |
conversation.teamId | テキスト | チームのID |
conversation.autoClosedConversation | はい / いいえ | 会話が自動的にクローズされたかどうか |
message | 任意 | |
message.id | テキスト | メッセージの一意識別子 |
message.from | テキスト | メッセージの送信元(例:ユーザー、ボット) |
message.conversationId | テキスト | このメッセージが属する会話のID |
message.type | テキスト | メッセージの種類(例:text) |
message.data | オブジェクト | メッセージデータの内容 |
message.data.metadata | オブジェクト | メッセージに関する追加メタデータ |
message.data.metadata.sender | オブジェクト | メッセージ送信者に関する情報 |
message.data.id | テキスト | メッセージデータの一意識別子 |
message.data.text | テキスト | メッセージのテキスト内容 |
message.data.type | テキスト | メッセージデータの種類 |
message.sender | オブジェクト | メッセージ送信者に関する情報 |
message.sender.name | テキスト | 送信者名 |
message.sender.id | テキスト | 送信者の一意識別子 |
message.sender.type | テキスト | 送信者の種類(例:enduser) |
message.sender.picture | テキスト | 送信者のプロフィール画像URL |
message.created | テキスト | メッセージが作成されたタイムスタンプ |
message.isFirstMessage | はい / いいえ | 会話内の最初のメッセージかどうか |
enduser | 任意 | |
enduser.id | テキスト | エンドユーザーの一意識別子 |
enduser.recurrent | はい / いいえ | エンドユーザーが再来かどうか |
team | 任意 | |
team.id | テキスト | チームの一意識別子 |
assignee | 任意 | |
assignee.id | テキスト | 担当者の一意識別子 |
会話クローズ
会話がクローズされたときにトリガーされる
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば conversation.id は $trigger.output.conversation.id です。
{
"conversation": {
"id": "string",
"orgId": "string",
"name": "string",
"memos": [
{
"id": "string",
"text": "string",
"created": "string",
"sender": {}
}
],
"tags": [
"string"
],
"status": "string",
"statusUpdatedAt": "string",
"created": "string",
"isAssigned": false,
"ocsChannel": "string",
"platform": {},
"teamId": "string",
"autoClosedConversation": false
},
"message": "string",
"enduser": {
"id": "string",
"recurrent": false
},
"team": {
"id": "string"
},
"assignee": {
"id": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
conversation | 任意 | |
conversation.id | テキスト | 会話の一意識別子 |
conversation.orgId | テキスト | 組織のID |
conversation.name | テキスト | 会話名 |
conversation.memos[] | リスト | メモの配列 |
conversation.memos[].id | テキスト | メモの一意識別子 |
conversation.memos[].text | テキスト | メモの本文 |
conversation.memos[].created | テキスト | メモが作成されたタイムスタンプ |
conversation.memos[].sender | 任意 | |
conversation.memos[].sender.id | テキスト | 送信者の一意識別子 |
conversation.memos[].sender.name | テキスト | 送信者名 |
conversation.memos[].sender.email | テキスト | 送信者のメールアドレス |
conversation.tags[] | リスト | タグの配列 |
conversation.status | テキスト | 会話のステータス |
conversation.statusUpdatedAt | テキスト | ステータスが更新された時刻 |
conversation.created | テキスト | 会話が作成されたタイムスタンプ |
conversation.isAssigned | はい / いいえ | 会話が担当者に割り当てられているかどうか |
conversation.ocsChannel | テキスト | 会話のOCSチャンネル |
conversation.platform | 任意 | |
conversation.platform.name | テキスト | プラットフォーム名 |
conversation.platform.channelId | テキスト | チャンネルのID |
conversation.platform.channelName | テキスト | チャンネル名 |
conversation.teamId | テキスト | チームのID |
conversation.autoClosedConversation | はい / いいえ | 会話が自動的にクローズされたかどうか |
message | 任意 | |
message.id | テキスト | メッセージの一意識別子 |
message.from | テキスト | メッセージの送信元(例:ユーザー、ボット) |
message.conversationId | テキスト | このメッセージが属する会話のID |
message.type | テキスト | メッセージの種類(例:text) |
message.data | オブジェクト | メッセージデータの内容 |
message.data.metadata | オブジェクト | メッセージに関する追加メタデータ |
message.data.metadata.sender | オブジェクト | メッセージ送信者に関する情報 |
message.data.id | テキスト | メッセージデータの一意識別子 |
message.data.text | テキスト | メッセージのテキスト内容 |
message.data.type | テキスト | メッセージデータの種類 |
message.sender | オブジェクト | メッセージ送信者に関する情報 |
message.sender.name | テキスト | 送信者名 |
message.sender.id | テキスト | 送信者の一意識別子 |
message.sender.type | テキスト | 送信者の種類(例:enduser) |
message.sender.picture | テキスト | 送信者のプロフィール画像URL |
message.created | テキスト | メッセージが作成されたタイムスタンプ |
message.isFirstMessage | はい / いいえ | 会話内の最初のメッセージかどうか |
enduser | 任意 | |
enduser.id | テキスト | エンドユーザーの一意識別子 |
enduser.recurrent | はい / いいえ | エンドユーザーが再来かどうか |
team | 任意 | |
team.id | テキスト | チームの一意識別子 |
assignee | 任意 | |
assignee.id | テキスト | 担当者の一意識別子 |
メッセージ受信
会話で新しいメッセージを受信したときにトリガーされる
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば conversation.id は $trigger.output.conversation.id です。
{
"conversation": {
"id": "string",
"orgId": "string",
"name": "string",
"memos": [
{
"id": "string",
"text": "string",
"created": "string",
"sender": {}
}
],
"tags": [
"string"
],
"status": "string",
"statusUpdatedAt": "string",
"created": "string",
"isAssigned": false,
"ocsChannel": "string",
"platform": {},
"teamId": "string",
"autoClosedConversation": false
},
"message": "string",
"enduser": {
"id": "string",
"recurrent": false
},
"team": {
"id": "string"
},
"assignee": {
"id": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
conversation | 任意 | |
conversation.id | テキスト | 会話の一意識別子 |
conversation.orgId | テキスト | 組織のID |
conversation.name | テキスト | 会話名 |
conversation.memos[] | リスト | メモの配列 |
conversation.memos[].id | テキスト | メモの一意識別子 |
conversation.memos[].text | テキスト | メモの本文 |
conversation.memos[].created | テキスト | メモが作成されたタイムスタンプ |
conversation.memos[].sender | 任意 | |
conversation.memos[].sender.id | テキスト | 送信者の一意識別子 |
conversation.memos[].sender.name | テキスト | 送信者名 |
conversation.memos[].sender.email | テキスト | 送信者のメールアドレス |
conversation.tags[] | リスト | タグの配列 |
conversation.status | テキスト | 会話のステータス |
conversation.statusUpdatedAt | テキスト | ステータスが更新された時刻 |
conversation.created | テキスト | 会話が作成されたタイムスタンプ |
conversation.isAssigned | はい / いいえ | 会話が担当者に割り当てられているかどうか |
conversation.ocsChannel | テキスト | 会話のOCSチャンネル |
conversation.platform | 任意 | |
conversation.platform.name | テキスト | プラットフォーム名 |
conversation.platform.channelId | テキスト | チャンネルのID |
conversation.platform.channelName | テキスト | チャンネル名 |
conversation.teamId | テキスト | チームのID |
conversation.autoClosedConversation | はい / いいえ | 会話が自動的にクローズされたかどうか |
message | 任意 | |
message.id | テキスト | メッセージの一意識別子 |
message.from | テキスト | メッセージの送信元(例:ユーザー、ボット) |
message.conversationId | テキスト | このメッセージが属する会話のID |
message.type | テキスト | メッセージの種類(例:text) |
message.data | オブジェクト | メッセージデータの内容 |
message.data.metadata | オブジェクト | メッセージに関する追加メタデータ |
message.data.metadata.sender | オブジェクト | メッセージ送信者に関する情報 |
message.data.id | テキスト | メッセージデータの一意識別子 |
message.data.text | テキスト | メッセージのテキスト内容 |
message.data.type | テキスト | メッセージデータの種類 |
message.sender | オブジェクト | メッセージ送信者に関する情報 |
message.sender.name | テキスト | 送信者名 |
message.sender.id | テキスト | 送信者の一意識別子 |
message.sender.type | テキスト | 送信者の種類(例:enduser) |
message.sender.picture | テキスト | 送信者のプロフィール画像URL |
message.created | テキスト | メッセージが作成されたタイムスタンプ |
message.isFirstMessage | はい / いいえ | 会話内の最初のメッセージかどうか |
enduser | 任意 | |
enduser.id | テキスト | エンドユーザーの一意識別子 |
enduser.recurrent | はい / いいえ | エンドユーザーが再来かどうか |
team | 任意 | |
team.id | テキスト | チームの一意識別子 |
assignee | 任意 | |
assignee.id | テキスト | 担当者の一意識別子 |
担当者更新
会話の担当者が更新されたときにトリガーされる
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば conversation.id は $trigger.output.conversation.id です。
{
"conversation": {
"id": "string",
"orgId": "string",
"name": "string",
"memos": [
{
"id": "string",
"text": "string",
"created": "string",
"sender": {}
}
],
"tags": [
"string"
],
"status": "string",
"statusUpdatedAt": "string",
"created": "string",
"isAssigned": false,
"ocsChannel": "string",
"platform": {},
"teamId": "string",
"autoClosedConversation": false
},
"message": "string",
"enduser": {
"id": "string",
"recurrent": false
},
"team": {
"id": "string"
},
"assignee": {
"id": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
conversation | 任意 | |
conversation.id | テキスト | 会話の一意識別子 |
conversation.orgId | テキスト | 組織のID |
conversation.name | テキスト | 会話名 |
conversation.memos[] | リスト | メモの配列 |
conversation.memos[].id | テキスト | メモの一意識別子 |
conversation.memos[].text | テキスト | メモの本文 |
conversation.memos[].created | テキスト | メモが作成されたタイムスタンプ |
conversation.memos[].sender | 任意 | |
conversation.memos[].sender.id | テキスト | 送信者の一意識別子 |
conversation.memos[].sender.name | テキスト | 送信者名 |
conversation.memos[].sender.email | テキスト | 送信者のメールアドレス |
conversation.tags[] | リスト | タグの配列 |
conversation.status | テキスト | 会話のステータス |
conversation.statusUpdatedAt | テキスト | ステータスが更新された時刻 |
conversation.created | テキスト | 会話が作成されたタイムスタンプ |
conversation.isAssigned | はい / いいえ | 会話が担当者に割り当てられているかどうか |
conversation.ocsChannel | テキスト | 会話のOCSチャンネル |
conversation.platform | 任意 | |
conversation.platform.name | テキスト | プラットフォーム名 |
conversation.platform.channelId | テキスト | チャンネルのID |
conversation.platform.channelName | テキスト | チャンネル名 |
conversation.teamId | テキスト | チームのID |
conversation.autoClosedConversation | はい / いいえ | 会話が自動的にクローズされたかどうか |
message | 任意 | |
message.id | テキスト | メッセージの一意識別子 |
message.from | テキスト | メッセージの送信元(例:ユーザー、ボット) |
message.conversationId | テキスト | このメッセージが属する会話のID |
message.type | テキスト | メッセージの種類(例:text) |
message.data | オブジェクト | メッセージデータの内容 |
message.data.metadata | オブジェクト | メッセージに関する追加メタデータ |
message.data.metadata.sender | オブジェクト | メッセージ送信者に関する情報 |
message.data.id | テキスト | メッセージデータの一意識別子 |
message.data.text | テキスト | メッセージのテキスト内容 |
message.data.type | テキスト | メッセージデータの種類 |
message.sender | オブジェクト | メッセージ送信者に関する情報 |
message.sender.name | テキスト | 送信者名 |
message.sender.id | テキスト | 送信者の一意識別子 |
message.sender.type | テキスト | 送信者の種類(例:enduser) |
message.sender.picture | テキスト | 送信者のプロフィール画像URL |
message.created | テキスト | メッセージが作成されたタイムスタンプ |
message.isFirstMessage | はい / いいえ | 会話内の最初のメッセージかどうか |
enduser | 任意 | |
enduser.id | テキスト | エンドユーザーの一意識別子 |
enduser.recurrent | はい / いいえ | エンドユーザーが再来かどうか |
team | 任意 | |
team.id | テキスト | チームの一意識別子 |
assignee | 任意 | |
assignee.id | テキスト | 担当者の一意識別子 |
アクション
このノードが実行できる処理です。ステップを追加 からノードを追加し、アクションを選びます。
会話一覧
すべての会話一覧を取得する
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ステータス | 選択 | はい | 会話のステータス 選択肢: 新規, 対応中, まとめ中, 完了 |
| チームID | テキスト | 会話のチームID | |
| 割り当て済み | はい / いいえ | 会話が担当者に割り当てられているかどうか | |
| 1ページあたり | 数値 | はい | 1ページあたりの取得件数 既定値: 20 |
| 次へ | テキスト | 次ページ取得用のカーソル |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data[0].id は $.<ステップID>.output.data[0].id です。
{
"data": [
{
"id": "string",
"name": "string",
"status": "new",
"teamId": "string",
"enduser": {
"id": "string",
"name": "string",
"platform": "line",
"picture": "string"
},
"enduserId": "string",
"assigneeId": "string",
"ocsChannel": "string",
"integrationId": "string",
"unread": false,
"orgId": "string",
"created": "string",
"platform": {},
"fromChatbot": false,
"isNewConversation": false,
"team": {
"id": "string",
"name": "string"
},
"assignee": {
"id": "string",
"name": "string"
},
"isBookmark": false
}
],
"pagination": {
"perPage": 0,
"next": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data[] | リスト | 項目の配列 |
data[].id | テキスト | 会話の一意識別子 |
data[].name | テキスト | 会話名 |
data[].status | テキスト | 会話の現在のステータス(例:new) |
data[].teamId | テキスト | 会話を担当するチームのID |
data[].enduser | オブジェクト | エンドユーザーに関する情報 |
data[].enduser.id | テキスト | エンドユーザーの一意識別子 |
data[].enduser.name | テキスト | エンドユーザー名 |
data[].enduser.platform | テキスト | エンドユーザーが利用しているプラットフォーム(例:LINE) |
data[].enduser.picture | テキスト | エンドユーザーのプロフィール画像URL |
data[].enduserId | テキスト | エンドユーザーのID |
data[].assigneeId | テキスト | 会話に割り当てられたメンバーのID |
data[].ocsChannel | テキスト | OCS のチャンネル識別子 |
data[].integrationId | テキスト | 利用中のインテグレーションID |
data[].unread | はい / いいえ | 未読メッセージがあるかどうか |
data[].orgId | テキスト | 組織のID |
data[].created | テキスト | 会話が作成されたタイムスタンプ |
data[].platform | 任意 | |
data[].platform.name | テキスト | プラットフォーム名 |
data[].platform.channelId | テキスト | チャンネルのID |
data[].platform.channelName | テキスト | チャンネル名 |
data[].fromChatbot | はい / いいえ | 会話がチャットボットにより開始されたかどうか |
data[].isNewConversation | はい / いいえ | 新規の会話かどうか |
data[].team | オブジェクト | チームに関する情報 |
data[].team.id | テキスト | チームのID |
data[].team.name | テキスト | チーム名 |
data[].assignee | オブジェクト | 担当者に関する情報 |
data[].assignee.id | テキスト | 担当者のID |
data[].assignee.name | テキスト | 担当者名 |
data[].isBookmark | はい / いいえ | 会話がブックマークされているかどうか |
pagination | オブジェクト | ページネーション情報 |
pagination.perPage | 数値 | 1ページあたりの項目数 |
pagination.next | テキスト | 次ページ取得用のカーソル |
会話ステータスを更新
会話のステータスを更新する
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | 更新する会話のID |
| ステータス | 選択 | はい | 会話のステータス 選択肢: まとめ中, 完了 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"name": "string",
"status": "new",
"teamId": "string",
"enduser": {
"id": "string",
"name": "string",
"platform": "line",
"picture": "string"
},
"enduserId": "string",
"assigneeId": "string",
"ocsChannel": "string",
"integrationId": "string",
"unread": false,
"orgId": "string",
"created": "string",
"platform": {},
"fromChatbot": false,
"isNewConversation": false,
"team": {
"id": "string",
"name": "string"
},
"assignee": {
"id": "string",
"name": "string"
},
"isBookmark": false
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 会話の一意識別子 |
name | テキスト | 会話名 |
status | テキスト | 会話の現在のステータス(例:new) |
teamId | テキスト | 会話を担当するチームのID |
enduser | オブジェクト | エンドユーザーに関する情報 |
enduser.id | テキスト | エンドユーザーの一意識別子 |
enduser.name | テキスト | エンドユーザー名 |
enduser.platform | テキスト | エンドユーザーが利用しているプラットフォーム(例:LINE) |
enduser.picture | テキスト | エンドユーザーのプロフィール画像URL |
enduserId | テキスト | エンドユーザーのID |
assigneeId | テキスト | 会話に割り当てられたメンバーのID |
ocsChannel | テキスト | OCS のチャンネル識別子 |
integrationId | テキスト | 利用中のインテグレーションID |
unread | はい / いいえ | 未読メッセージがあるかどうか |
orgId | テキスト | 組織のID |
created | テキスト | 会話が作成されたタイムスタンプ |
platform | 任意 | |
platform.name | テキスト | プラットフォーム名 |
platform.channelId | テキスト | チャンネルのID |
platform.channelName | テキスト | チャンネル名 |
fromChatbot | はい / いいえ | 会話がチャットボットにより開始されたかどうか |
isNewConversation | はい / いいえ | 新規の会話かどうか |
team | オブジェクト | チームに関する情報 |
team.id | テキスト | チームのID |
team.name | テキスト | チーム名 |
assignee | オブジェクト | 担当者に関する情報 |
assignee.id | テキスト | 担当者のID |
assignee.name | テキスト | 担当者名 |
isBookmark | はい / いいえ | 会話がブックマークされているかどうか |
会話メモを追加
会話にメモを追加する
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | メモを追加する会話のID |
| メモ | テキスト | はい | 会話のメモ |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば status は $.<ステップID>.output.status です。
{
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
status | テキスト | DECA Livechat APIが更新を受け付けた場合は "success" |
会話メモを更新
会話のメモを更新する
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | 更新する会話のID |
| メモID | テキスト | はい | 更新するメモのID |
| メモ | テキスト | はい | 会話のメモ |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば status は $.<ステップID>.output.status です。
{
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
status | テキスト | DECA Livechat APIが更新を受け付けた場合は "success" |
会話メッセージを取得
会話内のすべてのメッセージを取得する
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | メッセージを取得する会話のID |
| アクティビティを含める | はい / いいえ | レスポンスにアクティビティメッセージを含めるかどうか | |
| 1ページあたり | 数値 | はい | 1ページあたりの取得件数 既定値: 20 |
| 次へ | テキスト | 次ページ取得用のカーソル |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data[0].id は $.<ステップID>.output.data[0].id です。
{
"data": [
{
"id": "string",
"from": "user",
"conversationId": "string",
"type": "text",
"data": {
"metadata": {},
"id": "string",
"text": "string",
"type": "string"
},
"sender": {
"name": "string",
"id": "string",
"type": "enduser",
"picture": "string"
},
"created": "string",
"isFirstMessage": false
}
],
"pagination": {
"perPage": 0,
"next": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data[] | リスト | 項目の配列 |
data[].id | テキスト | メッセージの一意識別子 |
data[].from | テキスト | メッセージの送信元(例:ユーザー、ボット) |
data[].conversationId | テキスト | このメッセージが属する会話のID |
data[].type | テキスト | メッセージの種類(例:text) |
data[].data | オブジェクト | メッセージデータの内容 |
data[].data.metadata | オブジェクト | メッセージに関する追加メタデータ |
data[].data.metadata.sender | オブジェクト | メッセージ送信者に関する情報 |
data[].data.id | テキスト | メッセージデータの一意識別子 |
data[].data.text | テキスト | メッセージのテキスト内容 |
data[].data.type | テキスト | メッセージデータの種類 |
data[].sender | オブジェクト | メッセージ送信者に関する情報 |
data[].sender.name | テキスト | 送信者名 |
data[].sender.id | テキスト | 送信者の一意識別子 |
data[].sender.type | テキスト | 送信者の種類(例:enduser) |
data[].sender.picture | テキスト | 送信者のプロフィール画像URL |
data[].created | テキスト | メッセージが作成されたタイムスタンプ |
data[].isFirstMessage | はい / いいえ | 会話内の最初のメッセージかどうか |
pagination | オブジェクト | ページネーション情報 |
pagination.perPage | 数値 | 1ページあたりの項目数 |
pagination.next | テキスト | 次ページ取得用のカーソル |
テキストメッセージ送信
会話にテキストメッセージを送信する
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | メッセージを送信する会話のID |
| メッセージ | テキスト | はい | 送信するテキストメッセージ |
出力
出力フィールドの定義はありません。
画像付きメッセージ送信
会話に画像付きメッセージを送信する
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | メッセージを送信する会話のID |
| 画像ソース | 選択 | はい | 画像の取得元 選択肢: URL, ファイル既定値: url |
| 画像ファイル | ファイル | はい | 送信する画像ファイル(PNGまたはJPEG) |
| 画像URL | テキスト | 元画像のURL |
出力
出力フィールドの定義はありません。
会話詳細を取得
会話の詳細を取得する
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | 詳細を取得する会話のID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"name": "string",
"status": "new",
"teamId": "string",
"enduser": {
"id": "string",
"name": "string",
"platform": "line",
"picture": "string"
},
"enduserId": "string",
"assigneeId": "string",
"ocsChannel": "string",
"integrationId": "string",
"unread": false,
"orgId": "string",
"created": "string",
"platform": {},
"fromChatbot": false,
"isNewConversation": false,
"team": {
"id": "string",
"name": "string"
},
"assignee": {
"id": "string",
"name": "string"
},
"isBookmark": false
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 会話の一意識別子 |
name | テキスト | 会話名 |
status | テキスト | 会話の現在のステータス(例:new) |
teamId | テキスト | 会話を担当するチームのID |
enduser | オブジェクト | エンドユーザーに関する情報 |
enduser.id | テキスト | エンドユーザーの一意識別子 |
enduser.name | テキスト | エンドユーザー名 |
enduser.platform | テキスト | エンドユーザーが利用しているプラットフォーム(例:LINE) |
enduser.picture | テキスト | エンドユーザーのプロフィール画像URL |
enduserId | テキスト | エンドユーザーのID |
assigneeId | テキスト | 会話に割り当てられたメンバーのID |
ocsChannel | テキスト | OCS のチャンネル識別子 |
integrationId | テキスト | 利用中のインテグレーションID |
unread | はい / いいえ | 未読メッセージがあるかどうか |
orgId | テキスト | 組織のID |
created | テキスト | 会話が作成されたタイムスタンプ |
platform | 任意 | |
platform.name | テキスト | プラットフォーム名 |
platform.channelId | テキスト | チャンネルのID |
platform.channelName | テキスト | チャンネル名 |
fromChatbot | はい / いいえ | 会話がチャットボットにより開始されたかどうか |
isNewConversation | はい / いいえ | 新規の会話かどうか |
team | オブジェクト | チームに関する情報 |
team.id | テキスト | チームのID |
team.name | テキスト | チーム名 |
assignee | オブジェクト | 担当者に関する情報 |
assignee.id | テキスト | 担当者のID |
assignee.name | テキスト | 担当者名 |
isBookmark | はい / いいえ | 会話がブックマークされているかどうか |
チーム に割り当て
割り当てルールを使用して会話をチームに割り当てる
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | 割り当てる会話のID |
| チーム | 選択(アカウントから読み込み) | はい | 会話を割り当てるチーム |
| 割り当て方法 | 選択 | はい | 選択したチーム内でのオペレーターの選び方 選択肢: ラウンドロビン, ランダム, 最もアクティブでない会話, 最長アイドル時間, 未指定既定値: no_specified |
| エージェント 1 人あたりの問い合わせ数 | はい / いいえ | 対応件数を制限 既定値: false | |
| 上限 | 数値 | エージェント 1 人あたりの最大オープン会話数 既定値: 1 | |
| 保留中の会話の割り当てを優先 | はい / いいえ | 新しい会話が作成されたら、未割り当ての保留中の会話を優先的に割り当てます 既定値: false |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば status は $.<ステップID>.output.status です。
{
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
status | テキスト | ハンドラーの完了ステータス。success はハンドラーが完了したことを意味し、割り当てが成功したことを意味するものではありません。 |
担当者に割り当て
選択したチーム内の特定のオペレーターに会話を割り当てる
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | 割り当てる会話のID |
| チーム | 選択(アカウントから読み込み) | はい | オペレーターの一覧表示に使用するチーム |
| 担当者 | 選択(アカウントから読み込み) | はい | 会話を割り当てるオペレーター |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば status は $.<ステップID>.output.status です。
{
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
status | テキスト | ハンドラーの完了ステータス。success はハンドラーが終了したことを意味し、割り当ての成功を意味するものではありません。 |
前の担当者に再割り当て
会話を前の担当者に再割り当てします。
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | 割り当てる会話のID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば status は $.<ステップID>.output.status です。
{
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
status | テキスト | ハンドラーの完了ステータス。success はハンドラーが終了したことを意味し、割り当ての成功を意味するものではありません。 |
Webhookに送信
ダイナミック リストから選択された Webhook インテグレーションに会話を送信する
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 会話ID | テキスト | はい | 送信する会話のID |
| Webhook 統合 | 選択(アカウントから読み込み) | はい | 会話を送信する Webhook の統合 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"name": "string",
"status": "new",
"teamId": "string",
"enduser": {
"id": "string",
"name": "string",
"platform": "line",
"picture": "string"
},
"enduserId": "string",
"assigneeId": "string",
"ocsChannel": "string",
"integrationId": "string",
"unread": false,
"orgId": "string",
"created": "string",
"platform": {},
"fromChatbot": false,
"isNewConversation": false,
"team": {
"id": "string",
"name": "string"
},
"assignee": {
"id": "string",
"name": "string"
},
"isBookmark": false
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 会話の一意識別子 |
name | テキスト | 会話名 |
status | テキスト | 会話の現在のステータス(例:new) |
teamId | テキスト | 会話を担当するチームのID |
enduser | オブジェクト | エンドユーザーに関する情報 |
enduser.id | テキスト | エンドユーザーの一意識別子 |
enduser.name | テキスト | エンドユーザー名 |
enduser.platform | テキスト | エンドユーザーが利用しているプラットフォーム(例:LINE) |
enduser.picture | テキスト | エンドユーザーのプロフィール画像URL |
enduserId | テキスト | エンドユーザーのID |
assigneeId | テキスト | 会話に割り当てられたメンバーのID |
ocsChannel | テキスト | OCS のチャンネル識別子 |
integrationId | テキスト | 利用中のインテグレーションID |
unread | はい / いいえ | 未読メッセージがあるかどうか |
orgId | テキスト | 組織のID |
created | テキスト | 会話が作成されたタイムスタンプ |
platform | 任意 | |
platform.name | テキスト | プラットフォーム名 |
platform.channelId | テキスト | チャンネルのID |
platform.channelName | テキスト | チャンネル名 |
fromChatbot | はい / いいえ | 会話がチャットボットにより開始されたかどうか |
isNewConversation | はい / いいえ | 新規の会話かどうか |
team | オブジェクト | チームに関する情報 |
team.id | テキスト | チームのID |
team.name | テキスト | チーム名 |
assignee | オブジェクト | 担当者に関する情報 |
assignee.id | テキスト | 担当者のID |
assignee.name | テキスト | 担当者名 |
isBookmark | はい / いいえ | 会話がブックマークされているかどうか |