华为云用户手册

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 消息体 表3 消息体参数说明 序号 名称 参数类型 选取原则 说明 1 password string True CTI平台的工号密码（最大长度为32）。 说明： LOG IN_PWD_DECRYPT_ENABLE字段为true时，填写经国密算法加密后的密文，密文由调用方加密生成。 2 phonenum string True 软电话号码（最大长度为24） 3 autoanswer boolean False 是否自动应答，默认为true。 4 autoenteridle boolean False 是否自动进入空闲态，默认为true。 5 releasephone boolean False 座席挂机后是否进入非长通态(呼叫结束后话机挂断)：默认为true。 6 agenttype int False 签入的座席类型，默认为4。4：pc+phone座席，11：pc+phone视频座席 7 status int False 签入后的状态，默认为空闲态。3：示忙态，4：空闲，5：整理态 8 ip string False 座席ip，默认127.0.0.1（最大长度为15），暂不支持IPV6 9 entryIp string False 座席客户端应用网关IP 10 phonelinkage boolean False 是否启动话机联动（接续和硬话机联动控制）。 默认为false 11 checkInWebm boolean False 是否签入Webm媒体服务器，不需要签入Webm媒体服务器需要传入参数 false。 默认为true。 12 checkInMailm boolean False 是否签入Mailm媒体服务器。 默认为false。 13 vcPhoneNumber string False VC号码（最大长度为24） 14 listenStatus boolean False 质检员是否侦听座席登录和登出的操作。 默认为false。 15 callBackUri string False 事件回调地址（最大长度200） 接口定义可参考“推送事件回调接口”章节 16 serviceToken string False 认证码（最大长度50，不能包含特殊字符） callBackUri和serviceToken同时传入时才代表使用事件推送模式，否则依旧使用事件轮询模式。 Webm和Mailm媒体服务器签入异常不影响音视频业务处理。

响应说明 表4 响应头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 3 Set-GUID string True 值例如为“JSESSIONID=279fe2*****************0f5.AgentGateway0”其中279fe2*****************0f5.AgentGateway0为Guid 表5 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result Map 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表6。 表6 result对象参数说明 序号 名称 参数类型 说明 3.1 vdnid string 虚拟呼叫中心ID。 3.2 workno string 座席工号。 3.3 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。如：TTF，表示CTIServer、WebM签入成功，MailM签入失败。 只有签入CTIServer成功，才能进行语音业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.4 loginTime string 签入时间，格式为时间戳。 3.5 isForceChange string 是否需要强制修改密码，如果为true，则座席登录后，必须修改密码。修改密码请调用修改密码(扩展)。 说明： 如果为true，没有修改密码，该座席无法进行通话。 3.6 serverName string 登录的CC-Gateway的集群名称。 3.7 timeRemaining string 密码剩余过期时间。 空字符串则表示座席密码永不过期。取值范围为0~180（天）。

报文样例 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "displayResult": "就是不接电话6", "resultCode": "002", "defId":"12345" } ], "resultCode": "0200000", "resultDesc": "query outboundResult success", "totalCount": 1, "returnDesc": "query outboundResult success" }

错误结果码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常，请检查请求参数 10 02000009 参数组合不正确，请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/queryOBSResults?pageSize={pageSize}&pageNum={pageNum} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 pageSize int True 页容量取值范围1-50。 3 pageNum int True 页码，取值范围大于0。

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 totalCount int 外显结果的总数量。 4 data List 外显结果列表。 5 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 6 returnDesc String 描述。 表4 data 序号 参数名 参数类型 说明 1 displayResult String 外显结果。 2 resultCode String 外显结果码。 3 defId String 外显结果ID。

接口URI 呼叫中心平台调用识别结果通知接口的URI格式如下： {servicecallbackuri}/v100/subscribe/asrevent/asrresult其中，“servicecallbackuri”为注册的通知回调地址。 例如：https://10.21.117.9:8043/agentgateway/resource/asrresult/v100/subscribe/asrevent/asrresult 第三方需要对该地址进行接收消息处理。 HTTPS采用TLS1.2及以上版本，确保web应用的敏感数据在传输过程中不被非法截获

报文样例 请求样例 { "tenantId":"202104237142", "language":"zh_CN", "sentence":"长沙岳麓区岳麓大道旺龙路,下雨天积水严重,影响出行", "authToken":"E2mjXcv*******************XX1av" } 响应样例 { "count": 4, "entityMsgV2List": [ { "citation": "@system.any", // 匹配任意用户输入 "type": -1, "userEntity": false, "envEntity": false, "beginIndex": 0, "endIndex": 25, "values": { "@system.any": "长沙岳麓区岳麓大道旺龙路,下雨天积水严重,影响出行", "@system.any.raw": "长沙岳麓区岳麓大道旺龙路,下雨天积水严重,影响出行" }, "formats": [ "raw" ] }, { "citation": "@system.env.time", // 当前时间 "type": -1, "userEntity": false, "envEntity": true, "beginIndex": -1, "endIndex": -1, "values": { "@system.env.time.hour": "11", "@system.env.time.minute": "09", "@system.env.time": "11:09" }, "formats": [ "hour", "minute" ] }, { "citation": "@system.env.date", // 当前日期 "type": -1, "userEntity": false, "envEntity": true, "beginIndex": -1, "endIndex": -1, "values": { "@system.env.date.yyyyMM": "202110", "@system.env.date": "2021-10-19", "@system.env.date.year": "2021", "@system.env.date.month": "10", "@system.env.date.day": "19" }, "formats": [ "yyyyMM", "year", "month", "day" ] }, { "citation": "@system.address", // 地址检测 "type": -1, "userEntity": false, "envEntity": false, "beginIndex": 0, "endIndex": 5, "values": { "@system.address.raw": "长沙岳麓区", "@system.address": "湖南省长沙市岳麓区", "@system.address.province": "湖南省" }, "formats": [ "raw", "province" ] } ] }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 language String body True 语言。选项如下： zh_CN：中文 en_US：英文 es_ES：西班牙语 ar：阿拉伯语 th_TH：泰语 pt_BR：葡萄牙语 说明： 基于Tuc的实体识别,支持如上选项语种。 基于Lodas的实体识别,支持语言以Lodas实体识别模型为准。 sentence String body True 输入语句。 实体识别的依据,最大长度4096字符。 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

消息样例 场景描述：创建工单 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/case 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "caseInfo": { "description": "testOpenApi", "type": "cvmC0000014Oc9jgT7ZI", "origin": "Voice", "dueDate": "2023-07-30 00:00:00", "isAutoAssigned": true, "priority": "Low", "title": "test", "contactId": "ciIy0000013y7cC8T2rA", "state": "Processing", "creatorId": "10gg00000148PCjKVDAu", "contactPhone": "15151852650" } } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： { "resCode": "0", "resMsg": "成功", "result": {"caseId":"coiO0000014hmYpZIqYq"} }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，access-token获取参见鉴权配置机机接口(SaaS集成) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 caseInfo Object True 工单信息，该对象的参数说明请参见表3 caseInfo列出来的字段只是任意工单都需要的一些标准字段，其他字段是可以根据工单对应的模板动态扩展。 表3 caseInfo参数说明 序号 名称 参数类型 长度（字节） 是否必选 说明 1 title string 128 True 工单标题 2 description string 20000 True 工单描述 3 type string 20 True 工单类型，工单类型id 4 ownerId string 20 False 工单的责任人，工单自动分配时可以不填写，创建工单接口中根据分配逻辑自动分配责任人 5 isAtuoAssigned boolean - True 是否自动分配 6 priority string - False 优先级，Low/Medium/High/Critical 7 origin string - False 工单来源，Voice/Whatapp/webchat/Email 8 dueDate DateTime - False 期望完成时间，格式为YYYY-MM-DD HH:mm:ss 9 contactId string 20 True 工单对应的联系人 10 attachment string - False 附件大小不能超过5M，数量不超过5个，支持jpg 、png 、pdf 、jpeg 、gif、doc、docx格式 11 creatorId string 20 True 创建人 12 contactPhone string 20 False 联系人电话 13 beId string 20 False CRM客户较多，beId用于区分客户大区 如果创建工单涉及的工单类别使用了自定义的工单模板，则工单模板上扩展的字段可继续在请求消息体中继续往后添加。

报文样例 场景描述：查询历史消息 URL：https://域名/apiaccess/ccmessaging/queryHistoryChatMessage 请求头: { "ccmessaging-token": "eyJjcmVhdGVUaW1lI********************************IiwiY2hhbm5lbElkIjoiMjAyMTAyMTkzMTk2ODY5NzA4In0%3D", "x-app-key": "ea5c29a3-ea45-4b79-a449-2a3dbeb4c32c", "Authorization": "Bearer 57042f85****************8c4e0", "Content-Type": "application/json" } 请求参数: { "channelId":"202207292843442389", "userId":"1659490221026188522", "limit":"1", "offset":"0", "startTime":"1659910093000", "endTime":"1659938956000", "channel":"WEB" } 响应参数: { "messageList": [ { "id": "10113293212986888", "channel": "WEB", "senderNickname": "wangming77", "senderAvatar": "../../image/user1.png", "sendTime": 1659938956000, "receiveTime": 1659938956000, "controlType": "CHAT", "sourceType": "USER", "mediaType": "FILE", "content": "diaoyu.aac,26964,fee53aad-94a0-4dc2-b7ff-fd8c2e2496f2,aac", "callId": "1659938875-16806492", "messageCode": "67A257B0DB5EFBC08C9F2BD612443F09BBF858570A62CCAAB8D3CE45B7C0EFD0", "associationContentId": null, "sendStatus": null, "errorMsg": null, "isForwarded": false, "forwardTime": null, "contentDealType": null } ], "resultCode": "0", "resultDesc": "success" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 messageList array 查询到的历史消息集合 1.1 resultCode string 0：成功 1：失败 1.2 resultDesc string 响应返回描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 ccmessaging-token string True applyToken接口生成的ccmessaging-token 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 channelId string True 渠道标识 1.2 userId string True 渠道下发送消息的用户ID。取值范围：1到24位字符串。 1.3 startTime string False 查询历史消息开始时间 1.4 endTime string False 查询历史消息结束时间 1.5 limit string True 分页参数，查询历史消息数量 1.6 offset string True 分页参数，偏移量 1.7 channel string True 客户端已发送消息所属渠道类型，如WEB(WEB客服接入渠道)

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常，请检查请求参数 10 02000009 参数组合不正确，请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数 接口配置流控，五分钟执行一次，针对429状态，提示返回：“请勿频繁操作，请稍后再试。”。ValidateExceptionHandler中正在处理。

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "countDetail": [ { "calledCount": 0, "batchDetail": [], "campaignId": "1798316116", "finishCount": 0, "unCallCount": 0, "totalCount": 3, "totalCallSucc": 2, "totalCalledCount": 3, "totalFinishCount": 3, "dailyFinishCount": 3, "dailyCalledCount": 3, "dailyCallSucc": 2, "dailyCount": 3 }, { "calledCount": 0, "batchDetail": [ { "calledCount": 0, "finishCount": 0, "unCallCount": 1, "batchId": "123456", "totalCount": 3, "totalCallSucc": 2, "totalCalledCount": 3, "totalFinishCount": 3, "dailyFinishCount": 3, "dailyCalledCount": 3, "dailyCallSucc": 2, "dailyCount": 3 }, { "calledCount": 0, "finishCount": 0, "unCallCount": 1, "batchId": "66666", "totalCount": 3, "totalCallSucc": 2, "totalCalledCount": 3, "totalFinishCount": 3, "dailyFinishCount": 3, "dailyCalledCount": 3, "dailyCallSucc": 2, "dailyCount": 3 } ], "campaignId": "1549589640", "finishCount": 0, "unCallCount": 3 } ] }

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 countDetail Array 返回每个任务的数量。 具体见表4 表4 countDetail结构 序号 参数名 参数类型 说明 1.1 campaignId String 外呼数据ID。 1.2 unCallCount int 该活动ID下的剩余未拨打总量。 1.3 calledCount int 当天已拨打量。 1.4 finishCount int 已完成呼叫总量 1.5 batchDetail Array 返回每个customField(批次号)值的数量 具体见表 batchDetail结构。 1.6 totalCalledCount int 该活动已拨打总量 1.7 totalCallSucc int 该活动接通呼叫总量 1.8 totalFinishCount int 该活动已完成呼叫总量 1.9 totalCount int 该活动总呼叫量（含完成，呼叫中，未呼叫） 1.10 dailyCalledCount int 当天已拨打量 1.11 dailyCallSucc int 当天接通呼叫总量 1.12 dailyFinishCount int 当天已完成呼叫总量 1.13 dailyCount int 当天呼叫量（含完成，呼叫中，未呼叫） 表5 batchDetail结构 序号 参数名 参数类型 说明 1.5.1 batchId String 代表增加外呼数据时的批次id。 取值与customField一致。 1.5.2 unCallCount int 该活动ID下的剩余未拨打总量。 1.5.3 calledCount int 当天已拨打量。 1.5.4 finishCount int 已完成呼叫总量 1.5.5 totalCalledCount int 该活动已拨打总量 1.5.6 totalCallSucc int 该活动接通呼叫总量 1.5.7 totalFinishCount int 该活动已完成呼叫总量 1.5.8 totalCount int 该活动总呼叫量（含完成，呼叫中，未呼叫） 1.5.9 dailyCalledCount int 当天已拨打量 1.5.10 dailyCallSucc int 当天接通呼叫总量 1.5.11 dailyFinishCount int 当天已完成呼叫总量 1.5.12 dailyCount int 当天呼叫量（含完成，呼叫中，未呼叫）

接口URL https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/statistics?campaignId={campaignId}&batchId={batchId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId String False 外呼数据ID 该参数有值，查询当前任务的全量和所有批次。 该参数为空时，查询所有任务的全量和所有批次。 3 batchId String False，该字段有值，则campaignId必传。 批次号，映射t_isl_data表customField字段。 该参数有值时，查询当前任务的全量和所传批次。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。

响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 defId String 创建的外显结果ID。 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 5 returnDesc String 描述。

报文样例 该接口的请求消息体举例如下： {"resultCode":"007", "displayResult":"就是不接电话7", "obsCodes":["00602","00606"]} 该接口的响应消息体举例如下： { "defId": "1645244637", "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "createObResult Success!", "returnDesc": "createObResult Success!" }

错误结果码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常，请检查请求参数 10 02000009 参数组合不正确，请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/createObResult 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result list 查询成功后，返回结果列表。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 skillMediaType int 技能队列媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 3.2 skillId int 技能队列id 3.3 agent list 座席详细信息 该对象的参数说明请参见表5。 表5 agent对象参数说明 序号 名称 参数类型 说明 3.3.1 workno string 座席工号 3.3.2 name string 座席名称 3.3.3 status int 座席状态，参见表1 3.34 ctiStatus int 座席平台状态，请参考表2 3.3.5 groupid int 座席班组ID 3.3.6 groupname string 未使用该返回参数 3.3.7 skilllist list 未使用该返回参数 3.3.8 callids list 未使用该返回参数 3.3.9 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功，才能进行音视频呼叫业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.3.10 vdnid int 所属VDN ID 3.3.11 phonenumber string 座席电话号码 3.3.12 currentstatetime long 当前状态时长（秒） 3.3.13 logindate long 签入时间，时间戳（毫秒） 3.3.14 inMultimediaConf int 未使用该返回参数 3.3.15 currentStateReason int 当前状态原因码

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": [ { "skillId": 1, "agent": [ { "workno": "2005", "name": "liukai011", "status": "4", "ctiStatus": "1", "groupid": 0, "groupname": null, "skilllist": [], "mediatype": "TFF", "vdnid": 214, "phonenumber": "88880026", "currentstatetime": 527, "logindate": 1616510142000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 }, { "workno": "2007", "name": "", "status": "4", "ctiStatus": "1", "groupid": 0, "groupname": null, "skilllist": [], "mediatype": "TTF", "vdnid": 214, "phonenumber": "88880027", "currentstatetime": 28, "logindate": 1616510634000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 } ], "skillMediaType": 5 }, { "skillId": 2, "agent": [ { "workno": "2007", "name": "", "status": "4", "ctiStatus": "1", "groupid": 0, "groupname": null, "skilllist": [], "mediatype": "TTF", "vdnid": 214, "phonenumber": "88880027", "currentstatetime": 28, "logindate": 1616510634000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 } ], "skillMediaType": 53 } ], "message": "success", "retcode": "0" }

报文样例 请求样例 { "request": { "sentence":"查询3月账单", "targetIntentCount":1, "confidence2Top":0.2, "accessCode":"10086", "channel":"OIFDE", "tenantId":"NJ_001", "language":"zh_CN", "userId":"123456789" } } 响应成功样例：

请求说明 表1 请求体参数 名称 是否必选 参数类型 说明 request True requestBody 请求体 表2 requestBody 名称 是否必选 参数类型 长度 说明 userId True String 64 用户ID accesscode False String 32 接入码（用户通过拨打什么号码接入的） channel False String 32 渠道（目前固定填OIFDE） sentence True String 1024 客户输入的文本信息 tenantId True String 64 租户ID language True String 20 语言 中文：zh_CN 英文：en_US context False String 64 意图识别需要的上下文 targetIntentCount False int 4 需要chatbot返回多个意图时的意图数量,一般用于客户输入一句话可以匹配多个意图的情况 范围：1——5 confidence2Top False float 4 置信度间距 如果返回多个意图,要求后面的意图与第一个置信度最高的意图的置信度间距,这个值越小表示返回的意图越接近。 范围：0——1 timeZone False String 10 时区,8表示东8区。

响应参数 名称 是否必选 参数类型 长度 说明 errorMsg False String 512 错误信息 errorCode False String 20 错误码 intentsResponses False Intents[] - 意图数组,成功时必须返回。 nonce False String 128 token认证失败时返回,服务端随机生成的字符串,同时需要返回状态码401。 表3 Intents 名称 是否必选 参数类型 长度 说明 responses False String[] 4096 Chatbot返回的应答信息,字符串数组,可以有多个。 confidence True float 4 置信度 机器人回复的可靠度,取值范围０～１,最小值是０,最大值是１,例如基于你的一个问题1,有10个回答,其中6个回答是相同的Answer１,那么Answer１的置信度是0.6 commands True String[] 64 意图命令字 params False Map - 命令字参数信息,一般意图的槽位信息都通过这个返回。例如{"Number":"3"}。 一般意图操作具体详情参考添加意图章节。 scenarioName False String 64 意图名 scenarioType False int 4 场景类型,辅助场景=1, 业务场景=0, 无场景= -1 scenarioStatus False String 64 场景状态（暂不使用）

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200007 外呼活动不存在。 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常，请检查请求参数 11 02000009 参数组合不正确，请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数