Skip to content

活码内容

根据活码 coding 或完整 URL 获取该码的展示内容(元信息与字段列表)。

请求示例

python
import requests

url = 'https://open.cli.im/api/v2/rpc/qrcodes/getContent'
data = {
    'qrcode': 'qk3mJHJ',
    'format': 'json'
}
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/getContent' \
  -H 'Authorization: Bearer <你的API Key>' \
  -H 'Content-Type: application/json' \
  -d '{"qrcode": "qk3mJHJ", "format": "json"}'

响应示例

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "meta": {
      "id": 6763267,
      "title": "示例活码名称",
      "url": "https://qr46.cn/xxx/yyy",
      "coding": "aBcDeFg"
    },
    "fields": [
      {
        "field_id": 1001,
        "type": "text",
        "title": "标题",
        "value": { "value": "示例内容" }
      }
    ]
  }
}

请求详情

qrcode string 必填

活码 coding 或完整 URL,指定要获取内容的活码。


format string 可选

返回格式:jsonmarkdown。默认 json


响应详情

code integer

状态码,0 表示成功。


message string

状态消息。


data object

响应数据。


data.meta object

元信息:

  • title string:活码标题
  • url string:活码访问链接
  • coding string:活码 coding
  • id integer:活码 ID(外部使用的code_id

补充说明:

  • data.meta.id 可直接作为 添加记录 中的 code_id 使用。
  • data.meta.id 也可直接作为 获取记录列表 中的 filters.qrcode.id 使用。
  • 如果需要继续发现该二维码关联了哪些表单,应调用 活码关联操作项列表,并从 element_type=2 的元素中读取 tpl_id

data.fields array

字段列表,每项含 field_idtypetitlevalue(格式随组件类型而定)。


接入建议

常见下游用法:

  1. 只有活码 coding / URL,需要先换取 code_id 时,调用本接口。
  2. 拿到 code_id 后:
  3. 如果还需要知道该码关联了哪些表单,继续调用 活码关联操作项列表

错误码

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