接口文档

项目地址

用户接口

注册

接口地址: http://xchat.chaisz.xyz/index/user/register
返回格式: json
请求方式: http post

请求参数说明:

名称 类型 必填 说明
email string 用户账号
password string 用户密码
devicetoken string devicetoken

返回参数说明:

名称 类型 说明
参考JSON返回示例 - -

JSON返回示例 :

{
    "code":"200",
    "message":"注册成功!",
    "uid":"100000007"
}

登录

接口地址: http://xchat.chaisz.xyz/index/user/login
返回格式: json
请求方式: http post

请求参数说明:

名称 类型 必填 说明
email string 用户账号
password string 用户密码

返回参数说明:

名称 类型 说明
参考JSON返回示例 - -

JSON返回示例 :

{
"code": "200",
"message": "登录成功!",
"userInfo": {
"id": 100000001,
"email": "1313424@qq.com",
"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": "1313424@qq.com",
"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": "删除成功!"
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,463评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,868评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,213评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,666评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,759评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,725评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,716评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,484评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,928评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,233评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,393评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,073评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,718评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,308评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,538评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,338评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,260评论 2 352

推荐阅读更多精彩内容