API接口开通方法

Hi，开发者您好，欢迎使用小文AI开放平台。
以下内容，是您接入服务的一些基本介绍，希望您能够在这里找到适合您业务的AI技术能力，感谢您的使用！

1. 注册成为开发者
点击网站右上角注册按钮，选择账户类型，填写企业名称，联系人等信息，注册小文AI账户。





2. 获取密钥
注册成功后，平台将会分配给您appkey，点击右上角"我的账户"查看，请您妥善保管。





3. 启动开发
目前AI产品主要方式使用：API，您可以选择各产品的文档，查看具体使用方法及参数。
聊天(自动回复) | 标准分词 | 词性标准 | 敏感词识别 | 地名识别 | 中文人名识别 | 情感分析 | 情绪分析 等

Chat问答类接口（对话API-自动回复）

概述：
       实现智能客服机器人问答服务，根据所需参数，提交到机器人即可自动返回相应的回复。

接口调用方式：
       实现方式：调用Http 服务，提交数据采用POST方式，编码格式采用UTF-8编码。接口为同步调用方式，同步调用方式客户端发起请求后服务器端在同一次请求中返回相应结果。POST 参数需要转成 JSON格式，不支持 form 表单提交。

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/robotIfdp

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
threadId string 会话id 必填
userId string 用户id 必填
robotHashCode string 机器人id 默认0 必填
platformConnType string 渠道编号 默认0 必填
receiverId string 版本编号 默认2.0 必填
sendTime string 提问时间,格式为:"yyyy-MM-dd HH:mm:ss" 必填
content string 问题内容 必填
process string 0:流程托管、1:重置流程 默认0 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
	"threadId":"5978",
	"userId":"", 
	"robotHashCode":"0",
	"platformConnType":"0",
	"receiverId":"2.0",
	"sendTime":"",
	"content":"奥迪",
	"process":"0"
}


返回值：
字段 类型 说明 是否必填
result string 返回状态[success：成功、error：失败] 必填
returnTime string 返回时间（yyyy-MM-dd HH:mm:ss） 必填
process string 流程状态[0：非流程、1：流程中] 选填
data jsonarray 返回数据包，可返回多条消息 选填

data块jsonobject字段说明
字段 类型 说明 是否必填
msgType int 消息类型[0：机器人返回、1：系统消息] 必填
msgContents jsonarray 消息体数据包，消息体可由多段组成 选填
rmdWords string 推荐词 选填
repeatMsgContents jsonarray 重复会话文本，结构完全同msgContents 选填
recordContent String 自动播放语音文本 选填

msgContents块jsonobject字段说明
字段 类型 说明 是否必填
contentType int 段落类型[0：纯文本、1：超链接、2：图片、3：文件、4：音频、5：视频] 必填
content string 显示文本 选填
linkUrl string 超链接url 选填
imgSrc string 图片路径 选填
filePath string 文件地址 选填
audioPath string 音频地址 选填
videoPath string 视频地址 选填

返回值示例：
成功： 
{
    "result": "success",
    "data": [
        {
            "msgType": 0,
            "msgContents": [
                {
                    "contentType": 0,
                    "content": "您好，我们是一家股票软件公司。"
                },
                {
                    "contentType": 0,
                    "content": "请问方便现在占用几分钟时间，问您几个问题吗？"
                }
            ],
            "repeatMsgContents": [
                {
                    "contentType": 0,
                    "content": "您好，我们是一家股票软件公司。"
                },
                {
                    "contentType": 0,
                    "content": "请问方便现在占用几分钟时间，问您几个问题吗？"
                }
            ],
            "recordContent": "请问方便现在占用几分钟时间，问您几个问题吗？"
        }
    ],
    "returnTime": "2020-06-15 11:52:12"
}


失败： 
{
   "result": "error",
   "returnTime": "2020-06-15 11:21:43"
}

Chat问答类接口（对话API-自定义回复）

概述：
       实现智能客服机器人问答服务，根据所需参数，提交到机器人即可自动返回相应的回复。

接口调用方式：
       实现方式：调用Http 服务，提交数据采用POST方式，编码格式采用UTF-8编码。接口为同步调用方式，同步调用方式客户端发起请求后服务器端在同一次请求中返回相应结果。POST 参数需要转成 JSON格式，不支持 form 表单提交。

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/robotIf

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
threadId string 会话id 必填
userId string 用户id 必填
robotHashCode string 机器人id 默认0 必填
platformConnType string 渠道编号 默认0 必填
receiverId string 版本编号 默认2.0 必填
sendTime string 提问时间,格式为:"yyyy-MM-dd HH:mm:ss" 必填
content string 问题内容 必填
typeId string 0默认流程,1,多轮对话-脚本场景,2,多轮对话-方案场景,3关闭主动推荐. 默认0 必填
scene jsonobject typeId=1或者typeId=2时必填 选填

scene块字段说明
字段 类型 说明 是否必填
wj_id string 必填
title_id string 默认0 必填
wj_name string 脚本名称 选填
wj_result string 上一个脚本返回结果 选填
is_support_robot string 是否查询所有预加载资料,0查询预加载资料,1查询数据库中的预加载资料.默认0 选填
custom_will string 客户意向 默认空 选填
filename string 预加载资料文件地址,默认空 选填
corpuswordid string 预加载资料id,默认空 选填
rebotId string 脚本对应机器人id,默认0 选填
tid string 方案场景对应规则id,默认空 选填
cid string 客户id 选填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
	"threadId":"5978",
	"userId":"", 
	"robotHashCode":"0",
	"platformConnType":"0",
	"receiverId":"2.0",
	"sendTime":"",
	"content":"奥迪",
	"typeId":"1",
	"scene":{ 
		"wj_id":"136",
		"title_id":"0",
		"wj_name":"",
		"wj_result":"",
		"is_support_robot":"",
		"custom_will":"",
		"filename":"",
		"corpuswordid":"",
		"rebotId":"",
		"tid":"",
		"cid":""
	}
}


返回值：
字段 类型 说明 是否必填
result string 返回状态[success：成功、error：失败] 必填
returnTime string 返回时间（yyyy-MM-dd HH:mm:ss） 必填
data jsonarray 返回数据包，可返回多条消息 选填

data块jsonobject字段说明
字段 类型 说明 是否必填
msgType int 消息类型[0：机器人返回、1：系统消息] 必填
msgContents jsonarray 消息体数据包，消息体可由多段组成 选填
rmdWords string 推荐词 选填
repeatMsgContents jsonarray 重复会话文本，结构完全同msgContents 选填
recordContent String 自动播放语音文本 选填

msgContents块jsonobject字段说明
字段 类型 说明 是否必填
contentType int 段落类型[0：纯文本、1：超链接、2：图片、3：文件、4：音频、5：视频] 必填
content string 显示文本 选填
linkUrl string 超链接url 选填
imgSrc string 图片路径 选填
filePath string 文件地址 选填
audioPath string 音频地址 选填
videoPath string 视频地址 选填

返回值示例：
成功： 
{
    "result": "success",
    "data": [
        {
            "msgType": 0,
            "msgContents": [
                {
                    "contentType": 0,
                    "content": "您好，我们是一家股票软件公司。"
                },
                {
                    "contentType": 0,
                    "content": "请问方便现在占用几分钟时间，问您几个问题吗？"
                }
            ],
            "repeatMsgContents": [
                {
                    "contentType": 0,
                    "content": "您好，我们是一家股票软件公司。"
                },
                {
                    "contentType": 0,
                    "content": "请问方便现在占用几分钟时间，问您几个问题吗？"
                }
            ],
            "recordContent": "请问方便现在占用几分钟时间，问您几个问题吗？"
        }
    ],
    "returnTime": "2020-06-15 11:52:12"
}


失败： 
{
    "result": "error",
    "returnTime": "2020-06-15 11:21:43"
}

标准分词

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_SP

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
words string 分词结果
id string 编号
content string 内容

返回值示例： 
{
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
            "words": "一组, 杨, 紫, 曦, 李, 沁, 张, 檬, 蒋, 梦, 婕, 手机, 合影, 照片, 曝光, 片中, 四人, 十分, 青涩, 面带笑容, 化, 淡妆, 打扮, 清纯, 如今, 对比, 气质, 变化, 很大, 北京, 朝阳区, 英, 花路, 301号, 日报社"
        }
    ]
}

词性标注

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_POST

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
nshortarray string 词性识别
id string 编号
content string 内容

返回值示例： 
{
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
            "nshortarray": [
                {
                    "keywordsanal": "一组",
                    "workpro2": "nt"
                },
                {
                    "keywordsanal": "杨紫曦",
                    "workpro2": "nr"
                },
                {
                    "keywordsanal": "、",
                    "workpro2": "w"
                },
                {
                    "keywordsanal": "李沁",
                    "workpro2": "nr"
                },
                {
                    "keywordsanal": "、",
                    "workpro2": "w"
                },
                {
                    "keywordsanal": "张檬",
                    "workpro2": "nr"
                },
                {
                    "keywordsanal": "、",
                    "workpro2": "w"
                },
                {
                    "keywordsanal": "蒋梦婕",
                    "workpro2": "nr"
                },
                {
                    "keywordsanal": "的",
                    "workpro2": "uj"
                },
                {
                    "keywordsanal": "手机",
                    "workpro2": "n"
                },
                {
                    "keywordsanal": "合影",
                    "workpro2": "v"
                },
                {
                    "keywordsanal": "照片",
                    "workpro2": "n"
                },
                {
                    "keywordsanal": "曝光",
                    "workpro2": "v"
                },
                {
                    "keywordsanal": "。",
                    "workpro2": "w"
                },
                {
                    "keywordsanal": "照片",
                    "workpro2": "n"
                },
                {
                    "keywordsanal": "中",
                    "workpro2": "f"
                },
                {
                    "keywordsanal": "四人",
                    "workpro2": "nt"
                },
                {
                    "keywordsanal": "十分",
                    "workpro2": "d"
                },
                {
                    "keywordsanal": "青涩",
                    "workpro2": "nz"
                },
                {
                    "keywordsanal": "，",
                    "workpro2": "w"
                },
                {
                    "keywordsanal": "面带",
                    "workpro2": "nz"
                },
                {
                    "keywordsanal": "笑容",
                    "workpro2": "n"
                },
                {
                    "keywordsanal": "，",
                    "workpro2": "w"
                },
                {
                    "keywordsanal": "化",
                    "workpro2": "v"
                },
                {
                    "keywordsanal": "着",
                    "workpro2": "uz"
                },
                {
                    "keywordsanal": "淡妆",
                    "workpro2": "n"
                },
                {
                    "keywordsanal": "打扮",
                    "workpro2": "v"
                },
                {
                    "keywordsanal": "清纯",
                    "workpro2": "a"
                },
                {
                    "keywordsanal": "，",
                    "workpro2": "w"
                },
                {
                    "keywordsanal": "与",
                    "workpro2": "p"
                },
                {
                    "keywordsanal": "如今",
                    "workpro2": "t"
                },
                {
                    "keywordsanal": "对比",
                    "workpro2": "v"
                },
                {
                    "keywordsanal": "气质",
                    "workpro2": "n"
                },
                {
                    "keywordsanal": "变化",
                    "workpro2": "vn"
                },
                {
                    "keywordsanal": "很大",
                    "workpro2": "d"
                },
                {
                    "keywordsanal": "。",
                    "workpro2": "w"
                },
                {
                    "keywordsanal": "（",
                    "workpro2": "w"
                },
                {
                    "keywordsanal": "北京",
                    "workpro2": "ns"
                },
                {
                    "keywordsanal": "朝阳区",
                    "workpro2": "ns"
                },
                {
                    "keywordsanal": "英花路",
                    "workpro2": "ns"
                },
                {
                    "keywordsanal": "301号日报社",
                    "workpro2": "nt"
                },
                {
                    "keywordsanal": "）",
                    "workpro2": "w"
                }
            ]
        }
    ]
}

敏感词识别

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_SWR

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
sensitives string 包含的敏感词
id string 编号
content string 内容

返回值示例： 
 {
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
            "sensitives": "[]"
        }
    ]
}

地名识别

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_PNR

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
placelist string 包含的地名
id string 编号
content string 内容

返回值示例： 
{
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
            "placelist": [
                {
                    "place": "北京"
                },
                {
                    "place": "朝阳区"
                }
            ]
        }
    ]
}

中文人名识别

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_CNR

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
namelist string 包含的中文名称
id string 编号
content string 内容

返回值示例： 
{
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
            "namelist": [
                {
                    "name": "杨紫曦"
                },
                {
                    "name": "李沁"
                },
                {
                    "name": "张檬"
                },
                {
                    "name": "蒋梦婕"
                }
            ]
        }
    ]
}

机构识别

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_MI

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
namelist string 包含的中文名称
id string 编号
content string 内容

返回值示例： 
 {
    "result": "success",
    "contents": [
        {
            "organlist": [
                {
                    "organ": "一组"
                },
                {
                    "organ": "四人"
                },
                {
                    "organ": "301号日报社"
                }
            ],
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}

关键词识别

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_KR

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
keywords string 包含的关键词
id string 编号
content string 内容

返回值示例： 
{
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
            "keywords": "照片, 北京, 气质, 如今, 清纯"
        }
    ]
}

近义词识别

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_SR

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
tycarray string 近义词识别
id string 编号
content string 内容

返回值示例： 
{
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
"tycarray": [
                {
                    "word1": "手机",
                    "word2": "电话"
                },
                {
                    "word1": "照",
                    "word2": "动手"
                }
            ]
        }
    ]
}

文本推荐

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_TR

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填
intxt string 推荐文本 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
			"intxt":"微笑"
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
suggest string 包含的推荐文本
id string 编号
content string 内容

返回值示例： 
{
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
"suggest": "面带笑容"
        }
    ]
}

文本短语提取

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_TPE

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
extractarray string 文本短语提取
id string 编号
content string 内容

返回值示例： 
{
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
            "extractarray": [
                {
                    "extract": "中十分"
                },
                {
                    "extract": "化淡妆"
                },
                {
                    "extract": "北京朝阳区"
                },
                {
                    "extract": "十分青涩"
                },
                {
                    "extract": "变化很大"
                }
            ]
        }
    ]
}

自动摘要提取

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_AAE

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
summarys string 自动摘要
id string 编号
content string 内容

返回值示例： 
 {
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0,
            "summarys": [
                {
                    "keywordsanal": "照片中四人十分青涩",
                    "workpro2": "w"
                }
            ]
        }
    ]
}

精准摘要提取

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_PAE

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息
extractsummary string 精准摘要提取

contents块jsonobject字段说明
字段 类型 说明
id string 编号
content string 内容

返回值示例： 
 {
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
],
    "extractsummary": [
        {
            "keywordsanal": "照片中四人十分青涩"
        },
        {
            "keywordsanal": "（北京朝阳区英花路301号日报社）"
        }
    ]
}

情感分析

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_SA

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息
sentiment string 积极情绪的值,范围为[0,100]

contents块jsonobject字段说明
字段 类型 说明
id string 编号
content string 内容

返回值示例： 
 {
	"result": "success",
    "sentiment": 99,
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}

情绪分析

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/aipNlp_EA

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents jsonarray 输入内容 必填

contents块字段说明
字段 类型 说明 是否必填
id string 编号 必填
content string 内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
    ]
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息
emotionarray string 情绪分析 正面情绪optimistic,中性 neutral, 负面情绪pessimistic

contents块jsonobject字段说明
字段 类型 说明
id string 编号
content string 内容

返回值示例： 
 {
    "result": "success",
    "contents": [
        {
            "content": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光。照片中四人十分青涩，面带笑容，化着淡妆打扮清纯，与如今对比气质变化很大。（北京朝阳区英花路301号日报社）",
            "id": 0
        }
	],
    "emotionarray": [
        {
            "words": "一组杨紫曦、李沁、张檬、蒋梦婕的手机合影照片曝光",
            "label": "neutral"
        },
        {
            "words": "照片中四人十分青涩",
            "label": "neutral"
        },
        {
            "words": "面带笑容",
            "label": "neutral"
        },
        {
            "words": "化着淡妆打扮清纯",
            "label": "neutral"
        },
        {
            "words": "与如今对比气质变化很大",
            "label": "neutral"
        },
        {
            "words": "（北京朝阳区英花路301号日报社）",
            "label": "neutral"
        }
    ]
}

知识图谱关系分析

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/cxindex

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
contents string 输入内容 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
    "content":"公司的总经理是刘平"
}


返回值：
字段 类型 说明
result string 返回状态[success：成功、error：失败]
contents jsonarray 返回数据包，可返回多条消息

contents块jsonobject字段说明
字段 类型 说明
nationword string 实体词
nationwordType string 实体词词性
keywords string 输入内容
relativeword string 关系词
relativewordType string 关系词词性
attributive string 属性词
attributiveType string 属性词词性

返回值示例： 
{
    "attributiveType": "nr",
    "nationword": "公司",
    "relativewordType": "n",
    "keywords": "公司的总经理是刘平",
    "nationwordType": "n",
    "attributive": "刘平",
    "relativeword": "总经理"
}

实体维护

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/addNationword

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
keyword string 新增词组 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
	"keyword":"高兴"
}


返回值：
字段 类型 说明
result string 返回状态[0失败,1成功,2重复]

返回值示例： 
{
    "result": "1"
}

关系维护

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/addRelativeword

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
keyword string 新增词组 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
	"keyword":"高兴"
}


返回值：
字段 类型 说明
result string 返回状态[0失败,1成功,2重复]

返回值示例： 
{
    "result": "1"
}

属性维护

接口地址：
       https://www.88qun.cn/robotIfController.ehtm?ehtm_page=/module/setting/addAttributive

参数：
字段 类型 说明 是否必填
appkey string 租户秘钥 必填
keyword string 新增词组 必填

参数示例： 
{
	"appkey":"583c15398867feaa069a800cbcfda1fa",
	"keyword":"高兴"
}


返回值：
字段 类型 说明
result string 返回状态[0失败,1成功,2重复]

返回值示例： 
{
    "result": "1"
}

创建房间

概述：
       创建音视频房间。

接口调用方式：
       请求方法：POST

接口地址：
       https://www.88qun.cn/v2/api/room

参数：
字段 类型 说明 是否必填
channelName string 房间名称 必填
mode int 固定为 2 必填
uid int64 房间创建者的用户 ID，是您的业务系统中的实际用户 ID 必填

参数示例： 
{
    "channelName": "abc",  
    "mode": 2,               
    "uid": 163,               
}


返回值：
字段 类型 说明
code int 状态码
cid int64 房间 ID

返回值示例： 
{ 
    "code": 200,  
    "cid": 12345   
}

查询房间信息

概述：
       查看房间的基本信息，包括房间 ID、房间名称、房间创建者 ID、房间内在线用户总数、房间状态、房间创建时间、房间结束时间。

接口调用方式：
       请求方法：GET

接口地址：
       https://www.88qun.cn/v2/api/room/

参数：
字段 类型 说明
cid int64 房间 ID。该 ID 为 创建房间 接口调用成功后返回的房间 ID。 仅在调用 V2 接口时需要设置。
cname String 房间名称。仅在调用 V3 接口时需要设置。

参数示例：


返回值：
字段 类型 示例 说明
cid int64 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。
cname string netease 房间名称
uid int64 193992653091841 房间创建者的用户 ID
stats int 1 房间状态。包括： 1：初始状态。 2：进行中。 3：正常结束。 4：异常结束。
createtime int64 1513145726 房间创建时间，UTC 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的秒数。
destroytime int64 1513145926 房间结束时间，UTC 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的秒数。

返回值示例： 
{
    "cid":6207760637435905,             
    "cname":"netease",                 
    "uid": 193992653091841,            
    "stats":1,                         
    "createtime":1513145726,            
    "destroytime":1513145926            
}

删除房间

概述：
       把房间中的所有用户从房间中移除，并删除房间。

接口调用方式：
       请求方法：DELETE

接口地址：
       https://www.88qun.cn/v2/api/room/

参数：
字段 类型 示例 说明
cid int64 6207760637435905 房间 ID。该 ID 为 创建房间 接口调用成功后返回的房间 ID。 仅在调用 V2 接口时需要设置。
cname String abc 房间名称。仅在调用 V3 接口时需要设置。

参数示例：


返回值：

返回值示例：

创建云端录制

概述：
       调用此接口创建一个云端录制任务。
       通过服务端接口实现云端录制时，可以设置音视频通话全局的录制相关参数。例如设置录制模式为单流录制模式，对房间内所有成员生效。

接口调用方式：
       请求方法：POST

接口地址：
       https://www.88qun.cn/v2/api/cloudrecord/submit

参数：
字段 类型 示例 说明 是否必填
cid Number 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。仅在调用 V2 接口时需要设置。 必填
recordConfig JSON 录制模式。详细信息请参考 recordConfig 可选
streamSubscribe JSON 录制订阅配置。详细信息请参考 streamSubscribe 可选
detect JSON 内容安全审核配置。详细信息请参考 detect。 可选
layoutConfig JSON 录制布局配置。详细信息请参考 layoutConfig。 可选

参数示例： 
{
    "cid":1144350751977184,
    "recordConfig":{
        "recordtype":0
    },
    "detect":{
        "enableSpamDetect":true,
        "scFrequency":1,
        "detectType":1
    },
    "layoutConfig":{
        "hostUid":66602,
        "layoutType":3
    },
     "streamSubscribe":{
        "streamType":2,
        "audioUidList":{
            "subscribeUids":[
                4455,
                66602
            ]
        },
        "videoUidList":{
            "unSubscribeUids":[
                4455
            ]
        }
    }
}


返回值：
字段 类型 示例 说明
taskId String 1143932537695968 任务唯一标识符，房间内唯一
cid Number 123456 房间 ID

返回值示例： 
{
    "code": 200,
    "record": {
        "taskId": "23d73e2ae2c74135a732c8d24739b71d8723",
        "cid": 1144350751977184
    }
}

停止录制任务

概述：
       调用此接口停止指定的录制任务。

接口调用方式：
       请求方法：POST

接口地址：
       https://www.88qun.cn/v2/api/cloudrecord/stop

参数：
字段 类型 示例 说明 是否必填
cid Number 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。仅在调用 V2 接口时需要设置。 必填
taskId String 任务唯一标识符，房间内唯一。 调用添加录制任务接口后，可在返回 body 中获取 taskId。 必填

参数示例： 
{    
	   "taskId": "23d73e2ae2c74135a732c8d24739b71d8723",  
       "cid": 1144350751977184
}


返回值：
字段 类型 示例 说明
taskId String 1143932537695968 任务唯一标识符，房间内唯一
cid Number 123456 房间 ID

返回值示例： 
{
    "code": 200,
    "record": {
        "taskId": "23d73e2ae2c74135a732c8d24739b71d8723",
        "cid": 1144350751977184,
        "state": 2
    }
}

查询云端录制文件信息

概述：
       调用接口查询云端录制文件信息。
       如果开启了云端录制消息抄送，录制完成后，文件信息会以抄送形式发送到您的指定服务器。您也可以主动调用本接口随时查询指定房间的录制文件信息，包括录制文件的文件名、URL等。

接口调用方式：
       请求方法：POST

接口地址：
       https://www.88qun.cn/v2/api/cloudrecord/file

参数：
字段 类型 示例 说明 是否必填
channelId Long 52026368004000 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。 必填

参数示例：


返回值：
字段 类型 示例 说明
code Number 200 状态码。
fileInfos JSONArray 指定房间中生成的所有录制文件的对应信息。
channelId Long 52026368004000 房间 ID。

data块jsonobject字段说明
字段 类型 示例 说明
createTime Number 云端录制文件的生成时间。
objectName String 云端录制生成的文件名。
url String 云端录制文件的对应地址，获取此地址后可以通过播放器 SDK 播放。
createTime Number 云端录制文件的生成时间。

返回值示例： 
{
  "code": 200,
  "fileInfos": [
    {
      "createTime": 1587718829022,
      "objectName": "123-22222222-1589020209203-0.mp4",
      "url": "http://www.88qun.cn/123-22222222-1589020209203-0.mp4"
    },
    {
      "createTime": 1587718828946,
      "objectName": "0-22222222-1589020209203-0-mix.mp4",
      "url": " http://www.88qun.cn/0-22222222-1589020209203-0-mix.mp4"
    }
  ],
  "channelId": 52026368004000
}

开发技术支持

       热线电话：4007999900
       技术合作：13601083250
       本地支持：上海 • 北京 • 江苏 • 重庆
       海外支持：日本（东京）