句子 Insight

点赞踩回调

开发中

POST

/v1/bot-message/feedback

此接口为点赞踩的回调接口，当系统内发生点赞点踩的动作时，会回调对应的数据，包括了点赞踩发生的消息相关的数据，以及对应的触发器内容，最终生成的动作数据等

请求参数

Body 参数application/json

botId

string

机器人 ID

必需

系统内配置的 AI 机器人的 ID

sessionId

string

会话 ID

必需

当前消息发生的会话的 ID

execId

string

流程执行 ID

必需

当前赞踩发生的对应的流程引擎执行 ID

triggerEvent

object

触发事件

必需

触发器详细数据

triggerType

enum<string>

触发器类型

必需

枚举值:

receive-text-messagereceive-image-messagereceive-audio-messagereceive-video-messagereceive-other-messagetag-eventjoin-roomnew-friendcanvas-event-triggerbot-receive-text-message

sessionId

string

会话 ID

必需

当前消息发生的会话的 ID

receiveTextMessage

object

接收文本消息事件

可选

receiveImageMessage

object

接收图片消息

可选

receiveAudioMessage

object

接收语音消息

可选

receiveVideoMessage

object

接收视频消息

可选

receiveOtherMessage

object

接收其他消息

可选

history

array [object {2}]

聊天历史数据

可选

触发器传入的聊天历史数据，如果不传这个数据，则系统会使用系统内缓存的数据

outputActions

array [object {4}]

必需

type

enum<string>

必需

枚举值:

send-text-messagesend-post-messagesend-file-messagesend-image-messagesend-audio-messagetag-userinvite-roomcanvas-event-actionupdate-datahandoverplugin-action

status

string

可选

payload

可选

nodeId

string

可选

feedbackStatus

enum<string>

赞踩状态

必需

枚举值:

nonethumb-upthumb-down

feedback

string

评论内容

可选

仅当点踩的时候此字段要求用户填写，才可能会有值

receiverId

string

接收者 ID

可选

对应了流程引擎中接收消息内的 receiverId 的值

contactId

string

联系人 ID

可选

当接收到私聊的消息时会有值，对应了流程引擎中接收消息触发器的 contactId 的值

roomId

string

群聊ID

可选

当接收到群聊消息的时候会有值，对应了流程引擎中接受消息触发器的 roomId 的值

示例

{
  botId: "f7bb8f07-dc5c-416b-88d4-c1568f923857",
  sessionId: "20950312-c744-4e5d-8ac9-e4de6a1bed03",
  execId: "22b35345-f433-4f2a-b91f-7c71b7fd931b",
  triggerEvent: {
    triggerType: "receive-text-message",
    sessionId: "20950312-c744-4e5d-8ac9-e4de6a1bed03",
    receiveTextMessage: {
      text: "hi",
      role: "user",
    },
    history: [
      {
        content: [
          {
            type: "text",
            text: "hi",
          },
        ],
        role: "user",
      },
    ],
  },
  outputActions: [
    {
      type: "send-text-message",
      status: "send",
      payload: {
        text: "回复消息：\n\n\n\n发送人昵称：",
      },
      nodeId: "0ecd34f2-bdfa-43bb-a9ab-8acfcaf67528",
    },
  ],
  feedbackStatus: "none",
  feedback: undefined,
  messageId: undefined,
  receiverId: undefined,
  contactId: undefined,
  roomId: undefined,
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://insight.juzibot.com/v1/bot-message/feedback' \
--header 'Content-Type: application/json' \
--data-raw '{
  botId: "f7bb8f07-dc5c-416b-88d4-c1568f923857",
  sessionId: "20950312-c744-4e5d-8ac9-e4de6a1bed03",
  execId: "22b35345-f433-4f2a-b91f-7c71b7fd931b",
  triggerEvent: {
    triggerType: "receive-text-message",
    sessionId: "20950312-c744-4e5d-8ac9-e4de6a1bed03",
    receiveTextMessage: {
      text: "hi",
      role: "user",
    },
    history: [
      {
        content: [
          {
            type: "text",
            text: "hi",
          },
        ],
        role: "user",
      },
    ],
  },
  outputActions: [
    {
      type: "send-text-message",
      status: "send",
      payload: {
        text: "回复消息：\n\n\n\n发送人昵称：",
      },
      nodeId: "0ecd34f2-bdfa-43bb-a9ab-8acfcaf67528",
    },
  ],
  feedbackStatus: "none",
  feedback: undefined,
  messageId: undefined,
  receiverId: undefined,
  contactId: undefined,
  roomId: undefined,
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

回调接口

获取 access token