开发者构建 webhook 服务

开发者选择 webhook 作为人工服务接入方式时，首先需要在自己的服务器环境构建一个 Webhook 接收服务，提供以下3个接口用于接收 Bot 发起的人工服务请求和接收消息。

创建会话ID

用于为 Bot 用户创建一个人工客服对话ID

请求方式

POST

调用地址

https://your_domain/conversation/establish

请求参数

参数	类型	说明
conversation_id	string	会话id，在客服回复接口需要透传给 GPTBots
timestamp	long	时间戳
email	string	客户邮箱
bot_id	string	bot的id
body	list	消息体
body.message_type	string	消息类型，QUESTION/ANSWER
body.text	string	客户发起人工客服的问题以及上下文

响应

参数	类型	说明
code	int	响应码
message	string	详情

聊天接口

Bot 用户向人工客服发送消息

请求方式

POST

调用地址

https://your_domain/chat

请求参数

参数	类型	说明
conversation_id	string	对话ID，在客服回复接口需要透传给 GPTBots
timestamp	long	时间戳
body	string	客户的问题

响应

参数	类型	说明
code	int	响应码
message	string	详情

关闭会话接口

用户对话超时或者 Bot 用户主动关闭对话时触发

请求方式

POST

调用地址

https://your_domain/conversation/close

请求参数

参数	类型	说明
conversation_id	string	对话ID，在客服回复接口需要透传给 GPTBots
timestamp	long	时间戳
type	string	关闭的类型、TIMEOUT（超时关闭）/ USER_CLOSED(用户主动关闭)

响应

参数	类型	说明
code	int	响应码，
message	string	详情

GPTBots 人工客服接口

开发者选择 webhook 作为人工服务接入方式时，GPTBots 提供的用于接收开发者发送的人工客服回复消息和对话控制指令的 API 接口

接收客服消息

用于接收开发者端人工客服的回复消息，并消息内容将展示在Bot对话窗口。

请求方式

POST

调用地址

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

请求参数

参数	类型	说明	required
conversation_id	string	对话ID，在对话创建接口和聊天接口有传，透传即可	true
timestamp	long	时间戳	true
body	string	人工客服的回复内容	true

响应

参数	类型	说明
code	int	响应码，
message	string	详情

人工客服关闭会话

人工客服在需要时可以选择主动关闭对话，关闭后用户将不能再接收到客服的消息，除非用户重新发起人工客服对话。

请求方式

POST

调用地址

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

请求参数

参数	类型	说明
conversation_id	string	对话 ID，在客服回复接口需要透传给 GPTBots
timestamp	long	时间戳

响应

参数	类型	说明	required
conversation_id	string	对话ID，在会话创建接口和聊天接口有传，透传即可	true
timestamp	long	时间戳	trueß