# 上报角色信息

# 1、接口说明

当有用户登录游戏服成功、创角成功、角色升级（如游戏无角色等级概念，可为关卡等级）、充值成功（并非所有充值渠道都具有客户端回调，充值且发货成功应以游戏服务端下发通知为准）时，均需调用此接口进行数据上报。

sdk.uploadRoleInfo(params, callback);

注意事项

通过本接口所上报的角色信息，涉及SDK心跳机制、第三方SDK数据上报等内容，请务必保证上报数据的真实性、有效性！

# 2、参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
type	string	是	-	上报类型 `LOGIN_GAME` - 登录游戏服 `CREATE_ROLE` - 创角 `LEVEL_UP` - 升级 `PAY_SUCCESS` - 充值成功
roleCreateTime	number	是	-	角色创建时间，精确到秒（秒级时间戳）
areaId	string	是	-	游戏区服ID
areaName	string	是	-	游戏区服名称
roleId	number	是	-	角色ID
roleName	string	是	-	角色名称
roleLevel	number	是	-	角色等级，无角色等级传关卡
roleBalance	number	是	0	角色游戏内货币余额，默认值为 `0`
roleVipLevel	number	是	-	角色VIP等级
partyId	number	否	1	公会/社团ID，默认值为 `1`
partyName	string	否	-	公会/社团名称
roleGender	number	否	-	`0`：未知， `1`：男性，`2`：女性，`3`：其他
rolePower	number	否	0	角色战力，默认值为 `0`
partyRoleId	number	否	-	角色在帮派中的ID，默认值为空
partyRoleName	string	否	-	角色在帮派中的名称，默认值为空
roleProfessionId	number	否	-	角色职业ID，默认值为空
roleProfessionName	string	否	-	角色职业名称，默认值为空
roleFriendList	array	否	-	角色好友列表，默认值为空
partyId	number	否	1	公会/社团ID，默认值为 `1`
partyName	string	否	-	公会/社团名称
channelRoleSign	string	是	-	角色信息加密串，上架为官方H5、官方微端包时此参数可忽略！部分第三方渠道要求加密传送角色信息以防止玩家篡改信息，如快快玩H5、X游戏H5、芭芭游H5、七七手游H5、爱奇游H5等，猛击查看详情。 1、提供一个渠道签名KEY，快快玩H5、X游戏H5、芭芭游H5、七七手游H5、爱奇游H5这几个渠道都可以填同一个KEY 2、文档上的签名拼接串，字段名和顺序不要变，服务端一定要做数据防篡改校验 3、签名串 $content 中的 uid=userInfo.userExtraInfo.openId、username=userInfo.userExtraInfo.userName 4、客户端调用 uploadRoleInfo 方法上报时，要先拿到服务端给到的签名，然后赋值给 channelRoleSign 属性
itemId	string	是	--	商品ID，仅在 `type` 为 `PAY_SUCCESS` 时必填！
itemName	string	是	--	商品名称，仅在 `type` 为 `PAY_SUCCESS` 时必填！
orderId	string	是	--	订单唯一编号，仅在 `type` 为 `PAY_SUCCESS` 时必填！
orderPrice	number	是	--	商品总价，即实际支付价格，单位为分！仅在 `type` 为 `PAY_SUCCESS` 时必填！
currency	string	否	CNY	货币类型，仅在 `type` 为 `PAY_SUCCESS` 时选填！ `CNY` - 人民币 `USD` - 美元
payType	string	否	weixinpay	支付方式，仅在 `type` 为 `PAY_SUCCESS` 时选填！ `weixinpay` - 微信支付 `alipay` - 支付宝 `yeepay` - 易宝支付 `unionpay` - 银联

# 3、示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

sdk.uploadRoleInfo({
  type: "CREATE_ROLE", // 登录游戏服时传LOGIN_GAME，创角时传CREATE_ROLE，升级时传LEVEL_UP，充值成功时传PAY_SUCCESS
  roleCreateTime: 1490598150, // 角色创建时间，精确到秒（秒级时间戳）
  areaId: "1001", // 游戏大区ID
  areaName: "1区", // 游戏大区名称
  roleId: 1, // 角色ID
  roleName: "小朋友", // 角色名
  roleLevel: 1, // 角色等级
  roleBalance: 100, // 角色游戏内货币余额
  roleVipLevel: 1, // 角色VIP等级
  partyId: 1, // 公会/社团ID
  partyName: "虎头帮", // 公会/社团名称
  roleGender: 1, // 角色性别，0：未知，1：男性，2：女性，3：其他
  rolePower: 100, // 角色战力
  partyRoleId: 1, // 角色在帮派中的ID
  partyRoleName: "虎头帮帮主", // 角色在帮派中的名称
  roleProfessionId: 1, // 角色职业ID
  roleProfessionName: "武士", // 角色职业名称
  roleFriendList: "", // 角色好友列表
  channelRoleSign: "xxxxxxxxxxxxxxxxxxxx", // 角色信息加密串，官方H5、官方微端忽略，不用传，部分第三方渠道要求加密传送角色信息以防止玩家篡改信息，如快快玩H5、X游戏H5、芭芭游H5、七七手游H5、爱奇游H5等
  // 以下参数仅在 type 为 PAY_SUCCESS 时所需，以上为通用参数
  itemId: "com.dh.test", // 商品ID
  itemName: "60钻石", // 商品名称
  orderId: "xxxxxxxxxx", // 订单唯一编号
  orderPrice: 600, // 商品总价，即实际支付价格，单位为分！！！
  currency: "CNY", // 货币类型
  payType: "weixinpay" // 支付方式
}, params => { // 数据上报完成时的回调函数
  console.log(params);
});

← 隐私协议数据统计 →