Skip to content

活码关联操作项列表

根据活码 coding 或完整 URL,获取该码关联的操作项元素列表。

该接口返回的是扁平化结果

  • data 中每一项代表一个“操作项元素”
  • 如果同一个操作项下配置了多个元素,则会拆成多条记录返回
  • 如果活码未关联任何操作项,返回空数组 []

请求示例

python
import requests

url = "https://open.cli.im/api/v2/rpc/qrcodes/getOperation"
data = {
    "qrcode": "qk3mJHJ"
}
headers = {
    "Authorization": "Bearer <你的API Key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=data, headers=headers)
print(response.text)
bash
curl -X POST 'https://open.cli.im/api/v2/rpc/qrcodes/getOperation' \
  -H 'Authorization: Bearer <你的API Key>' \
  -H 'Content-Type: application/json' \
  -d '{"qrcode":"qk3mJHJ"}'

请求参数

参数类型必填说明
qrcodestring活码 coding 或完整 URL,例如 qk3mJHJhttps://qr61.cn/xxxx/yyy

请求体示例

json
{
  "qrcode": "qk3mJHJ"
}

完整返回示例

json
{
  "code": 0,
  "message": "ok",
  "data": [
    {
      "operation_name": "巡检操作",
      "operation_description": "每日巡检填写",
      "element_type": 2,
      "element_type_title": "填写表单",
      "element_value": 122507
    },
    {
      "operation_name": "巡检操作",
      "operation_description": "每日巡检填写",
      "element_type": 1,
      "element_type_title": "更新状态",
      "element_value": 88001
    }
  ]
}

上例表示该活码关联了一个名为“巡检操作”的操作项,其中包含两个元素:

  • 一个“填写表单”元素,关联表单 ID(tpl_id) = 122507
  • 一个“更新状态”元素,关联状态 ID(state_id) = 88001

响应结构总览

路径类型说明
codeinteger平台状态码,0 表示成功
messagestring状态消息;成功时通常为 ok,也可能为空字符串
dataarray操作项元素列表,返回扁平化数组

data[] 元素字段

字段类型说明
operation_namestring操作项标题
operation_descriptionstring操作项副标题或描述;无值时可能为空字符串
element_typeinteger元素类型,见下方枚举表
element_type_titlestring元素类型中文标题
element_valueinteger|string|object元素关联值,具体含义取决于 element_type

element_type 枚举

element_typeelement_type_title含义element_value 含义
1更新状态将活码更新到某个状态选项状态 ID
2填写表单跳转或关联到某个表单表单模板 ID
3跳转链接跳转到外部链接链接配置值
4更新子码内容更新子码字段内容子码字段配置值
5更新子码内容更新关联码字段内容关联码字段配置值

说明:

  • element_type_title 是服务端直接返回的展示文案。
  • element_type=4element_type=5 的返回标题当前都可能是 更新子码内容,但业务语义并不完全相同。
  • 如果你的程序需要做自动分支判断,建议以 element_type 为准,不要只依赖 element_type_title

接入建议:

  • element_type=2 时,element_value 即关联表单的 tpl_id
  • 拿到 tpl_id 后,建议先调用 获取表单结构 获取字段定义、选项 ID 和提交所需的结构化信息。
  • 如果需要读取该码或该表单的历史记录,可继续调用 获取记录列表
  • 如果需要向该码下的该表单提交新记录,可继续调用 添加记录

空结果示例

当活码存在,但未关联任何操作项,返回如下:

json
{
  "code": 0,
  "message": "ok",
  "data": []
}

错误响应

请求参数非法或活码无法识别时,通常会返回非成功状态,例如:

json
{
  "code": 400,
  "error_code": 0,
  "message": "Invalid qrcode data, need coding or url"
}
json
{
  "code": 400,
  "error_code": 0,
  "message": "Invalid qrcode url"
}
字段类型说明
codeinteger错误状态码,常见为 400
error_codeinteger业务错误码;不同错误场景下可能为不同值
messagestring错误摘要

常见错误场景:

  • 未传 qrcode
  • qrcode 不是合法的活码 URL
  • qrcode 对应的活码不存在

具体错误码定义见:错误码说明