项目地址
用户接口
注册
| 接口地址： | http://xchat.chaisz.xyz/index/user/register |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | 是 | 用户账号 | |
| password | string | 是 | 用户密码 |
| devicetoken | string | 是 | devicetoken |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code":"200",
"message":"注册成功!",
"uid":"100000007"
}
登录
| 接口地址： | http://xchat.chaisz.xyz/index/user/login |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | 是 | 用户账号 | |
| password | string | 是 | 用户密码 |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "登录成功!",
"userInfo": {
"id": 100000001,
"email": "[email protected]",
"nickname": null,
"headimage": null,
"createDate": "1507691095",
"createIp": "::1",
"token": null,
"devicetoken": "151312545454",
"phone": null
}
}
上传头像
| 接口地址： | http://xchat.chaisz.xyz/index/user/uploadheadimage |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uid | string | 是 | 用户id |
| image | file | 是 | 用户头像 |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "上传成功!",
"imageurl": "http://xchat.chaisz.xyz/headimages/20170930/7831bb50ba41230b57302352b4173d09.png"
}
上传头像操作在本地测试一切正常。放到服务器上之后会遇到权限不足的问题。主要是public文件夹和runtime文件夹的权限需要更改。
在调试阶段一定要把错误信息输出给打开，默认是false(关闭)的。（conf.php // 显示错误信息
'show_error_msg' => true,）
修改个人信息
| 接口地址： | http://xchat.chaisz.xyz/index/user/updateinfo |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uid | string | 是 | 用户id |
| phone | string | 是 | 手机号 |
| nickname | string | 是 | 昵称 |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "修改成功!",
"userInfo": {
"id": 100000001,
"email": "[email protected]",
"nickname": "tom",
"headimage": null,
"createDate": "1507691095",
"createIp": "::1",
"devicetoken": "151312545454",
"phone": "17633658036"
}
}
修改密码
| 接口地址： | http://xchat.chaisz.xyz/index/user/updatepassword |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uid | string | 是 | 用户id |
| password | string | 是 | 原密码 |
| newpassword | string | 是 | 新密码 |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "修改成功!"
}
消息接口
绑定socket
| 接口地址： | http://xchat.chaisz.xyz/index/message/bind |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uid | string | 是 | 用户ID |
| client_id | string | 否 | client_id |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": 200,
"message": "success!"
}
发送消息
| 接口地址： | http://xchat.chaisz.xyz/index/message/send_message |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明（to_uid和to_group_id必选一个）：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| from_uid | string | 是 | 发送方ID |
| to_uid | string | 否 | 接收方ID |
| to_group_id | string | 否 | 群组ID |
| content | string | 是 | 内容 |
| type | string | 是 | 类型 |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": 200,
"message": "success!"
}
好友接口
申请添加好友
| 接口地址： | http://xchat.chaisz.xyz/index/friend/apply |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明（：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uid | string | 是 | 用户ID |
| friend_uid | string | 否 | 好友ID |
| content | string | 是 | 介绍内容 |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "申请已发送!"
}
同意申请
| 接口地址： | http://xchat.chaisz.xyz/index/friend/add |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uid | string | 是 | 用户ID |
| friend_uid | string | 否 | 好友ID |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "添加成功!"
}
删除好友
| 接口地址： | http://xchat.chaisz.xyz/index/friend/delete |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 记录ID |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "删除成功!"
}
群组接口
创建群组
| 接口地址： | http://xchat.chaisz.xyz/index/group/create |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明（：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uid | string | 是 | 群主ID |
| groupName | string | 否 | 群名称 |
| introduction | string | 是 | 群介绍 |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "创建成功!"
}
上传logo
| 接口地址： | http://xchat.chaisz.xyz/index/group/uploadimage |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明（：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 群ID |
| image | file | 否 | logo |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "上传成功!",
"Info": "http://xchat.chaisz.xyz/headimages/20171011/e2b9f34c3546116b946cb1bfb65cbe5d.png"
}
申请加群
| 接口地址： | http://xchat.chaisz.xyz/index/group/apply |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明（：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uid | string | 是 | 用户ID |
| group_uid | string | 否 | 群主ID |
| content | string | 是 | 加群原因 |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "申请已发送!"
}
踢出群组
| 接口地址： | http://xchat.chaisz.xyz/index/group/remove |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明（：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uid | string | 是 | 用户ID |
| group_id | string | 否 | 群主ID |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "移出成功!"
}
解散群组
| 接口地址： | http://xchat.chaisz.xyz/index/group/delete |
|---|---|
| 返回格式： | json |
| 请求方式： | http post |
请求参数说明（：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 群ID |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例 ：
{
"code": "200",
"message": "删除成功!"
}