运营活动-绑定手机号

1. 文档概述

西瓜 SDK 为 CP 提供绑定手机号活动的配置和实现。 绑定手机号活动实现有以下三种方式:

  • 游戏自行制作页面
  • 西瓜定制HTML5页面 + 西瓜提供HTML5页面加载组件
  • 西瓜定制HTML5页面(URL)+ 游戏实现HTML5页面加载组件

CP 可以根据自身的需求选择一种方式进行接入。

1.1 文档结构

  1. 文档概述
  2. 服务端接口
  3. 客户端接口
  4. 绑定手机号活动配置
  5. 错误码列表

2. 服务端接口

2.1 绑定手机通知接口

2.1.1 功能

发起方ActivityServer
接收方GameServer
接口类型HTTP POST Content-Type:application/json; charset=UTF-8
字符集编码UTF-8
安全机制签名
请求地址游戏服务器提供url
功能描述通知游戏手机绑定关系

2.1.2 输入

JSON格式的字符串:

参数必须类型说明
dataString请求对象JSON对象(详见下表Data JSON 对象结构)
typeString类型(填写字符串常量"GIFT")
tsString当前时间戳,秒级,如20150723150028对应2015/7/23 15:00:28
signString签名,签名算法采用HmacSHA1,采用XgsdkServerKey为游戏服务端密钥: 1)传入参数key按字母排序。 2)按key1=value1&key2=value2&...来拼接签名源串,将值为空的参数和sign签名字段去掉,不加入签名源串,key和value不进行任何编码(如不进行URLEncoder)。 然后对最后生成的字符串进行HmacSHA1计算,得到签名串。

Data JSON 对象结构

参数必须类型说明
mobileString手机号
xgAppIdString游戏编号
channelIdString渠道编号
deviceIdString设备编号
serverIdString服务器编号
uidString用户唯一标识
roleIdString角色编号
roleNameString角色名称

2.1.3 输出

返回结果为JSON格式的字符串,分别有如下几个字段:

字段必须类型说明
codeString返回码,参见错误码章节
msgString接口调用信息提示

2.1.4 请求样例

URL:
http://www.xgsdk.com/mock-notify-game
POST Body:
{ "data": { "uid": "jinshan_IMEI123456789", "roleId": "magic", "mobile": "13800138000", "roleName": "wizard", "zoneId": "100", "xgAppId": "99999", "deviceId": "mi_1000000", "serverId": "111", "channelId": "jinshan" }, "sign": "cb11ceceef0c109dd87fca11f10fb6edb8690a75", "ts": "20160523140838", "type": "BIND_MOBILE" }

2.1.5 返回值样例

{"code":"0","msg":"通知游戏成功"}

3.客户端接口

3.1 游戏提供界面

  • Cocos2d绑定手机号(游戏提供界面)
  • Unity3d绑定手机号(游戏提供界面)
  • 原生引擎绑定手机号(游戏提供界面)
  • 4. 绑定手机号活动配置

    • 在西瓜Web控制台选择“运营工具”->“绑定手机号”,进入创建活动页面,点击“新建活动”,如图所示:

    • 输入“活动名称”,选择目标人群,进行下一步

    • 配置活动页面,如果游戏选择的是使用游戏自己的活动页面,则只需要填写“发放奖励URL”、“开始时间”、“结束时间”,进行下一步

    • 可以查看活动详情

      编辑:可以修改活动内容、页面、时间等 删除:可以删除此次活动

    5.错误码列表

    以下错误码提示语为默认提示语,考虑到游戏的类型以及风格的差异,西瓜提供了自定义提示语功能用来满足不同游戏的需求(详情请前往西瓜Web控制台进行配置:“运营工具”->“绑定手机号”->“错误消息配置”)

    错误码值 错误码提示语
    0 绑定成功
    1000 重复绑定
    1001 签名失败
    1002 xgAppId不存在
    1003 渠道编号不存在
    1004 推送任务ID为空
    1005 设备ID为空
    1006 UID为空
    1007 角色ID为空
    1008 角色名为空
    1009 手机号为空
    1010 验证码为空
    1011 验证码错误
    1012 无效的手机号
    1013 活动未创建
    1013 服务器编号为空
    1015 区编号为空
    1016 请求过时
    1017 网络繁忙(SMS请求过于频繁)
    1018 任务已过期
    1019 60秒内只能发送一次手机验证码
    1020 发送验证码失败
    1021 绑定记录不存在
    2000 游戏服务器异常
    2001 游戏服务器返回发放失败
    3000 服务器异常
    3001 系统错误
    3002 发生未知网络错误