Skip to content

NXLINK AI listFlow

曾日强 edited this page May 26, 2026 · 3 revisions

查询AI Agent列表

  • URL:https://api-hk.nxlink.ai/openapi/aiagent/flow/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入参参数签名 查看公共约定,签名算法

请求参数:

参数名 类型 必选 示例值 说明
name String "快递通知" AI Agent 名称,支持模糊匹配
pageNumber Integer 1 页码,默认1
pageSize Integer 10 每页大小,默认10,最大1000

说明

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

请求示例

请求body:

{
  "name": "快递",
  "pageNumber": 1,
  "pageSize": 10
}

响应参数

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

data对象

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

list元素

参数名 类型 说明
autoFlowId Long AI Agent id,用于创建任务时的 autoFlowId
name String AI Agent 名称
desc String 描述
status Integer 流程开关/草稿标识,0:关闭,1:开启,2:草稿
engineModel Integer 引擎模式,0:普通引擎,1:AI 引擎(见 EngineTypeEnum
engineVersion String AI 引擎版本档位,取值:basicstandardpro
language String 语言
voiceId Integer 声音id
voiceName String 声音名称
version Integer 版本号
userId Long 创建人id
userName String 创建人账号
createTime String 创建时间
updateTime String 更新时间

字段说明

参数名 取值 说明
status 0 / 1 / 2 流程开关/草稿标识,0:关闭,1:开启,2:草稿
engineModel 0 / 1 引擎模式,0:普通引擎,1:AI 引擎
engineVersion basic / standard / pro AI 引擎版本档位

说明:接口返回字段名分别为 engineModelengineVersion,其含义对应引擎模式和 AI 引擎版本档位。

响应示例

成功示例

{
  "code": 0,
  "message": "success",
  "traceId": "432ed6e675d84f61b526d624d5ceef1a",
  "data": {
    "total": 84,
    "pageNumber": 1,
    "pageSize": 10,
    "list": [
      {
        "autoFlowId": 446,
        "name": "快递到货通知",
        "desc": "用于快递到站、派送前等通知场景",
        "status": 1,
        "engineModel": 1,
        "engineVersion": "standard",
        "language": "zh-CN",
        "voiceId": 9,
        "voiceName": "中文-男-浑厚音",
        "version": 134,
        "userId": 10001,
        "userName": "demo_user_001",
        "createTime": "2025-06-05 14:26:41",
        "updateTime": "2026-03-25 11:29:05"
      },
      {
        "autoFlowId": 197,
        "name": "营销机器人",
        "desc": "用于活动推广、会员触达等营销场景",
        "status": 1,
        "engineModel": 1,
        "engineVersion": "standard",
        "language": "zh-CN",
        "voiceId": 9,
        "voiceName": "中文-女-亲和音",
        "version": 132,
        "userId": 10002,
        "userName": "demo_user_002",
        "createTime": "2025-03-01 10:00:00",
        "updateTime": "2026-03-25 09:00:00"
      }
    ]
  }
}

错误码

说明
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

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

NXLINK(HKG)

NXLINK(IDN)

NXLINK(CHL)

AI Agent

RCS

Clone this wiki locally