爱短链开放平台API
  1. 外链管理
爱短链开放平台API
  • 接入必读
    • 接入必读
  • 短链/外链
    • 短链接
      • 创建短链分组
      • 获取链接分组
      • 获取分组下的短链列表
      • 创建短链
      • 编辑短链
      • 删除短链
    • 外链管理
      • 上传二维码/素材图片
        POST
      • 获取跳转页模板列表
        GET
      • 创建微信外链
        POST
      • 编辑微信外链
        POST
      • 获取微信外链详情
        GET
      • 获取微信外链列表
        GET
      • 获取外链-企微获客链接列表
        GET
      • 获取外链-企微获客链接详情
        GET
      • 用户可选域名列表
        GET
      • 用户可选企微获客链接列表
        GET
      • 删除微信外链(支持批量删除)
        POST
      • 创建外链-企微获客链接
        POST
      • 编辑外链-企微获客链接
        POST
      • 删除外链-企微获客链接(支持批量删除)
        POST
  • 卡片系统
    • 外链管理
      • 获取微信外链列表
      • 创建微信外链
      • 获取微信外链详情
      • 编辑微信外链
      • 删除微信外链(支持批量删除)
      • 获取外链-企微获客链接列表
      • 获取外链-企微获客链接详情
      • 创建外链-企微获客链接
      • 编辑外链-企微获客链接
      • 删除外链-企微获客链接(支持批量删除)
  1. 外链管理

编辑微信外链

POST
/v1/chain/editWxChain
chain_type
💡
1.
调用次数限制:3000次/天;
2.
调用频率限制为:5次/秒;
准备事项
调用此接口前,请先调用以下接口,获取关键参数值:
1
获取 group_id:获取链接分组
2
获取 domain:用户可选域名列表(domain_list.id)
3
获取 channel_list、avatar:上传二维码/素材图片
4
获取 jump_template_id:获取跳转页模板列表(list.id)

请求参数

Query 参数
apikey
string 
必需
接口调用令牌ApiKey
示例值:
8c1331250ede960fd51ac56a829cc6893ce8c000
Body 参数application/json
chain
string 
链接后缀
必需
chain_type
enum<integer> 
链接类型
必需
枚举值:
2
示例值:
2
jump_template_id
integer 
跳转页模板id
必需
0为通用模板
示例值:
0
is_direct_jump
enum<integer> 
跳转页是否直接跳转
必需
枚举值:
01
示例值:
1
chain_title
string 
链接备注
可选
<= 32 字符
默认值:
未命名
qrcode_vc_type
enum<integer> 
二维码访问上限类型
必需
枚举值:
12
示例值:
1
group_id
string 
分组id
必需
示例值:
111
show_type
enum<integer> 
二维码展示页类型
必需
枚举值:
12
示例值:
2
scan_tips
enum<integer> 
扫码引导提示
必需
结合show_type字段使用
枚举值:
01
示例值:
1
avatar
string 
推广头像
可选
show_type为1时生效
示例值:
xxx/xxx/1729760546_70150213689864071744
sub_title
string 
二维码页推广副标题
可选
show_type为1时生效
<= 20 字符
示例值:
副标题内容
desc
string 
推广标题
可选
show_type为1时生效
visit_type
enum<integer> 
二维码切换方式
必需
枚举值:
1345
示例值:
1
channel_list
array [object {8}] 
二维码图片list
必需
id
integer 
图片id
必需
示例值:
111
visit_limit
integer 
二维码访问次数上限
必需
示例值:
9999
qrcode_name
string 
二维码文件名
必需
示例值:
文件原始名称.png
qrcode_time
integer 
二维码有效期
必需
时间戳格式
示例值:
1792831296
sort
integer 
二维码展示优先级
必需
数字越小,优先级越高
>= 1<= 200
示例值:
10
url
string 
二维码文件上传成功后的文件名称
必需
示例值:
1729761919_70418148801369350000
ratio
integer 
跳转比例
必需
visit_type为3时生效
示例值:
20
status
enum<integer> 
二维码展示状态
必需
枚举值:
01
示例值:
1
示例
{
  "chain": "qweqwe",
  "chain_type": "2",
  "show_type": 2,
  "applet_type": 1,
  "sub_title": "",
  "is_direct_jump": 1,
  "jump_template_id": 0,
  "chain_title": "最新的openApi-编辑",
  "bind_device": 1,
  "qrcode_vc_type": 1,
  "scan_tips": 1,
  "avatar": "",
  "desc": "",
  "visit_type": 5,
  "group_id": "988",
  "channel_list": [
    {
      "id": 111,
      "visit_limit": 99999,
      "qrcode_name": "XXX.jpg",
      "qrcode_time": 1792813575,
      "sort": 1,
      "url": "1729741574_9105793205148000000",
      "ratio": 1,
      "status": 1
    }
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.aifabu.com/v1/chain/editWxChain?apikey=8c1331250ede960fd51ac56a829cc6893ce8c000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chain": "qweqwe",
    "chain_type":"2",
    "show_type": 2,
    "applet_type": 1,
    "sub_title": "",
    "is_direct_jump": 1,
    "jump_template_id": 0,
    "chain_title": "最新的openApi-编辑",
    "bind_device": 1,
    "qrcode_vc_type": 1,
    "scan_tips": 1,
    "avatar": "",
    "desc": "",
    "visit_type": 5,
    "group_id": "988",
    "channel_list": [
        {
            "id": 111,
            "visit_limit": 99999,
            "qrcode_name": "XXX.jpg",
            "qrcode_time": 1792813575,
            "sort": 1,
            "url": "1729741574_9105793205148000000",
            "ratio": 1,
            "status": 1
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
code
integer 
返回的状态码
必需
code为1代表接口处理成功
msg
string 
返回的状态信息
必需
result
array[string]
返回的数据
必需
示例
{
  "code": 1,
  "msg": "编辑成功!",
  "result": []
}
修改于 2024-11-01 08:21:56
上一页
创建微信外链
下一页
获取微信外链详情
Built with