领域查询接口

场景描述

智能助手平台提供接口给第三方接入方调用,实现智能交互系统内的已激活领域信息的查询。

接口方法

设置成“POST”。

URL

https://IP:PORT/oifde/rest/api/querydomaininfo

请求说明

表1 请求头参数
序号	名称	参数类型	是否必选	说明
1	Content-Type	String	True	固定填 application/json; charset=UTF-8。

表2 请求体参数
参数名称	数据类型	参数位置	必选/可选	描述
tenantId	String	body	True	租户ID。
language	String	body	False	语言。选项如下： zh_CN：中文 en_US：英文 es_ES：西班牙语 ar：阿拉伯语 fr_FR：法语如果language为空或者为""都是返回全部的领域结果，如果有，只返回指定语言domain。
authToken	String	body	True	认证Token 请参见C3 智能助手平台接口鉴权方式。

响应说明

参数名称	数据类型	参数位置	必选/可选	描述
errorCode	int	body	True	错误码 0或者null：成功非0表示失败或可通过状态码为200判断为成功
errorMsg	String	body	False	错误描述
domains	domain[]	body	True	领域信息，数组形式输出

参数名称

数据类型

参数位置

必选/可选

描述

errorCode

int

body

True

错误码

0或者null：成功
非0表示失败
 或可通过状态码为200判断为成功

errorMsg

String

body

False

错误描述

domains

domain[]

body

True

领域信息，数组形式输出

表3 domain
参数名称	数据类型	参数位置	必选/可选	描述
tenantId	String	body	True	租户ID
domainId	int	body	True	领域ID
domainName	String	body	True	领域名称
language	String	body	True	语言。选项如下： zh_CN：中文 en_US：英文 es_ES：西班牙语 ar：阿拉伯语 fr_FR：法语如果没有该字段，则返回所有语言的domain，如果有，只返回指定语言的domain。

报文样例

请求报文

{
    "tenantId":"202104237142",
    "language":"zh_CN",
    "authToken":"w***************************"
}

响应报文

{
    "errorCode" : 0, // int, 错误码,无错时为0
    "errorMsg" : "", // String, 出错信息,无错时为空
    "domains" : [{  // Object Array, 领域列表
        "tenantId":"tenant0001", // String, 租间id
        "domainId": 10079, // int, 领域ID
        "domainName":"山西流程" // String, 领域名称
        "language" : "zh_CN"// String, 语言(目前支持中文zh_CN、英文en_US、西班牙语es_ES和阿拉伯语ar)
    },{
        ……
    }]
}