果创云开放接口

06105 获取全部会话列表

接口地址:http://api.yesapi.cn/?s=App.Market_ChatMessage.GetAllChatList

接口描述: 获取和全部人的私信会话列表。使用前请先安装私信插件

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试    添加收藏    直接访问接口


接口参数

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包
如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。 企业版支持专属签名算法定制。
uuid字符串可选最大:32UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。
token字符串可选最小:64;最大:64当前登录会员的会话凭证,可通过会员登录接口获得。
page整型可选1最小:1;最大:100第几页
perpage整型可选20最小:1;最大:100分页数量

在线测试

参数是否必填
s 必须
uuid 可选
token 可选
page 可选
perpage 可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

请求(需要登录态):
{你的接口域名}/?s=App.Market_ChatMessage.GetAllChatList&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "list": [
        {
            "chat_message_to_uuid": "8AEA2AF1951C0376EC668A74B8CAA64A",
            "chat_message_data": {
                "content": "I ❤ ⚽ "
            },
            "chat_message_type": "text",
            "chat_message_is_read": 1,
            "chat_message_io": "out",
            "add_time": "2019-08-11 17:12:02",
            "user": {
                "username": "AB君",
                "ext_info": {
                    "yesapi_avatar": "",
                    "nickname": "",
                    "age": "18"
                }
            }
        },
        {
            "chat_message_to_uuid": "5B1CA086F3E9E86F83354191AFB41E9E",
            "chat_message_data": {
                "content": "I love 小白接口!"
            },
            "chat_message_type": "text",
            "chat_message_is_read": 1,
            "chat_message_io": "out",
            "add_time": "2019-08-11 17:12:02",
            "user": {
                "username": "dogstar",
                "ext_info": {
                    "yesapi_avatar": "",
                    "nickname": "",
                    "age": "18"
                }
            }
        }
        ],
            "total": 2
    },
    "msg": "小白开放接口:App.Market_ChatMessage.GetAllChatList"
}

接口使用帮助说明

小白君正在拼命补充中……

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型操作码,0表示成功,9表示插件未安装
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.list字符串私信聊天列表
data.list[].chat_message_to_uuid字符串当前会话的会员uuid
data.list[].chat_message_type字符串消息类型
data.list[].chat_message_io字符串消息方向,in表示自己发出的,out表示收到的
data.list[].add_time字符串消息发送时间
data.list[].chat_message_data对象消息数据结构体
data.list[].chat_message_is_read整型是否已读,0未读1已读
data.list[].user对象用户信息
data.list[].user.username字符串用户账号名
data.list[].user.ext_info对象用户扩展信息
data.total整型私信聊天人数
msg字符串提示信息,面向技术人员的帮助或错误提示信息

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求非法请求,参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 404客户端非法请求接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 500果创云开放接口异常如果出现此错误,请联系技术人员处理1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复
ret = 401客户端非法请求用户未登录,或登录凭证已过期1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口
ret = 406客户端非法请求非法app_key,请核对你所在的接口域名1、在我的套餐查看并核对接口域名
ret = 407客户端非法请求当前应用已过期1、进行续费或续约,延长应用有效期
ret = 408客户端非法请求当前应用存在异常,已被封号1、联系在线客服人工处理
ret = 409客户端非法请求签名错误1、使用在线测试,校正签名;2、关闭特定或全部签名设置;3、如果过期,可以进行续约/升级
ret = 410客户端非法请求权限不足,非系统管理员1、应用权限不足,可联系在线客服咨询沟通
ret = 411客户端非法请求权限不足,应用管理员未登录1、请提供应用管理员的admin_uuid和admin_token参数后重试
ret = 412客户端非法请求权限不足,非应用管理员1、请在果创云开放平台把会员设置为管理员
ret = 413客户端非法请求本月接口流量超出,已被临时冻结1、开通接口流量叠加包,或升级套餐
ret = 414客户端非法请求并发过高1、请降低请求频率,检测是否有死循环调用,或是否被他人恶意使用。如果流量确实很大,可联系在线客服进行定制化或私有云部署。
ret = 415客户端非法请求接口已被开发者关闭1、接口已被开发者关闭,请进入果创云开放平台接口开关重新开启
ret = 416客户端非法请求权限不足,个人免费版套餐无法使用专业版接口1、请先升级终身会员/标准版/旗舰版/企业版

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。