外呼机器人NLP接口参考手册_v1.0

发行/变更日志

2019-3-25

• 与nlp交互接口文档

API参数和输出

编码（encoding） 不支持协商，全部为UTF-8。无视HTTP header中的编码声明。 Content-Type仅支持application/json

输出 仅支持json。无视HTTP header中Accept的要求。 如无特殊说明，API不支持If-Modified-Since/If-None-Match，始终输出完整结果。

数据类型或格式

JSON代码中出现的时间格式，如无特殊说明，均采用时间戳。

文档编辑

文中json代码为了书写方便，属性名也许存在未带双引号的情况（也可能在文档升级时解决该问题），编码时请全部按照含双引号的规范方式理解。

服务地址

由需NLP服务商提供

接口列表

语义层调用统一接口

URL

需NLP服务商提供

请求方式

POST

请求参数

{
  "sessionId": "123",
  "contentFlag": "0",
  "content": "天气咨询"
}

说明

参数	类型	说明	必选	约束
sessionId	String	回话ID	必填	无
contentFlag	Integer	信息类型,0:开场第一句; 1:ASR识别的文本内容; 2:无语音识别结果[未检测到语音输入]; 3:识别结果不准确[噪音]	必填	无
content	String	文本内容	contentFlag=0时，标识话术名称; contentFlag=1时，标识ASR识别的文本内容; contentFlag=2,3时,为空	无

返回结果

{
  "msg": "success",
  "code": 0,
  "data": {
    "question": "天气咨询",
    "contents": [
      {
        "contentType": "txt",
        "content": "您想了解哪里的天气？",
        "voiceUrl": "",
        "voiceContent": ""
      },
      {
        "contentType": "voice",
        "content": "",
        "voiceUrl": "http://localhost:8080/smart/resource/voice/201805211.mp3",
        "voiceContent": "您想了解哪里的天气?"
      }
    ],
    "action": {
      "actionCode": "normal",
      "actionContent": "正常通话"
    },
    "labels": [
      {
        "labelName": "咨询天气",
        "labelDescribe": "咨询天气",
        "labelSign": "1"
      },
      {
        "labelName": "2",
        "labelDescribe": "2",
        "labelSign": "2"
      }
    ]
  }
}

说明

返回字段	字段类型	说明
msg	String	返回结果描述
code	Integer	请求返回代码,200:操作成功;非200为失败
data	Object	结果详情
question	String	业务场景名称
contents	Object[]	返回内容列表
contentType	String	消息类型,txt:文本; voice:语音;
content	String	返回文本内容,contentType=txt时必定存在
voiceUrl	String	返回录音地址,contentType=voice时必定存在
voiceContent	String	返回语音文本内容,contentType=1时必定存在
action	Object	动作
actionCode	String	动作代码,动作代码主要有,normal:正常通话; hang:机器人挂断; transfer:转接人工;
actionContent	String	动作内容
label	Object[]	标签组
labelName	String	标签名称
labelDescribe	String	标签描述
labelSign	String	标签标识