v3/photo/get_portrait_url

调用本接口前,请按照模版提交API接口权限申请(申请方式详见这里),以获取接口调用权限。

目录

What's New?

2012年11月13日起,应用获取到的用户头像URL的有效期,由2个小时调整为长期有效,应用不需要再重复调用本接口。

1 功能说明

1. 接口功能:获取用户当前使用的应用头像URL或历史头像URL。

2. 功能描述:
(1)为支持某些应用中希望使用用户个性化头像的需求(例如交友类应用希望使用用户的真实头像),特别提供上传用户自定义头像接口(fusion2.dialog.uploadPortrait)。
(2)用户在应用中上传成功头像后,应用通过调用本接口获取用户当前使用的应用头像URL或历史头像URL,然后通过访问URL获取并展现图片。

3. 接口调用限制:
本接口目前支持空间平台和朋友平台。

2 接口调用说明

2.1 URL

http://[域名]/v3/photo/get_portrait_url

正式环境域名或测试环境IP详见:API3.0文档#请求URL说明

2.2 格式

json

2.3 HTTP请求方式

GET, POST

2.4 IP限制

TRUE

2.5 输入参数说明

各个参数请进行URL 编码,编码时请遵守 RFC 1738

(1)公共参数
发送请求时必须传入公共参数,详见公共参数说明

(2)私有参数

参数名称 是否必须 类型 描述
pic_size 必须 string 需要获取的头像尺寸,取值可以为30,50,100。
id string 头像ID。取值与调用本接口返回的字段“portrait_num”相关,如果用户上传的头像总数为8,则“id”取值范围为1-8。

可以为空,为空时返回当前头像;id=1时,也返回当前头像;
其他值返回历史头像,例如id取值为3,则代表获取倒数第3次用户上传的头像。

2.6 请求示例

http://openapi.tencentyun.com/v3/photo/get_portrait_url?
openid=B624064BA065E01CB73F835017FE96FA&
openkey=5F154D7D2751AEDC8527269006F290F70297B7E54667536C&
appid=2&
pf=qzone&
format=json&
userip=112.90.139.30&
pic_size=50&
id=1&
sig=9999b41ad0b688530bb1b21c5957391c

2.7 返回参数说明

参数名称 描述
ret 返回码。

私有返回码如下:
2001:要获取的头像不存在。
公共返回码详见:公共返回码说明#OpenAPI V3.0 返回码

msg 如果错误,返回错误信息。
is_lost 判断是否有数据丢失。如果应用不使用cache,不需要关心此参数。

0或者不返回:没有数据丢失,可以缓存。
1:有部分数据丢失或错误,不要缓存。

portrait_url 获取的用户头像url。
portrait_num 当前用户上传的头像总数。

2.8 正确返回示例

JSON示例:

Content-type: text/html; charset=utf-8
{
  "ret":0,   
  "is_lost":0,   
  "portrait_url":"http://p.qlogo.cn/openapp3rd/10883/5BA61AE/50",
  "portrait_num": 8
} 

2.9 错误返回示例

Content-type: text/html; charset=utf-8
{
  "ret":2001,
  "msg":"portrait data does not exist." 
}

以上信息是否解决您的问题?

Copyright © 1998 - 2019 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部