shop-back-end/doc/simpread-获取企业永久授权码 - 文档 - 企...

57 lines
3.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

> 本文由 [简悦 SimpRead](http://ksria.com/simpread/) 转码, 原文地址 [developer.work.weixin.qq.com](https://developer.work.weixin.qq.com/document/path/100776) 获取企业永久授权码 最后更新2025/03/10
该 API 用于使用临时授权码换取授权方的永久授权码以及企业信息,临时授权码一次有效。
**请求方式:**POST**HTTPS**
**请求地址:** https://qyapi.weixin.qq.com/cgi-bin/service/v2/get_permanent_code?suite_access_token=SUITE_ACCESS_TOKEN
**请求包体:**
```
{
"auth_code": "auth_code_value"
}
```
**参数说明:**
<table><thead><tr><th>参数</th><th>是否必须</th><th>说明</th></tr></thead><tbody><tr><td>auth_code</td><td></td><td><a href="#10974" rel="nofollow">临时授权码</a>,会在授权成功时附加在 redirect_uri 中跳转回第三方服务商网站,或通过<a href="#14951" rel="nofollow">授权成功通知</a>回调推送给服务商。长度为 64 至 512 个字节。临时授权码一次有效</td></tr></tbody></table>
**返回结果:**
```
{
"errcode":0,
"errmsg":"ok",
"permanent_code": "xxxx",
"auth_corp_info":
{
"corpid": "xxxx",
"corp_name": "name"
},
"auth_user_info":
{
"userid":"aa",
"open_userid":"xxxxxx",
"name":"xxx",
"avatar":"http://xxx"
},
"register_code_info":
{
"register_code":"1111",
"template_id":"tpl111",
"state":"state001"
},
"state":"state001"
}
```
**参数说明:**
<table><thead><tr><th>参数</th><th>说明</th></tr></thead><tbody><tr><td>access_token</td><td>授权方企业access_token, 最长为 512 字节。代开发自建应用安装时不返回。</td></tr><tr><td>expires_in</td><td>授权方企业access_token 超时时间(秒)。代开发自建应用安装时不返回。</td></tr><tr><td>permanent_code</td><td>企业微信永久授权码, 最长为 512 字节</td></tr><tr><td>auth_corp_info</td><td>授权方企业信息</td></tr><tr><td>auth_corp_info.corpid</td><td>授权方企业微信 id</td></tr><tr><td>auth_corp_info.corp_name</td><td>授权方企业名称,即企业简称</td></tr><tr><td>auth_user_info</td><td>授权管理员的信息,可能不返回</td></tr><tr><td>auth_user_info.userid</td><td>授权管理员的 userid可能为空</td></tr><tr><td>auth_user_info.open_userid</td><td>授权管理员的 open_userid可能为空</td></tr><tr><td>auth_user_info.name</td><td>授权管理员的 name可能为空</td></tr><tr><td>auth_user_info.avatar</td><td>授权管理员的头像 url可能为空</td></tr><tr><td>register_code_info</td><td>推广二维码安装相关信息,扫推广二维码安装时返回。成员授权时暂不支持。(注:无论企业是否新注册,只要通过扫推广二维码安装,都会返回该字段)</td></tr><tr><td>register_code_info.register_code</td><td>注册码</td></tr><tr><td>register_code_info.template_id</td><td>推广包 ID</td></tr><tr><td>register_code_info.state</td><td>仅当<a href="#14934" rel="nofollow">获取注册码</a>指定该字段时才返回</td></tr><tr><td>state</td><td>安装应用时,扫码或者授权链接中带的 state 值。详见 state 说明</td></tr></tbody></table>
**state 说明:**
目前会返回 state 包含以下场景:
扫带参二维码授权代开发模版
> 注:旧[获取企业永久授权码](#14942)接口耗时长,若安装应用流程,开发者拿到临时授权码后同步调用获取永久授权码接口,推荐使用该文档中 v2 接口,该接口耗时更短。