人工服务

当开发者选择Webhook 作为人工服务接入方式时，首先需要在自己的服务器环境构建一个 Webhook 服务，开发者需要按规范提供以下3个接口用于接收人工服务请求、接收用户消息和人工客服回复消息。GPTBots 同时提供了2个接口用于接收客服回复消息和对话关闭指令。

注意事项：

1. 开发者应确保 Webhook 服务正常可用，否则会影响人工服务的正常使用。

• 若发起人工服务后显示“正忙”，代表开发者的 Webhook 服务异常。
• 若发起人工服务后显示“正在连接”，代表开发者的 Webhook 服务正常。

2. 当成功发起人工服务请求后，

• 开发者需要及时调用回复用户消息接口(https://api.gptbots.ai/v1/human/message/receive)回复用户1条消息，方可成功建立对话连接。
• 开发者若未回复用户消息，超过所设置的等待超时时长（默认60S）后，人工对话会自动结束。

接收人工服务对话请求通知

当终端用户发起人工服务请求时，GPTBots将该请求透传给开发者的 Webhook 服务，开发者接口服务返回200则代表创建人工服务成功。

请求方式

POST

调用地址

https://your_domain/conversation/establish

请求示例

                      
                      curl -X POST 'https://YOUR_DOMAIN/human/service/conversation/establish' \
-H "Content-Type: application/json" \
-d '{
  "body": [
    {
      "text": "human service",
      "message_type": "QUESTION"
    },
    {
      "text": "content",
      "message_type": "ANSWER"
    }
  ],
  "timestamp": 1742265090895,
  "email": "bob@gmail.com",
  "conversation_id": "67d8db020fa31d1ef64f53dg",
  "bot_id": "665d88b03ce2b13cf2d573454",
  "user_info": {
    "phone": null,
    "email": "bob@gmail.com",
    "user_id": "KDslas",
    "anonymous_id": "652face5184b30540a6ea7fe"
  }
}'

                    

注意：该请求体中的conversation_id 仅用于标识人工服务对话场景的惟一ID，区别于 创建对话ID 为Agent对话场景所生成的惟一ID。

请求头

请求参数

email 字段使用注意事项：

• 通过 iframe/Share/Bubble Widget 方式发起人工服务时，用户必须填写用户邮箱.也同时允许开发者自定义用户邮箱从而避免用户填写邮箱。
• 通过 WhatsApp/Telegram/livechat 等三方平台请求人工服务时，默认使用 support@gptbots.ai作为用户邮箱，其中livechat支持开发者自定义用户邮箱。
• 通过 API 请求人工服务时，允许 email 字段为空，为空时默认使用 support@gptbots.ai 作为用户邮箱。

响应

聊天接口

通过创建的conversation_id，将用户的消息发送给人工客服。

请求方式

POST

调用地址

https://your_domain/chat

请求参数

响应

关闭会话接口

用户对话超时或者 Agent 用户主动关闭对话时，调用此接口关闭会话

请求方式

POST

调用地址

https://your_domain/conversation/close

请求参数

响应

回复用户消息

开发者选择webhook作为人工服务接入方式时，GPTBots 提供用于回复用户消息的接口，可将人工客服所发送的消息内容发送给用户。

请求方式

POST

调用地址

https://api.gptbots.ai/v1/human/message/receive

请求参数

响应

人工客服关闭会话

开发者选择webhook作为人工服务接入方式时，GPTBots 提供的人工客服在需要时可以选择主动关闭对话的接口，关闭后用户将不能再接收到客服的消息，除非用户重新发起人工客服对话。

请求方式

POST

调用地址

https://api.gptbots.ai/v1/human/close

请求参数

响应