活码内容
根据活码 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 可选
返回格式:json 或 markdown。默认 json。
响应详情
code integer
状态码,0 表示成功。
message string
状态消息。
data object
响应数据。
data.meta object
元信息:
titlestring:活码标题urlstring:活码访问链接codingstring:活码 codingidinteger:活码 ID(外部使用的code_id)
补充说明:
data.meta.id可直接作为添加记录中的code_id使用。data.meta.id也可直接作为获取记录列表中的filters.qrcode.id使用。- 如果需要继续发现该二维码关联了哪些表单,应调用
活码关联操作项列表,并从element_type=2的元素中读取tpl_id。
data.fields array
字段列表,每项含 field_id、type、title、value(格式随组件类型而定)。
接入建议
常见下游用法:
- 只有活码
coding/ URL,需要先换取code_id时,调用本接口。 - 拿到
code_id后: - 如果还需要知道该码关联了哪些表单,继续调用
活码关联操作项列表。
错误码
错误码定义见:错误码说明。