接入说明

  • 用户资料主要提供调用方请求接口的形式,分别为:

    • 查询用户在公益内部的昵称头像:业务主动请求接口,返回该用户在公益内部的昵称头像相关资料信息。如果该用户未进入或授权公益获取用户资料的情况,接口将返回默认昵称头像使用。
  • 用户资料内容

    • 以列表的方式返回用户资料信息,信息包括如下:
      • 昵称
      • 头像
      • 是否是默认头像昵称
  • 接入准备:

    • 接入方需要提供微信开放平台的AppID和负责人(用于申请互转权限时作为审批人),或者QQ互联的AppID,由公益侧提交互转权限的申请,微信/QQ审批通过后,才能使用。注意:如果是微信游戏,则需要通过微信帐号托管平台做接入,参考微信游戏帐号托管
    • 接口使用签名方式,如何生成签名以及用户信息的传递参考接口调用凭证
    • 以上方式涉及业务侧帐号与公益帐号的转换,需要满足以下条件:
      • 腾讯内部已开通帐号互转权限的业务(仅限微信或QQ帐号体系)
      • 外部已开通帐号互转权限的业务(仅限QQ帐号体系)

用户资料字段说明

数据格式: json回包

支持字段: 如下表所示

字段名 类型 含义 举例
nickname string 昵称 e.g. 蓝色の海
avatar string 头像 e.g. https://avatar.gongyi.qq.com/avatar/wMVHxo__9WO9iegoNHnNLc8C-Qd1PQ==__1.png
is_default_profile int 是否是默认头像,1是0否 e.g. 0

接口协议

获取简易用户资料

使用场景: 用于腾讯公益合作的业务平台请求获取简易用户资料

调用凭证: 应用签名

请求方式: POST(HTTPS

需要在header中带上授权业务appid列表

参数 必填 说明
Gy-H-App-User-Id 用户在应用侧的唯一Id
Gy-H-App-User-Type 用户类型,取值如qq或者wechat

请求地址: https://oapi.gongyi.qq.com/api/user_profile/GetSimpleUserProfileForOpen

返回参数:

参数 类型 说明
code int 返回码:0表示成功,其他值表示错误,请参考错误码说明
msg string 错误信息
data object 返回数据
nickname string 用户昵称
avatar string 用户头像,最后一个数值代表正方形头像大小
is_default_profile int 是否是默认头像昵称,1是0否

返回示例:

{
  "code": 0,
  "data": {
    "avatar": "https://test-avatar.gongyi.qq.com/avatar/gongyi__lGHcy0TGcFj90U2vyXyDXw==__1.png",
    "is_default_profile": 1,
    "nickname": "爱心网友"
  },
  "msg": "OK is returned on success.",
  "op_time": 1728724934,
  "trace_id": "c60aa2917c6df6ed54c7233a0851a10b"
}
© 1998 - 2022 Tencent Inc. all right reserved,powered by tencent.更新时间: 2025-03-06 17:00:45

results matching ""

    No results matching ""

    results matching ""

      No results matching ""