接口文档-1.0.3
<p>[TOC]</p>
<h2>修订记录</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">版本</th>
<th style="text-align: left;">日期</th>
<th style="text-align: left;">操作内容</th>
<th style="text-align: left;">修订人</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">v1.0.2</td>
<td style="text-align: left;">2018.11.28</td>
<td style="text-align: left;">微信邀请有礼中的游戏缩写<code>tcy</code>调整为<code>tcyapp</code></td>
<td style="text-align: left;">前端：秦露</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">v1.0.1</td>
<td style="text-align: left;">2018.11.27</td>
<td style="text-align: left;">接口完善</td>
<td style="text-align: left;">后端：郭铮</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">v1.0.0</td>
<td style="text-align: left;">2018.11.26</td>
<td style="text-align: left;">接口完善</td>
<td style="text-align: left;">前端：秦露</td>
<td style="text-align: left;">-</td>
</tr>
</tbody>
</table>
<h2>接口文档维护者（前端 秦露）</h2>
<h2>Code约定</h2>
<h3>通用</h3>
<table>
<thead>
<tr>
<th>code</th>
<th>说明</th>
<th>客户端提示信息</th>
</tr>
</thead>
<tbody>
<tr>
<td>0</td>
<td>成功</td>
<td>-</td>
</tr>
<tr>
<td>10001</td>
<td> 未登录</td>
<td></td>
</tr>
<tr>
<td>20001</td>
<td>活动未开始</td>
<td></td>
</tr>
<tr>
<td>20002</td>
<td>活动已结束</td>
<td></td>
</tr>
<tr>
<td>20003</td>
<td>活动被禁用</td>
<td></td>
</tr>
<tr>
<td>20004</td>
<td>活动不存在</td>
<td></td>
</tr>
<tr>
<td>20005</td>
<td>未达到可以领奖的状态(不可领取)</td>
<td></td>
</tr>
<tr>
<td>20006</td>
<td>已领取奖励</td>
<td></td>
</tr>
<tr>
<td>20007</td>
<td>库存不足</td>
<td></td>
</tr>
<tr>
<td>20008</td>
<td>待领取</td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h3>通用约定</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">名称</th>
<th style="text-align: left;">内容</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">协议</td>
<td style="text-align: left;">支持HTTPS/HTTP</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">接口地址</td>
<td style="text-align: left;">开发版：<a href="http://tcyappinvitegift.tcy365.org:1506/">http://tcyappinvitegift.tcy365.org:1506/</a><br>提测版：<a href="http://tcyappinvitegift.tcy365.org:1507/">http://tcyappinvitegift.tcy365.org:1507/</a><br>稳定版：<a href="http://tcyappinvitegift.tcy365.org:1505/">http://tcyappinvitegift.tcy365.org:1505/</a><br> 正式版：<a href="http://tcyappinvitegift.tcy365.com/">http://tcyappinvitegift.tcy365.com/</a> <br>预发版：<a href="http://tcyappinvitegift.tcy365.com:2505/">http://tcyappinvitegift.tcy365.com:2505/</a></td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">Header</td>
<td style="text-align: left;">认证字段：AppKey</td>
<td style="text-align: left;">-</td>
</tr>
<tr>
<td style="text-align: left;">Content-Type</td>
<td style="text-align: left;">application/json;charset=utf-8</td>
<td style="text-align: left;">-</td>
</tr>
</tbody>
</table>
<h2>分享客户端需要的参数（暂时忽略）</h2>
<p><code>分享的连接需要有以下参数</code>：</p>
<table>
<thead>
<tr>
<th style="text-align: left;">字段</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">空</th>
<th>默认</th>
<th>注释</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">abbr</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>游戏缩写</td>
</tr>
<tr>
<td style="text-align: left;">t</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">否</td>
<td>未使用</td>
<td>链接的类型：平台要传到游戏，用来判断来自什么链接</td>
</tr>
<tr>
<td style="text-align: left;">linktype</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">是</td>
<td>为空处理为0</td>
<td>链接类型：0连接，1海报</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">否</td>
<td></td>
<td>分享类型：0微信，1朋友圈</td>
</tr>
<tr>
<td style="text-align: left;">userid</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>玩家id</td>
</tr>
<tr>
<td style="text-align: left;">happy</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">否</td>
<td></td>
<td>玩家欢乐币</td>
</tr>
<tr>
<td style="text-align: left;">actid</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">否</td>
<td></td>
<td>活动id</td>
</tr>
<tr>
<td style="text-align: left;">stime</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">否</td>
<td></td>
<td>客户端分享时间</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>签名</td>
</tr>
<tr>
<td style="text-align: left;">img</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td>头像连接</td>
</tr>
<tr>
<td style="text-align: left;">wxkey</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td></td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">是</td>
<td>为空处理为0</td>
<td>头号玩家标记：0非头号赢家，1头号赢家</td>
</tr>
<tr>
<td style="text-align: left;">unionId</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td>来自微信</td>
<td>微信unionId</td>
</tr>
<tr>
<td style="text-align: left;">invitewxname</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">是</td>
<td></td>
<td>邀请人微信名字，对应游戏方的name</td>
</tr>
<tr>
<td style="text-align: left;">wxname</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">否</td>
<td>来自微信</td>
<td>受邀请人微信名字</td>
</tr>
<tr>
<td style="text-align: left;">authorizetime</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">否</td>
<td></td>
<td>授权时间，取本地时间</td>
</tr>
</tbody>
</table>
<h2>与后端对接需要的接口-活动页面</h2>
<h3>奖品类型(Type)的枚举值说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">数值</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">10</td>
<td style="text-align: left;">5000两银子</td>
</tr>
<tr>
<td style="text-align: left;">20</td>
<td style="text-align: left;">1元话费</td>
</tr>
<tr>
<td style="text-align: left;">30</td>
<td style="text-align: left;">5元话费</td>
</tr>
<tr>
<td style="text-align: left;">40</td>
<td style="text-align: left;">年卡</td>
</tr>
<tr>
<td style="text-align: left;">50</td>
<td style="text-align: left;">188礼包</td>
</tr>
<tr>
<td style="text-align: left;">60</td>
<td style="text-align: left;">288礼包</td>
</tr>
<tr>
<td style="text-align: left;">70</td>
<td style="text-align: left;">388礼包</td>
</tr>
<tr>
<td style="text-align: left;">80</td>
<td style="text-align: left;">2888礼包</td>
</tr>
</tbody>
</table>
<h3>请求头信息</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">UserId</td>
<td style="text-align: left;">number</td>
<td>用户ID</td>
</tr>
<tr>
<td style="text-align: left;">UserName</td>
<td style="text-align: left;">string</td>
<td>用户名</td>
</tr>
<tr>
<td style="text-align: left;">system</td>
<td style="text-align: left;">number</td>
<td>系统</td>
</tr>
<tr>
<td style="text-align: left;">tcyVersion</td>
<td style="text-align: left;">string</td>
<td>同城游版本名</td>
</tr>
<tr>
<td style="text-align: left;">tcyCode</td>
<td style="text-align: left;">string</td>
<td>同城游版本号</td>
</tr>
<tr>
<td style="text-align: left;">soVersion</td>
<td style="text-align: left;">string</td>
<td>引擎版本</td>
</tr>
<tr>
<td style="text-align: left;">tcyPromoter</td>
<td style="text-align: left;">string</td>
<td>同城游渠道号</td>
</tr>
<tr>
<td style="text-align: left;">tcyPackage</td>
<td style="text-align: left;">string</td>
<td>同城游包名</td>
</tr>
<tr>
<td style="text-align: left;">network</td>
<td style="text-align: left;">string</td>
<td>网络类型 mobile或WiFi</td>
</tr>
<tr>
<td style="text-align: left;">IMEI</td>
<td style="text-align: left;">string</td>
<td>设备识别号</td>
</tr>
<tr>
<td style="text-align: left;">timestamp</td>
<td style="text-align: left;">string</td>
<td>时间戳</td>
</tr>
<tr>
<td style="text-align: left;">checkcode</td>
<td style="text-align: left;">string</td>
<td>校验码</td>
</tr>
<tr>
<td style="text-align: left;">Province</td>
<td style="text-align: left;">string</td>
<td>省名</td>
</tr>
<tr>
<td style="text-align: left;">City</td>
<td style="text-align: left;">string</td>
<td>市名</td>
</tr>
<tr>
<td style="text-align: left;">District</td>
<td style="text-align: left;">string</td>
<td>地区名</td>
</tr>
</tbody>
</table>
<h3>接口1:获取活动初始化信息</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong>
<code>api/doubleactivity/getactivity</code></p>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong>
<code>get</code></p>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>StartTime</td>
<td>number</td>
<td>开始时间,时间戳</td>
<td>-</td>
</tr>
<tr>
<td>EndTime</td>
<td>number</td>
<td>时间戳</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":{ //数据
"StartTime": 0, // 开始时间,时间戳
"EndTime": 0 // 结束时间,时间戳
},
"Message":""
}</code></pre>
<p>备注：
20001 ：活动未开始
20002 ：活动已结束
20003 ：活动被禁用
20004 ：活动不存在</p>
<h3>接口2:获取邀请有礼的基本信息</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong>
<code>api/doubleactivity/getinvitedgiftinfo</code></p>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>get</code></p>
<p><strong>请求参数：</strong>
<code>无</code></p>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>InviteCount</td>
<td>number</td>
<td>邀请人数</td>
<td>-</td>
</tr>
<tr>
<td>ObtainSilver</td>
<td>number</td>
<td>获得银子</td>
<td>-</td>
</tr>
<tr>
<td>- Awards</td>
<td>array</td>
<td>奖品:的排序按照原型图的顺序依次返回(从左到右、从上到下)</td>
<td>-</td>
</tr>
<tr>
<td>NewItemID</td>
<td>number</td>
<td>物品id</td>
<td>-</td>
</tr>
<tr>
<td>PrizeSurplusNum</td>
<td>number</td>
<td>奖品库存剩余数量</td>
<td>-</td>
</tr>
<tr>
<td>AwardType</td>
<td>number</td>
<td>奖品类型:10、5000两银子 20、1元话费 30、5元话费 40、年卡 50、188礼包 60、288礼包 70、388礼包 80、2888礼包</td>
<td>-</td>
</tr>
<tr>
<td>Status</td>
<td>number</td>
<td>奖品领取状态:20008待领取,20005不可领取,20006已领取,20007已领完(库存不足)</td>
<td>-</td>
</tr>
<tr>
<td>- GradientAwards</td>
<td>object</td>
<td>下一个可领取的梯度奖励</td>
<td>特别说明，如果没有下一个可领取的梯度奖励，该字段为<code>null</code></td>
</tr>
<tr>
<td>AgainInviteCount</td>
<td>number</td>
<td>再邀请人数</td>
<td>-</td>
</tr>
<tr>
<td>AwardType</td>
<td>number</td>
<td>奖品类型:根据约定的枚举值来</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":{ //数据
"InviteCount":12, // 邀请人数
"ObtainSilver":5000, // 固定奖励银子单位：5000/人
"Awards":[{ // 奖品:的排序按照原型图的顺序依次返回
"NewItemID": 1, // 物品id
"PrizeSurplusNum": 0, // 奖品库存剩余数量
"AwardType": 1, // 奖品类型:根据约定的枚举值来
"Status": 0 // 奖品领取状态:20008待领取,20005不可领取,20006已领取,20007已领完(库存不足)
}],
"GradientAwards":{ // 下一个可领取的梯度奖励，如果不存在，则为null
"AgainInviteCount": 0, // 邀请人数
"AwardType": 1 // 奖品类型:根据约定的枚举值来
}
},
"Message":""
}</code></pre>
<h3>接口3:领取奖励</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong>
<code>api/doubleactivity/getprize</code></p>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>post</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>newItemId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>物品id</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"newItemId": 1, // 物品id
}</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>RedemptionCode</td>
<td>string</td>
<td>兑换码</td>
<td>特别说明：只有当领取的是旅游年卡的时候，该字段有数据，其余情况该字段为空字符串</td>
</tr>
<tr>
<td>awardType</td>
<td>number</td>
<td>奖品类型</td>
<td>奖品类型:10、5000两银子 20、1元话费 30、5元话费 40、年卡 50、188礼包 60、288礼包 70、388礼包 80、2888礼包</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":{ //数据
"RedemptionCode":"SSDDSD", // 兑换码
"awardType":1, //奖品类型:10、5000两银子 20、1元话费 30、5元话费 40、年卡 50、188礼包 60、288礼包 70、388礼包 80、2888礼包
},
"Message":""
} </code></pre>
<h3>接口4:话费领取（填写信息）</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong>
<code>api/doubleactivity/savecallcharge</code></p>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>post</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>newItemId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>物品id</td>
<td>-</td>
</tr>
<tr>
<td>Phone</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>电话号码</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"newItemId": 1, // 奖品id
"Phone":18723860669 // 电话号码
}</code></pre>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":{ //数据
"awardType": 1, // 奖品类型:根据约定的枚举值来
},
"Message":""
}</code></pre>
<h3>接口5:礼包领取（填写信息）</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong>
<code>api/doubleactivity/savegiftpackage</code></p>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>post</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>newItemId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>物品id</td>
<td>-</td>
</tr>
<tr>
<td>Recipient</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>收件人</td>
<td>-</td>
</tr>
<tr>
<td>Mobile</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>电话号码</td>
<td>-</td>
</tr>
<tr>
<td>Address</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>地址</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"newItemId": 1, // 物品id
"Recipient":"阿西吧", // 收件人
"Mobile":18723860669, // 电话号码
"Address":"畅唐网络" // 地址
}</code></pre>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":{ //数据
awardType:1, //奖品类型:10、5000两银子 20、1元话费 30、5元话费 40、年卡 50、188礼包 60、288礼包 70、388礼包 80、2888礼包
},
"Message":""
}</code></pre>
<h2>与后端对接需要的接口-微信邀请有礼页面</h2>
<h3>接口1:获取活动基本信息</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li>/api/invite/activity</li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>get</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>abbr</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>游戏缩写【tcyapp】</td>
<td>-</td>
</tr>
<tr>
<td>activityId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>活动id【固定】</td>
<td>-</td>
</tr>
<tr>
<td>unionId</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>微信unionId</td>
<td>-</td>
</tr>
<tr>
<td>type</td>
<td>number</td>
<td>是</td>
<td>""</td>
<td>0非头号赢家【使用】，1头号赢家</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"abbr":"", //游戏缩写
"activityId":0 , //活动id
"unionId":2324,
"type":0
}
</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>AvatarPicture</td>
<td>string</td>
<td>微信头像【固定】</td>
<td>-</td>
</tr>
<tr>
<td>Title</td>
<td>string</td>
<td>文案:头像旁的文案【固定】</td>
<td>-</td>
</tr>
<tr>
<td>GameLogo</td>
<td>string</td>
<td>游戏logo【固定】</td>
<td>-</td>
</tr>
<tr>
<td>GameName</td>
<td>string</td>
<td>游戏名【同城游】</td>
<td>-</td>
</tr>
<tr>
<td>Abbr</td>
<td>string</td>
<td>游戏名缩写【tcyapp】</td>
<td>-</td>
</tr>
<tr>
<td>InviteBgPicUrl</td>
<td>string</td>
<td>邀请的宣传图</td>
<td>-</td>
</tr>
<tr>
<td>DownLoadType</td>
<td>number</td>
<td>下载类型:区分下载包1和下载页面地址0</td>
<td>-</td>
</tr>
<tr>
<td>IosDownLoadUrl</td>
<td>string</td>
<td>ios下载地址或者下载页面地址</td>
<td>-</td>
</tr>
<tr>
<td>AndroidDownLoadUrl</td>
<td>string</td>
<td>Android下载地址或者下载页面地址</td>
<td>-</td>
</tr>
<tr>
<td>RuleContent</td>
<td>string</td>
<td>规则描述【配置无就是固定，有就是获取后台配置】</td>
<td>-</td>
</tr>
<tr>
<td>PosterPicUrl</td>
<td>string</td>
<td>海报背景宣传图</td>
<td>-</td>
</tr>
<tr>
<td>InvitePicUrl</td>
<td>string</td>
<td>邀请有礼图片链接</td>
<td>-</td>
</tr>
<tr>
<td>LimitNum</td>
<td>nuber</td>
<td>限制次数</td>
<td>-</td>
</tr>
<tr>
<td>AcceptStatus</td>
<td>nuber</td>
<td>（new）领奖状态：0可以领奖，101已经领奖<br/>（old废弃）领奖状态：0可以领奖，101已经领奖，102领奖失败（无）</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code": 0, //code值
"Data": { //数据
"AvatarPicture": "", // 微信头像
"Title": "", // 文案:头像旁的文案
"GameLogo": "", // 游戏logo
"GameName": "", // 游戏名
"Abbr": "", // 游戏名缩写
"InviteBgPicUrl": "", // 邀请的宣传图
"DownLoadType": 0, // 下载类型:区分下载包1和下载页面地址0
"IosDownLoadUrl": "", //ios下载地址或者下载页面地址
"AndroidDownLoadUrl": "", //Android下载地址或者下载页面地址
"RuleContent": "" ,//规则描述
"PosterPicUrl":"海报背景宣传图",
"InvitePicUrl": "邀请有礼图片链接",
"LimitNum":3,
"AcceptStatus":0
},
"Message": ""
}</code></pre>
<h3>接口2:邀请人和受邀人关系绑定接口</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>进入页面，非头号赢家领取奖励触发</li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li>/api/invite/bindmapping</li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>post</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>Abbr</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>游戏缩写【tcyapp】</td>
<td>-</td>
</tr>
<tr>
<td>SourceType</td>
<td>int</td>
<td>是</td>
<td>""</td>
<td>分享来源【区分是微信还是朋友圈】</td>
<td>-</td>
</tr>
<tr>
<td>InviteUid</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>邀请人用户Id【无】</td>
<td>-</td>
</tr>
<tr>
<td>InviteWxName</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>邀请人微信昵称【无】</td>
<td>-</td>
</tr>
<tr>
<td>InvitedUnionid</td>
<td>string</td>
<td>是</td>
<td>0</td>
<td>受邀请人unionId</td>
<td>-</td>
</tr>
<tr>
<td>WxName</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>受邀请人昵称</td>
<td>-</td>
</tr>
<tr>
<td>GameTotalTime</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>游戏时长值【0】</td>
<td>-</td>
</tr>
<tr>
<td>HappyValue</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>欢乐点【0】</td>
<td>-</td>
</tr>
<tr>
<td>Sign</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>签名【需要生成】</td>
<td>-</td>
</tr>
<tr>
<td>AuthorizeTime</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>授权时间</td>
<td>-</td>
</tr>
<tr>
<td>ShareTime</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>分享时间</td>
<td>-</td>
</tr>
<tr>
<td>ActivityId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>活动id【固定】</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"Abbr":"", //游戏缩写
"SourceType": 0, //分享来源
"InviteUid":0, //邀请人用户Id
"InviteWxName": "", //邀请人微信昵称
"InvitedUnionid": "", // 受邀请人unionId
"WxName": "", //受邀请人昵称
"GameTotalTime": 0, //游戏时长值
"happyvalue":0, //欢乐点
"Sign": "", //签名
"AuthorizeTime": 0, //授权时间
"ShareTime": 0, // 分享时间
"ActivityId": 0 // 活动id
}</code></pre>
<p>备注：签名规则按照下边的这种格式：
（"Abbr&SourceType&InviteUid&InvitedUnionid&D92B4F5BA37631F5"）.ToMD5()，游戏方直接提供</p>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>Data</td>
<td>number</td>
<td>0</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":0,
"Message":""
}
</code></pre>
<h3>接口3:获取APP下载地址</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li>/api/invite/appurl</li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>get</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>abbr</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>游戏缩写</td>
<td>-</td>
</tr>
<tr>
<td>activityid</td>
<td>number</td>
<td>是</td>
<td>""</td>
<td>活动id</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"abbr":"", //游戏缩写
"activityid": "" //游戏id
}</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>DownLoadType</td>
<td>number</td>
<td>下载类型:1下载包地址,0下载页面地址</td>
<td>-</td>
</tr>
<tr>
<td>IosDownLoadUrl</td>
<td>string</td>
<td>ios下载包或者下载页面地址</td>
<td>-</td>
</tr>
<tr>
<td>AndroidDownLoadUrl</td>
<td>string</td>
<td>安装下载包或者下载页面地址</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":{ //数据
"DownLoadType": 0, // 下载类型:1下载包地址,0下载页面地址
"IosDownLoadUrl": "", // ios下载包 或者 下载页面地址
"AndroidDownLoadUrl": "" // 安装下载包 或者 下载页面地址
},
"Message":""
}
</code></pre>
<p>备注：这个接口不区分活动的状态，如是否在活动期间！</p>
<h3>接口4:领奖接口</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>(接口介绍) </li>
</ul>
<p><strong>请求url：</strong></p>
<ul>
<li>/api/invite/award</li>
</ul>
<p><strong>适用版本：</strong> </p>
<ul>
<li>[v1.0+]</li>
</ul>
<p><strong>请求方式：</strong> </p>
<p><code>get</code></p>
<p><strong>请求参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必选</th>
<th>默认值</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>Abbr</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>游戏缩写【tcyapp】</td>
<td>-</td>
</tr>
<tr>
<td>unionId</td>
<td>string</td>
<td>是</td>
<td>""</td>
<td>微信unionId</td>
<td>-</td>
</tr>
<tr>
<td>ActivityId</td>
<td>number</td>
<td>是</td>
<td>0</td>
<td>活动id【固定】</td>
<td>-</td>
</tr>
<tr>
<td>Type</td>
<td>number</td>
<td>是</td>
<td>""</td>
<td>0非头号赢家【使用】，1头号赢家</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求示例：</strong></p>
<pre><code>{
"Abbr":0, //游戏缩写
"unionId":"", //微信unionId
"type":0 ,// 0非头号赢家，1头号赢
"activityId":0 // 活动id
}
</code></pre>
<p><strong>返回参数：</strong></p>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>说明</th>
<th>限制长度</th>
</tr>
</thead>
<tbody>
<tr>
<td>AwardTip</td>
<td>string</td>
<td>奖励【返回有则显示，否则显示默认的】</td>
<td>-</td>
</tr>
<tr>
<td>- Gifts</td>
<td>array</td>
<td>-</td>
</tr>
<tr>
<td>ItemID</td>
<td>number</td>
<td>-</td>
</tr>
<tr>
<td>Number</td>
<td>number</td>
<td>-</td>
</tr>
<tr>
<td>Name</td>
<td>string</td>
<td>-</td>
</tr>
<tr>
<td>UnitName</td>
<td>string</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>返回示例：</strong></p>
<pre><code>{
"Code":0, //code值
"Data":{ //数据
"AwardTip":"dsa",
"Gifts": [{
"ItemID": 21617,
"Number": 10,
"Name": "欢乐币",
"UnitName": "张"
}]
},
"Message":""
}
</code></pre>
<p>备注：
已领过奖：Code的值20006
<del>领奖失败：Code的值102</del></p>