NXLINK AI listRoute - nxtele/http-api-document GitHub Wiki

查询呼叫路由列表

URL：https://api-hk.nxlink.ai/openapi/aiagent/route/list
Method：POST
Content-Type：application/json
需要鉴权：是

🌐 服务接入点

NXLink 在全球部署了多个服务区域，请根据您的业务所在地选择对应的服务接入点。不同区域的网站域名和API网关域名不同。

代号	区域	NXLink网站	API网关
APAC	香港	`https://app.nxlink.ai`	`https://api-hk.nxlink.ai`
AMER	美洲	`https://chl-nxlink.nxcloud.com`	`https://chl-api.nxlink.ai`
APAC(IDN)	印尼	`https://idn.nxlink.ai`	`https://api-idn.nxlink.ai`

请求参数

header参数：

参数名	类型	必选	示例值	说明
accessKey	String	是	AK-6230339248928541113-2133	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	100	业务类型，取固定值“100”
action	String	是	nxai	业务操作，取固定值“nxai”
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名查看公共约定，签名算法

请求参数：

参数名	类型	必选	示例值	说明
routeName	String	否	"MX-Router"	路由名称，支持模糊匹配
pageNumber	Integer	是	1	页码，默认1
pageSize	Integer	是	100	每页大小，默认100，最大1000

说明

taskCreate 接口中的 routeId 可通过本接口返回的 routeId 字段获取。

请求示例

请求body：

{
  "routeName": "MX",
  "pageNumber": 1,
  "pageSize": 100
}

响应参数

参数名	类型	说明
code	Integer	结果编码
message	String	请求结果说明
traceId	String	链路追踪ID
data	Object	响应数据主体

data对象

参数名	类型	说明
total	Integer	总记录数
pageNumber	Integer	当前页码
pageSize	Integer	每页大小
list	Array	路由列表

list元素

参数名	类型	说明
routeId	String	路由id，用于创建任务时的 `routeId`
routeName	String	路由名称
routeType	Integer	路由类型，`0`：bot自建，`1`：第三方，`2`：cc路由
isDefault	Integer	是否默认路由，`1` 表示默认，`0` 表示非默认

routeType说明

值	说明
0	bot自建
1	第三方
2	cc路由

响应示例

成功示例

{
  "code": 0,
  "message": "success",
  "traceId": "658CCE52391B4869B13FDD432658EDC8",
  "data": {
    "total": 50,
    "pageNumber": 1,
    "pageSize": 100,
    "list": [
      {
        "routeId": "R-123-123",
        "routeName": "MX-Router",
        "routeType": 2,
        "isDefault": 1
      },
      {
        "routeId": "R-456-789",
        "routeName": "Local-Display-Router",
        "routeType": 1,
        "isDefault": 0
      }
    ]
  }
}

错误码

值	说明
1001	Authentication failed (missing public parameters)
1002	Authentication failed (parameter error)
1003	Authentication failed (invalid signature)
1004	Authentication failed (timestamp expired)
1005	Authentication failed (insufficient authority)
20000	Business Error