该API用于通过永久授权码换取企业微信的授权信息。
注:接口与 应用授权 - 接口调用 - 获取企业永久授权码 为同一接口。不同点是,若应用接入付费策略,则会额外返回字段,这里仅对额外返回的字段进行说明。
请求方式:POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/service/get_permanent_code?suite_access_token=SUITE_ACCESS_TOKEN
请求包体:
{
"auth_code": "auth_code_value"
}
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
auth_code | 是 | 临时授权码,会在授权成功时附加在redirect_uri中跳转回第三方服务商网站,或通过回调推送给服务商。长度为64至512个字节 |
返回结果:
{
"errcode":0 ,
"errmsg":"ok" ,
..., // 接口返回的其它字段信息说明,可到目录文档 “应用授权 - 接口调用 - 获取企业永久授权码” 查看
"edition_info":
{
"agent":
[
{
"agentid":1,
"edition_id": "RLS65535",
"edition_name": "协同版",
"app_status" : 3,
"user_limit": 200,
"expired_time": 1541990791,
"is_virtual_version" : false,
"is_shared_from_other_corp" :true
}
]
}
}
参数说明:
参数 | 说明 |
---|---|
edition_info | 企业当前生效的版本信息 |
agent | 授权的应用信息,注意是一个数组,但仅旧的多应用套件授权时会返回多个agent,对新的单应用授权,永远只返回一个agent |
edition_id | 版本id |
edition_name | 版本名称 |
app_status | 付费状态。 0-没有付费; 1-限时试用; 2-试用过期; 3-付费版本有效期内; 4-付费版本过期; 5-不限时试用; 6-付费版本有效期内,但是实际使用人数超标,且超标未超过7天; 7-付费版本有效期内,但是实际使用人数超标,且持续超标超过7天 |
user_limit | 用户上限。 特别注意, 以下情况该字段无意义,可以忽略: 1. 固定总价购买 2. app_status = 限时试用/试用过期/不限时试用 3. 在第2条“app_status=不限时试用”的情况下,如果该应用的配置为“小企业无使用限制”,user_limit有效,且为限制的人数 |
expired_time | 版本到期时间(根据购买版本,可能是试用到期时间或付费使用到期时间)。 特别注意,以下情况该字段无意义,可以忽略: 1. app_status = 不限时试用 |
is_virtual_version | 是否虚拟版本 |
is_shared_from_other_corp | 是否由企业互联/上下游分享安装。详见企业互联/上下游 |