菜单

API接口

标签：api ,webhook ,API

接口详情

1. 授权接口

Url
https://api-rpa.bazhuayu.com/api/v1/identity/authentication/password
请求方式
POST
  • 请求
    • 请求头
    字段
    值
    Content-Type
    application/json
    • 请求参数
    参数名称
    类型
    必须
    描述
    loginName
    string
    是
    账号用户名
    password
    string
    是
    账号密码
    •  
    • 请求示例
      请求体：
    { "loginName": "rpa账号", "password": "rpa账号密码" }
 
  • 返回结果
参数名称
类型
必须
描述
accessToken
string
是
Token
accessTokenExpirationTime
string
是
Token 过期时间
 
返回示例：
{ "accessToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUyNDc4OTQsImV4cCI6MTcxNTMzNDI5NCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MjQ3ODk0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA5VDEwOjI1OjU3KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.NQd3dvRRpgakAd653JyBZ9sGPmC1GeTVzqE2Yks2L2hVmHSd6NtVGittVLg2wF5jTKSBq_Yk3vqO_pZR_ng18VC9xwxS6ikZVyCxJ0pFyrXGkfOiQH3coflecFHCvNOEc6iRAcYnvtbP-vW7RzsbsEoZGFnD3HsBX9y8lrf3X2lESJWwRXXopy0Sxq_BsTBqZE-aH-7edMA2nuacuiGbZ4etkLwJHi8jiPC1IG6nQT-nGc5A2IXL11vVVXi4vgYq8yzFOWx4Df1d67mZOkCrFY7FohPiqK95qGKPLVY5SkqbxOk2qyDgMsfEwQUmEB6KNZsgHL10Pqbys2rHTP8MSg", "accessTokenExpirationTime": "2024-05-10T09:44:54+00:00", "refreshToken": "5jUQ8TZqlFz72CmuRgnSzwAOf5UCSxosxDI5GLpmq54", "refreshTokenExpirationTime": "2024-05-16T09:44:54+00:00" }
 
 

2. 触发器 Webhook 接口

参考 WebHook触发任务
Url
从 Webhook 触发器获取
请求方式
POST
 
  • 请求
    • 请求头
    字段
    值
    Content-Type
    application/json
 
  • 请求参数
参数名称
类型
必须
描述
sign
string
是
时间戳与创建 Webhook 触发器时生成的签名密钥进行算法加密，将 timestamp + "\n" + 密钥 当做签名字符串；先使用 HmacSHA256 算法计算签名，再进行 Base64 编码。
 
params
object
否
 
 
{ "应用参数1": "任务的自定义参数", // 例如账号 "应用参数2": "任务的自定义参数" // 例如密码 }
 
specifiedBot
string
是
机器人 Id。从 RPA 企业账号管理平台中获取。
timestamp
string
是
当前时间的时间戳（秒）。
 
  • 返回结果
【Http Code 200】启动成功：
参数名称
类型
必须
描述
enterpriseId
string
是
企业账号 Id
flowId
string
是
应用 Id
processNo
string
是
运行批次
 
返回示例：
{ "enterpriseId": "65d413751fdff0e15cad6627", "flowId": "660b796f5db3eedaa9587bbd", "flowProcessNo": "638508224789866966" }
 
【Http Code 400】启动失败：
参数名称
类型
必须
描述
code
string
是
错误码
description
string
 
错误描述
requestId
string
是
请求 Id
 

3. 查询任务状态接口

Url
https://api-rpa.bazhuayu.com/api/v1/bots/runningRecords/flow-{flowId}/process-{flowProcessNo}
  • 路径中需包含：
    • flowId - 应用 Id
    • flowProcessNo - 应用运行批次
请求方式
GET
 
  • 请求
    • 请求头
      字段
      值
      Content-Type
      application/json
      Authorization
      "Bearer" + " " + 授权接口返回的 accessToken
      EnterpriseId
      调用启动接口返回的 enterpriseId
    • 请求示例
    请求 URL：
    GET https://api-rpa.bazhuayu.com/api/v1/bots/runningRecords/flow-660b796f5db3eedaa9587bbd/process-638506737195684939
     
      请求头：
    名称
    值
    EnterpriseId
    65d413751fdff0e15cad6627
    Authorization
     
    Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUxNjI4MjQsImV4cCI6MTcxNTI0OTIyNCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MTYyODI0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA3VDE3OjIwOjI1KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.hkFNws955sUm3jvAp2ijf6YVz9z10eGuvwez0aT4wi9b5il7zfD5DU2xDcp44CKhN9Wc-9Cy7-RSjDtkmF4EM8CLNs4VPda9EC1BV8md94WaHZIbyJzTyiOXQXEhVtpS8Y_9cQZyhh5WGanD8G2GOWv4cntKMkC4OLmGSXPO95RRkC3DNUXcTwspNVnHt72C7EmQW0kipuPQ83sRXvStuIvvdzb9kNNn5T-6s3ROcvofi1BYeE_19hF0UBs1IA3IJq8oyjUw4MvffzV6ihLVklmbWjWl3VjFoq9p2G5X2dWvqzhJ0am9QazX3e9MNmOBhYlEx0n-1PM90c5xfs-0zA
 
  • 返回结果
    • 【Http Code 200】查询成功：
      参数名称
      类型
      必须
      描述
      flowId
      string
      是
      应用 Id
      flowProcessNo
      string
      是
      应用运行批次
      botId
      string
       
      机器人 Id
      botName
      string
       
      机器人名称
      startWay
      string
      是
      启动方式：
      • Manual
      • TimingTrigger
      • WebhookTrigger（应为该值）
      status
      string
      是
      状态：
      • Empty - 空
      • Waiting - 待执行
      • Scheduled - 任务已分配
      • Delivered - 机器人已接收任务
      • Executing - 执行中
      • Stopping - 停止中
      • Stopped - 已停止
      • Finished - 已完成
      • Failed - 执行失败
      • Cancelled - 已取消
      statusMessage
      string
       
      状态信息
      startTime
      string
      是
      启动时间
      endTime
      string
       
      结束时间
      executionStartTime
      string
       
      执行开始时间
          返回结果示例：
       
      { "flowId": "660b796f5db3eedaa9587bbd", "flowProcessNo": "638506737195684939", "flowName": "百度新闻", "botId": "65d413751fdff0e15cad6627_99bb60a1-5b52-4300-9ffd-681533c6f348_TRZMNZQ1G8YZ0D5NC9A1HF3QD99Z4DMAZ3X8GXG5PZFVE27YMWP0", "botName": "Bot-DESKTOP-NJDIBNV", "starterId": null, "starterName": null, "triggerId": "6639f1689273785531999a5b", "triggerName": "OpenAPI调用测试", "timingTriggerId": "6639f1689273785531999a5b", "timingTriggerName": "OpenAPI调用测试", "startWay": "Webhook", "status": "Executing", "statusMessage": null, "startTime": "2024-05-07T10:15:19.567+00:00", "endTime": null, "executionStartTime": "2024-05-07T10:42:44.877+00:00" }
       
  • 【Http Code 400】查询失败：
    参数名称
    类型
    必须
    描述
    code
    string
    是
    错误码
    description
    string
     
    错误描述
    requestId
    string
    是
    请求 Id
        
    失败结果示例：
    { "code": "SignatureVerificationFailureOrTimestampExpired", "description": "签名匹配失败或时间戳距离当前时间不在一小时内", "requestId": "0HN3EGCVKSHDK:00000001" }
     
 

4. 停止任务接口

Url
https://api-rpa.bazhuayu.com/api/v1/bots/scheduling/stop
请求方式
POST
 
  • 请求
    • 请求头
    字段
    值
    Content-Type
    application/json
    EnterpriseId
    调用启动接口返回的 enterpriseId
    • 请求参数
    参数名称
    类型
    必须
    描述
    flowId
    string
    是
    RPA 应用 Id
    flowProcessNo
    string
    是
    应用运行批次
 
  • 请求示例
请求 URL:  
 POST  https://api-rpa.bazhuayu.com/api/v1/bots/scheduling/stop
 
请求头：
名称
值
EnterpriseId
65d413751fdff0e15cad6627
Authorization
 
Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUxNjI4MjQsImV4cCI6MTcxNTI0OTIyNCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MTYyODI0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA3VDE3OjIwOjI1KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.hkFNws955sUm3jvAp2ijf6YVz9z10eGuvwez0aT4wi9b5il7zfD5DU2xDcp44CKhN9Wc-9Cy7-RSjDtkmF4EM8CLNs4VPda9EC1BV8md94WaHZIbyJzTyiOXQXEhVtpS8Y_9cQZyhh5WGanD8G2GOWv4cntKMkC4OLmGSXPO95RRkC3DNUXcTwspNVnHt72C7EmQW0kipuPQ83sRXvStuIvvdzb9kNNn5T-6s3ROcvofi1BYeE_19hF0UBs1IA3IJq8oyjUw4MvffzV6ihLVklmbWjWl3VjFoq9p2G5X2dWvqzhJ0am9QazX3e9MNmOBhYlEx0n-1PM90c5xfs-0zA
 
请求体：
{ "flowId": "660b796f5db3eedaa9587bbd", "flowProcessNo": "638508434307732021", }
 
 
  • 返回结果
    • 【Http Code 200】成功。
    • 【Http Code 400】失败：
      参数名称
      类型
      必须
      描述
      code
      string
      是
      错误码
      description
      string
       
      错误描述
      requestId
      string
      是
      请求 Id

       

 

5. 机器人列表接口

Url
请求方式
GET

请求

  • 请求头
字段
值
Content-Type
application/json
Authorization
"Bearer" + " " + 授权接口返回的 accessToken
EnterpriseId
调用启动接口返回的 enterpriseId
  • URL 请求参数
参数名称
类型
必须
描述
search
string
否
搜索关键词，可按机器人名称、机器名、描述搜索（注意需要 URL encording）
start
int
否
起始位置，从 0 开始，默认 0
take
int
否
获取记录数量，默认 20
 
  • 请求示例
  请求 URL：
GET https://api-rpa.bazhuayu.com/api/v1/bots/management/bots?search=%E6%9C%BA%E5%99%A8%E4%BA%BA&start=0&take=20
 
  请求头：
名称
值
EnterpriseId
65d413751fdff0e15cad6627
Authorization
 
Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUxNjI4MjQsImV4cCI6MTcxNTI0OTIyNCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MTYyODI0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA3VDE3OjIwOjI1KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.hkFNws955sUm3jvAp2ijf6YVz9z10eGuvwez0aT4wi9b5il7zfD5DU2xDcp44CKhN9Wc-9Cy7-RSjDtkmF4EM8CLNs4VPda9EC1BV8md94WaHZIbyJzTyiOXQXEhVtpS8Y_9cQZyhh5WGanD8G2GOWv4cntKMkC4OLmGSXPO95RRkC3DNUXcTwspNVnHt72C7EmQW0kipuPQ83sRXvStuIvvdzb9kNNn5T-6s3ROcvofi1BYeE_19hF0UBs1IA3IJq8oyjUw4MvffzV6ihLVklmbWjWl3VjFoq9p2G5X2dWvqzhJ0am9QazX3e9MNmOBhYlEx0n-1PM90c5xfs-0zA
 

返回结果

  • 【Http Code 200】查询成功：
    参数名称
    类型
    必须
    描述
    items
    Bot[]
    参数名称
    类型
    必须
    描述
    id
    string
    是
    机器人 Id
    name
    string
    是
    机器人名称
    intro
    string
     
    机器人描述
    machineName
    string
    是
    机器人机器名
    machineIp
    string
    是
    机器人机器 IP
    version
    string
    是
    机器人客户端版本
    isConnected
    bool
    是
    机器人是否连接上服务
    isEnabled
    bool
    是
    机器人是否可用
    executionStatus
    string
    是
    机器人状态：
    • Empty - 空
    • Waiting - 待执行
    • Scheduled - 任务已分配
    • Delivered - 机器人已接收任务
    • Executing - 执行中
    • Stopping - 停止中
    • Stopped - 已停止
    • Finished - 已完成
    • Failed - 执行失败
    • Cancelled - 已取消
    lastConnectingTime
    string
    是
    最后一次连接服务时间
    flowId
    string
     
    正在运行的应用 Id
    flowProcessNo
    string
     
    正在运行的应用运行批次
    是
    机器人列表
    total
    string
    是
    总数
      返回结果示例：
     
    { "items": [ { "id": "99bb60a1-5b52-4300-9ffd-681533c6f348_TRZMNZQ1G8YZ0D5NC9A1HF3QD99Z4DMAZ3X8GXG5PZFVE27YMWP0", "name": "Bot-DESKTOP-NJDIBNV", "intro": null, "machineName": "DESKTOP-NJDIBNV", "machineIp": "172.22.0.1", "version": "0.2.22.1118", "isConnected": false, "isEnabled": true, "executionStatus": "Empty", "lastConnectingTime": "2024-11-20T02:44:01.007+00:00", "lastDisconnectingTime": "2024-11-20T02:48:30.189+00:00", "isBusy": false, "flowId": null, "flowProcessNo": null } ], "total": 1 }
     
     

6 获取机器人信息接口

请求

  • 请求头
字段
值
Content-Type
application/json
Authorization
"Bearer" + " " + 授权接口返回的 accessToken
EnterpriseId
调用启动接口返回的 enterpriseId
  • URL 请求参数
参数名称
类型
必须
描述
botId
string
是
机器人 Id
 
  • 请求示例
  请求 URL：
GET https://api-rpa.bazhuayu.com/api/v1/bots/management/bots/99bb60a1-5b52-4300-9ffd-681533c6f348_TRZMNZQ1G8YZ0D5NC9A1HF3QD99Z4DMAZ3X8GXG5PZFVE27YMWP0
 
  请求头：
名称
值
EnterpriseId
65d413751fdff0e15cad6627
Authorization
 
Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUxNjI4MjQsImV4cCI6MTcxNTI0OTIyNCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MTYyODI0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA3VDE3OjIwOjI1KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.hkFNws955sUm3jvAp2ijf6YVz9z10eGuvwez0aT4wi9b5il7zfD5DU2xDcp44CKhN9Wc-9Cy7-RSjDtkmF4EM8CLNs4VPda9EC1BV8md94WaHZIbyJzTyiOXQXEhVtpS8Y_9cQZyhh5WGanD8G2GOWv4cntKMkC4OLmGSXPO95RRkC3DNUXcTwspNVnHt72C7EmQW0kipuPQ83sRXvStuIvvdzb9kNNn5T-6s3ROcvofi1BYeE_19hF0UBs1IA3IJq8oyjUw4MvffzV6ihLVklmbWjWl3VjFoq9p2G5X2dWvqzhJ0am9QazX3e9MNmOBhYlEx0n-1PM90c5xfs-0zA
 

返回结果

  • 【Http Code 200】查询成功：
    参数名称
    类型
    必须
    描述
    id
    string
    是
    机器人 Id
    name
    string
    是
    机器人名称
    intro
    string
     
    机器人描述
    machineName
    string
    是
    机器人机器名
    machineIp
    string
    是
    机器人机器 IP
    version
    string
    是
    机器人客户端版本
    isConnected
    bool
    是
    机器人是否连接上服务
    isEnabled
    bool
    是
    机器人是否可用
    executionStatus
    string
    是
    机器人状态：
    • Empty - 空
    • Waiting - 待执行
    • Scheduled - 任务已分配
    • Delivered - 机器人已接收任务
    • Executing - 执行中
    • Stopping - 停止中
    • Stopped - 已停止
    • Finished - 已完成
    • Failed - 执行失败
    • Cancelled - 已取消
    lastConnectingTime
    string
    是
    最后一次连接服务时间
    flowId
    string
     
    正在运行的应用 Id
    flowProcessNo
    string
     
    正在运行的应用运行批次

     
      返回结果示例：
     
    { "id": "99bb60a1-5b52-4300-9ffd-681533c6f348_TRZMNZQ1G8YZ0D5NC9A1HF3QD99Z4DMAZ3X8GXG5PZFVE27YMWP0", "name": "Bot-DESKTOP-NJDIBNV", "intro": null, "machineName": "DESKTOP-NJDIBNV", "machineIp": "172.22.0.1", "version": "0.2.22.1118", "isConnected": false, "isEnabled": true, "executionStatus": "Empty", "lastConnectingTime": "2024-11-20T02:44:01.007+00:00", "lastDisconnectingTime": "2024-11-20T02:48:30.189+00:00", "isBusy": false, "flowId": null, "flowProcessNo": null }

 

6.1 机器人实体定义

参数名称
类型
必须
描述
id
string
是
机器人 Id
name
string
是
机器人名称
intro
string
 
机器人描述
machineName
string
是
机器人机器名
machineIp
string
是
机器人机器 IP
version
string
是
机器人客户端版本
isConnected
bool
是
机器人是否连接上服务
isEnabled
bool
是
机器人是否可用
executionStatus
string
是
机器人状态：
  • Empty - 空
  • Waiting - 待执行
  • Scheduled - 任务已分配
  • Delivered - 机器人已接收任务
  • Executing - 执行中
  • Stopping - 停止中
  • Stopped - 已停止
  • Finished - 已完成
  • Failed - 执行失败
  • Cancelled - 已取消
lastConnectingTime
string
是
最后一次连接服务时间
flowId
string
 
正在运行的应用 Id
flowProcessNo
string
 
正在运行的应用运行批次

 

7. 机器人调度接口

  • 认证方式：Authorization: Bearer <token>
  • 企业上下文：请求头 EnterpriseId: <enterpriseId>（可选，缺省为个人版）
  • 请求体大小限制：单次 10 MB

 

7.1 启动单个应用

  • 方法与路径：POST /api/v1/bots/scheduling/start
  • 请求头：
    • Authorization: Bearer <token>
    • EnterpriseId: <enterpriseId> 对应企业id，个人版则无需指定
  • 请求体参数
名称
类型
是否必须
描述
flowId
string
是
应用 Id
flowContentRetrievalMode
string
否
应用内容获取方式，取值：
ByNewestContent默认值，表示获取应用最新内容
ByDefaultPublication表示获取应用最新版本
BySpecifiedPublication表示获取应用指定版本
specifiedPublicationVersion
string
否
指定应用版本号；当模式为 BySpecifiedPublication 时提供
specifiedBot
string
否
指定机器人 Id；不填则为任意机器人
params
object
否
应用运行参数键值对，如 { "key": value }
  • 成功响应体（200）
名称
类型
是否必须
描述
flowId
string
是
已启动的应用 Id
flowProcessNo
string
是
启动应用生成的批次号
  • 失败响应体（400）
名称
类型
是否必须
描述
code
string
是
错误码
description
string
是
错误描述
requestId
string
否
请求追踪 ID
  • 示例请求
POST /api/v1/bots/scheduling/start HTTP/1.1
Authorization: Bearer <token>
EnterpriseId: 64f1e6a2...
Content-Type: application/json

{
  "flowId": "flow_123",
  "flowContentRetrievalMode": "BySpecifiedPublication",
  "specifiedPublicationVersion": "1",
  "specifiedBot": "bot_id_001",
  "params": {
    "date": "2025-10-01",
    "retry": 2
  }
}
  • 示例成功响应
{
  "flowId": "flow_123",
  "flowProcessNo": "638973213311975754"
}

 

7.2 批量启动应用

  • 方法与路径：POST /api/v1/bots/scheduling/start/batch
  • 请求头：
    • Authorization: Bearer <token>
    • EnterpriseId: <enterpriseId> 对应企业id，个人版则无需指定
  • 事务语义：全部成功或全部失败（任一失败则整体失败并回滚，不产生任何启动）, 不会存在同次批量启动的应用部分成功和部分失败的情况
  • 请求体参数（顶层）
名称
类型
是否必须
描述
configs
array
是
启动配置数组，长度 1~100
  • configs[i] 字段
名称
类型
是否必须
描述
flowId
string
是
应用 Id
flowContentRetrievalMode
string
否
应用内容获取方式，取值：
ByNewestContent默认值，表示获取应用最新内容
ByDefaultPublication表示获取应用最新版本
BySpecifiedPublication表示获取应用指定版本
specifiedPublicationVersion
string
否
指定应用版本号；当模式为 BySpecifiedPublication 时提供
specifiedBot
string
否
指定机器人 Id；不填则为任意机器人
params
object
否
应用运行参数键值对，如 { "key": value }
  • 成功响应体（200）
名称
类型
是否必须
描述
isSuccess
boolean
是
是否全部成功
results
array
否
全部成功时返回；每项结构见下表
errors
array
否
任一失败时返回；每项结构见下表
  • results[i]
名称
类型
是否必须
描述
flowId
string
是
应用 Id
flowProcessNo
string
是
启动应用生成的批次号
  • errors[i]
名称
类型
是否必须
描述
flowId
string
是
应用 Id
reason
string
是
业务失败原因（错误码）
  • 失败响应体（400）
名称
类型
是否必须
描述
code
string
是
错误码
description
string
是
错误描述
requestId
string
否
请求追踪 ID
  • 示例请求
POST /api/v1/bots/scheduling/start/batch HTTP/1.1
Authorization: Bearer <token>
EnterpriseId: 64f1e6a2...
Content-Type: application/json

{
  "configs": [
    {
      "flowId": "flow_123",
      "flowContentRetrievalMode": "ByDefaultPublication",
      "specifiedBot": "bot_id_001",
      "params": { "k1": "v1" }
    },
    {
      "flowId": "flow_456",
      "flowContentRetrievalMode": "ByNewestContent",
      "params": { "k2": 10 }
    }
  ]
}
  • 示例全部成功响应
{
  "isSuccess": true,
  "results": [
    { "flowId": "flow_123", "flowProcessNo": "638973212187164151" },
    { "flowId": "flow_456", "flowProcessNo": "638973212187164152" }
  ],
  "errors": null
}
  • 示例任一失败响应（业务失败，整体回滚）
{
  "isSuccess": false,
  "results": null,
  "errors": [
    { "flowId": "flow_456", "reason": "FailedToGetFlow" }
  ]
}
 
最近修改: 2025-11-17