# 长信息转短链

调试工具

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:genShortKey

短key托管类似于短链API,开发者可以通过GenShorten将不超过4KB的长信息转成短key,再通过FetchShorten将短key还原为长信息。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/cgi-bin/shorten/gen?access_token=ACCESS_TOKEN

# 云调用

  • 调用方法:officialAccount.shorten.gen

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

  • 本接口不支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_token

# 请求体 Request Payload

参数名类型必填说明
long_datastring需要转换的长信息,不超过4KB
expire_secondsnumber过期秒数,最大值为2592000(即30天),默认为2592000

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
short_keystring短key,15字节,base62编码(0-9/a-z/A-Z)

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
  "long_data": "loooooong data",
  "expire_seconds": 86400
}

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "short_key": "iTqRJFSEqk9RvPk"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
-1系统错误
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
44002empty post dataPOST 的数据包为空。post请求body参数不能为空。
47001data format error解析 JSON/XML 内容错误;post 数据中参数缺失;参数需以 JSON 字符串格式写在post请求的 body 中,请检查修正后重试
47003参数错误没有传入long_data
9410010long_data长度超过限制存储内容超长度过限制(4KB)
9410011expire_seconds超过限制存储时间超过限制(30天)

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。