接收第三方发送的数据API

开始使用前,请先创建应用,申请“thirdparty-customer-service” scope,并成功完成审批

接口描述

  • 第三方系统异步发送数据给机器人,数据类型包括文本,图片,文件,用于第三方发送给用户数据的展示;数据类型为开始结束事件,用来标识机器人对接第三方系统开始;数据类型为评价消息,用来展示给用户评价链接

请求

POST http://apigate.hsifue.cn/chatbot/servlet/third/msg/receive

请求的header参数

参数 参数类型 是否必传 示例值 描述
Authorization 字符串 Bearer cn-236f6e4f-6db5-46c2-97ec-19b4f5d499d3 从用户中心获取的ACCESS_TOKEN

请求的param参数

参数 参数类型 是否必传 示例值 描述
source 整数 1 1为佳信,不传默认为1

请求的body参数

	说明:touser为chatid,fromuser在连接客服之前为固定的【系统消息】,连接成功后为客服名字

	事件begin
    {
		"touser": "561f7439-9ace-4ba7-8121-bbbb3e1e96a",
		"fromuser": "系统消息",
		"msgtype":"event",
		"eventType":"begin"
	}
	
	事件end
	{
		"touser": "561f7439-9ace-4ba7-8121-bbbb3e1e96a",
		"msgtype":"event",
		"eventType":"end"
	}
	
	评价
	{
		"touser": "561f7439-9ace-4ba7-8121-bbbb3e1e96a",
		"msgtype":"evaluate",
		"url":"http://gkf-test.hsifue.cn:22601/prod/satisfysPage.html?orgName=czc0zjf1ewvyzw&appName=gld600&suborgId=czc0zjf1ewvyzw&sessionID=wroogj2470&username=698d51a19d8a121ce581499d7b701668&env=prod&workgroupId=gxetest"
	}
	
	
	文本
	{
		"touser": "561f7439-9ace-4ba7-8121-bbbb3e1e96a",
		"fromuser": "客服A",
		"msgtype":"text",
		"text":{
			"content":"内容A"
		}
	}
	
	图片
	{
		"touser": "561f7439-9ace-4ba7-8121-bbbb3e1e96a",
		"fromuser": "客服A",
		"msgtype":"image",
		"image":{
			"image_url":"http://gkf-test.hsifue.cn:21501/oss/download/czc0zjf1ewvyzw/mcs/2020/5/20/99521780-1a6b-457b-96e6-33d330b4470http://aecore.hsifue.cn/sp-doc/chatbot/fcaba2a1d5cc4dd3b41ff78f15074843_8.png?bucket=jxfiles&name=0%2Epng&type=1000&contentType=image/png"
		}
	}
	
	文件
	{
		"touser": "561f7439-9ace-4ba7-8121-bbbb3e1e96a",
		"fromuser": "客服A",
		"msgtype":"file",
		"file":{
			"file_name":"建文本文档.txt",
			"file_url":"http://gkf-test.hsifue.cn:21501/oss/download/czc0zjf1ewvyzw/mcs/2020/5/20/a62c3d84-06c1-4e34-9b29-f5dfadf731f8.txt?bucket=jxfiles&name=%E6%96%B0%E5%BB%BA%E6%96%87%E6%9C%AC%E6%96%87%E6%A1%A3%2Etxt&type=1001&contentType=application/octet-stream"
		}
	}
	
	

请求成功返回的数据示例

    {
        "status": 0,
		"message": "ok"
    }

请求失败返回的数据示例


{ "status": -1, "errcode": error, "message": "token is wrong" }