QQ空间活动平台前后端交互文档.doc

QQ 空间活动平台前后端交互文档空间活动平台前后端交互文档 QQ 空间空间 对外合作开发组对外合作开发组 腾讯公司腾讯公司 Tencent 腾讯 Page 2 24 Revision History Date Ver AuthorStatus Description 24 Sept 20081 0Spencer LiangCreate 03 June 20091 1Dio Zhang新增异常码列表新增异常码列表 新增接口说明新增接口说明 取好友活动信息接口 免费投票接口 付费 投票接口 投票预检查接口 投票粉丝接口 QQ 空间挂件接口 批量取昵称接口 编辑资料接口 编辑资料预检查接口 修改接口说明修改接口说明 免费注册接口 用户列表数据 Tencent 腾讯 Page 3 24 目录目录 1简介 5 2通用输出控制参数 5 3通用异常处理 5 4身份验证 6 5免费注册接口 6 5 1接口地址 6 5 2参数说明 6 5 3返回结果 6 5 4调用示例 7 6注册预检查接口 7 6 1接口地址 7 6 2参数说明 8 6 3返回结果 8 7取用户个人资料数据接口 8 7 1接口地址 8 7 2参数说明 8 7 3返回结果 8 8登录态检查接口 8 8 1接口地址 8 8 2参数说明 8 8 3返回结果 8 9取好友活动信息接口 9 9 1接口地址 9 9 2参数说明 9 9 3返回结果 9 9 4调用示例 9 10QQ 空间挂件接口 9 10 1接口地址 9 10 2参数说明 9 10 3返回结果 10 11批量取昵称接口 10 11 1接口地址 10 11 2参数说明 10 11 3返回结果 10 12编辑资料接口 10 12 1接口地址 10 12 2参数说明 10 12 3返回结果 11 13编辑资料预检查接口 11 13 1接口地址 11 13 2参数说明 12 13 3返回结果 12 14免费投票接口 12 14 1接口地址 12 14 2参数说明 12 14 3返回结果 12 15付费投票接口 13 15 1接口地址 13 15 2参数说明 13 15 3返回结果 13 Tencent 腾讯 Page 4 24 16投票预检查接口 14 16 1接口地址 14 16 2参数说明 14 16 3返回结果 14 17投票粉丝接口 15 17 1接口地址 15 17 2参数说明 15 17 3返回结果 15 18首页列表数据 15 18 1接口描述 16 18 2接口地址 16 18 3参数说明 16 18 4返回结果 16 19推荐数据 16 19 1接口描述 17 19 2接口地址 17 19 3返回结果 17 19 4示例数据 17 20用户列表数据 18 20 1接口描述 18 20 2接口地址 18 20 3返回结果 18 20 4示例数据 19 21其他接口 19 21 1接口描述 20 21 2接口地址 20 21 3参数说明 20 21 4返回结果 20 21 5示例 20 22异常码列表 20 Tencent 腾讯 Page 5 24 1简介简介 QQ 空间活动平台是对外合作开发组开发出来的用于举办线上活动的一个平台 典型应用是各类选秀活 动 如亚洲小姐网络赛区选举 平台已包括用户注册 资料修改 投票 粉丝列表 用户个人主页 选手列表 首页推荐 排行榜等功 能 还可以通过插件的方式扩展开发出特定的功能 平台对数据的处理分成两大类型 一类是 PHP 脚本 用于写操作如注册 资料修改 投票及实时数据显 示 另一类是 JSON 格式的静态 js 文件 由平台根据设定定时生成各种数据 2通用输出控制参数通用输出控制参数 以下参数可用于活动平台的所有 PHP 脚本 用于控制返回的 JSON 数据的格式 参数名说明参数值 callback回调函数JavaScript 回调函数名 默认值为 JsonCallback domainJavaScript 运行环境域名默认值为 该值必须允许域名的白名单 内 白名单在平台内设置 script是否加上标签只要设置该参数 不管值如何 均加上 标签 unicode是否使用 UNICODE 编码输出只要设置该参数 不管值如何 均使用 UNICODE 编码输出 例如 其中 obj 是 unicode 编码的 json 字符串 3通用异常处理通用异常处理 当平台的 PHP 脚本遇到异常或错误时 会返回一个统一的错误格式数据 示例如下 当设置了 callback 参数时 JsonCallback error type 4103 msg QQ 号格式有错 errcode 4103 以树型显示的 JSON 数据 当没有 callback 参数时 err 4103 msg QQ 号格式有错 以树型显示的 JSON 数据 Tencent 腾讯 Page 6 24 其中 err 为错误代码 msg 为错误信息 4身份验证身份验证 用户注册 资料编辑 投票均需要用户在已登录情况下才能操作 登录态使用公司统一的社区登录系统 ptlogin2 平台根据保存在 cookies 中的资料取得用户登录态并鉴别身份 5免费注册接口免费注册接口 5 1 接口地址接口地址 5 2 参数说明参数说明 参数名方式说明值 act idGET活动 ID 在活动平台管理端创建活动时生成 如 10029 整数 用户资料POST用户资料参数由双方根据活动实际需要事先 确定好注册页面上需要用户填写的项目及格 式 然后由平台方提供具体的参数名及参数 说明 详情见具体活动的开发说明 多种取值 5 3 返回结果返回结果 A 执行成功 返回用户资料 JSON 格式 返回数据包括用户基本资料 平台通用 及用户特定资料 针对不同活动专门设置 其中平台通用的 用户数据及格式说明如下 字段名类型说明 act idint活动 ID 同一活动所有用户统一一个活动 ID qqint用户 QQ 号码 reg timeint注册该活动的时间 unix 时间戳 need auditint是否需要审核 1 需要 0 不需要 is displayint是否显示 1 显示 0 不显示 不显示的用户不会出现在任何列表中 在 个人页也不能查看该用户的信息 edit countint资料编辑次数 edit timeint最后一次编辑资料的时间 unix 时间戳 need audit mint任务中的用户否需要审核 32 位整数 每一位代表一个任务 目前从低位 算起 0 4 位分别代表任务 1 5 is display mint任务中的用户否需要显示 32 位整数 每一位代表一个任务 目前从低位 算起 0 4 位分别代表任务 1 5 edit count 0int任务 1 编辑次数 edit count 1int任务 2 编辑次数 Tencent 腾讯 Page 7 24 edit count 2int任务 3 编辑次数 edit count 3int任务 4 编辑次数 edit count 4int任务 5 编辑次数 edit time 0int任务 1 最后一次编辑时间 unix 时间戳 edit time 1int任务 2 最后一次编辑时间 unix 时间戳 edit time 2int任务 3 最后一次编辑时间 unix 时间戳 edit time 3int任务 4 最后一次编辑时间 unix 时间戳 edit time 4int任务 5 最后一次编辑时间 unix 时间戳 sort0int自定义排序数据 0 sort1int自定义排序数据 1 sort2int自定义排序数据 2 sort3int自定义排序数据 3 sort4int自定义排序数据 4 sort5int自定义排序数据 5 sort6int自定义排序数据 6 sort7int自定义排序数据 7 sort8int自定义排序数据 8 sort9int自定义排序数据 9 B 执行失败 返回如前面所述的统一的错误格式 出差的原因包括但不限于 1 活动未开始 或已经结束 或活动暂停 2 取登录态失败 3 用户未开通 QQ 空间 4 注册资料错误 5 4 调用示例调用示例 注册页面示例 姓名 手机 地址 6注册预检查接口注册预检查接口 检查用户是否可以注册 是否已注册 需要登录态 及加载活动配置 6 1 接口地址接口地址 Tencent 腾讯 Page 8 24 6 2 参数说明参数说明 参数名方式说明值 act idGET活动 ID整数 6 3 返回结果返回结果 A 状态正常 可以注册 返回 JSON 格式数据 code 0 B 异常状态 不可以注册 返回 JSON 格式数据 见上述的通用异常处理说明 7取用户个人资料数据接口取用户个人资料数据接口 7 1 接口地址接口地址 7 2 参数说明参数说明 参数名方式说明值 act idGET活动 ID整数 qqGET参赛用户 QQ整数 留空为取当前已 登录用户 QQ 7 3 返回结果返回结果 A 执行成功 返回跟免费注册接口一样的数据格式 B 执行失败 参考通用异常处理说明 异常的原因可能但不限于 1 活动未开始 已结束或暂停 2 用户没有注册 或未审核 或审核不通过 在主人态模式下可查看未审核用户资料 3 没有指定用户并且没有登录 或已登录的用户没有注册 8登录态检查接口登录态检查接口 8 1 接口地址接口地址 8 2 参数说明参数说明 没有参数 根据用户 cookies 取得登录态信息 8 3 返回结果返回结果 返回 JSON 格式数据 字段名类型说明 Tencent 腾讯 Page 9 24 qqint用户 QQ 号码 0 表示未登录用户 nicknamestr用户昵称 9取好友活动信息接口取好友活动信息接口 9 1 接口地址接口地址 9 2 参数说明参数说明 参数名方式说明值 act idGET活动 ID整数 fqqGET查询的好友 QQ整数 留空为取当前已 登录用户的 QQ 好友列 表中参与活动的那部分 好友 9 3 返回结果返回结果 A 执行成功 返回跟免费注册接口一样的数据格式 只返回注册了活动的好友数据 B 执行失败 参考通用异常处理说明 异常的原因可能但不限于 1 活动未开始 已结束或暂停 2 用户没有登录或者用户没有注册活动 3 查询的 QQ 号码不是登录用户的 QQ 好友或者查询的 QQ 号码是登录用户的好友但并没有注册活动 9 4 调用示例调用示例 返回的是登录用户的所有参与 10064 活动的 QQ 好友数据列表 用户错误 USER ERR 4000 参数为空 PARAM EMPTY 4001 参数类型不对 PARAM BAD TYPE 4002 参数有错 PARAM ERR 4003 上传图片出错 UPLOAD ERR 4050 总大小太大 UPLOAD TOTAL TOO LAGE 4051 单个大小太大 UPLOAD ONE TOO LAGE 4052 图片类型不支持 不对 UNSUPPORT IMG TYPE 4053 图片无法处理 FAIL HANDLE IMG 4054 数字错误 NUM ERR 4100 超过上限 NUM OVERFLOW 4101 低于下限 NUM UNDERFLOW 4102 QQ 号错误 QQ BAD FORMAT 4103 Tencent 腾讯 Page 21 24 字串错误 STR ERR 4200 含有脏话 STR DIRTY 4201 不合格式 STR NO MATCH 4202 不是合法变量名 STR NO SYMBOL 4203 字串过长 STR TOO LONG 4204 URL 地址错误 BAD URL 4205 时间错误 TIME ERR 4300 不是合法的时间 TIME BAD FORMAT 4301 数组元素太少 ARR TOO FEW 4401 数组元素太多 ARR TOO MANY 4402 数组键不是整型 ARR NO INT KEY 4403 用户状态不对 USER STATE ERR 4500 没登录 USER NO LOGIN 4501 没空间 USER NO QZONE 4502 重复报名 USER REPEAT REG 4503 未审核 USER UNAUDIT 4504 没有通过审核 USER FAIL AUDIT 4505 没报名 USER NO REG 4506 不能修改 USER NO MORE EDIT 4507 验证码错误 VERIFY CODE ERR 4508 用户已经开通了 Qzone USER HAS QZONE 4509 用户不是城市达人 USER NO CITYUSER 4510 活动错误 ACT ERR 4600 活动不存在 ACT NO EXIST 4601 活动未开始 ACT UNOPEN 4602 活动结束 停止修改 仍显示 ACT END 4603 活动活动清理 Tencent 腾讯 Page 22 24 ACT CLEAN 4604 活动暂停 ACT PAUSE 4605 活动不能修改 ACT NO EDIT 4606 投票用户 QQ 号码错误 VOTE PLAYERERR 4607 给自己投票 VOTE SELF 4608 QQ 号码不是选手的好友 USER NOT FRIEND 4609 用户还没有写日志 ACT NO WRITING 4610 用户没有粉丝 USER NO FANS 4611 用户无身份 USER NO PRIVILEGE 4612 注册未开始 REG UNOPEN 4613 注册已结束 REG END 4614 投票未开始 VOTE UNOPEN 4615 投票已结束 VOTE END 4616 该任务未开始 MISSION UNOPEN 4617 该任务已结束 MISSION END 4618 该任务不存在 MISSION NO EXIST 4619 该任务不允许修改 MISSION NO EDIT 4620 该任务不允许再次修改 MISSION NO MORE EDIT 4621 修改资料未开始 EDIT UNOPEN 4622 修改资料已结束 EDIT END 4623 付费投票外部插件校验失败 PAYVOTE PLUGIN ERR 4700 付费投票的票数错误 PAYVOTE VOTENUM ERR 4701 付费投票的类型错误 PAYVOTE TYPE ERR 4702 付费投票的数目错误 PAYVOTE NUM ERR 4703 付费投票留言中有非法字符 PAYVOTE WORD DIRTY 4704 付费投票留言长度溢出 PAYVOTE WORD LENERR 4705 付费投票票数上溢出 PAYVOTE NUM OVERFLOW 4706 Tencent 腾讯 Page 23 24 付费投票 qzone 空间积分不够 PAYVOTE QSCORE ERR 4707 付费投加票失败 PAYVOTE ADDVOTE ERR 4708 付费投票扣费失败 PAYVOTE COST FAILED 4709 PAYVOTE ACCT NOENOUGH 4710 PAYVOTE ACCTTYPE ERR 4711 免费投票外部插件校验失败 FREEVOTE PLUGIN ERR 4800 免费投票的票数错误 FREEVOTE VOTENUM ERR 4801 免费投票留言中有非法字符 FREEVOTE WORD DIRTY 4802 免费投票留言长度溢出 FREEVOTE WORD LENERR 4803 免费投票票数上溢出 FREEVOTE NUM OVERFLOW 4804 免费投票 qzone 空间积分不够 FREEVOTE QSCORE ERR 4805 免费投加票失败 FREEVOTE ADDVOTE ERR 4806 五千为系统错误 SYSTEM ERR 5000 系统繁忙 SYSTEM BUSY 5001 上传出错 SYSTEM UPLOAD ERR 5050 无法