ColibriSM API - Documentation

发送消息/图片

请使用此 (https://mariago.site/mobile_api/send_message) API访问发送消息的端点

POST参数

字段	值	说明
session_id	访问令牌ID	例如: de25cc16eb00960f076...
user_id	对话者用户ID	例如: 4567
type	消息类型（文本或图片）	例如: 以下选项之一（text/media）
image	消息图片文件	例如: some-picture.jpeg
message	消息文本（最大长度3000）	例如: `嗨！你好吗？`

成功响应

{
    	"code": 200,
    	"message": "消息已发送",
    	"data": {
    		"id": 49,
    		"sent_by": 7,
    		"sent_to": 78,
    		"owner": true,
    		"message": "图片",
    		"media_file": "http://colibri.loc/upload/images/2020/11/lbEG1WesAJdnqVWuUVSd_21_00ae49e181b4a21f86d2338eed424e7b_image_original.jpg",
    		"media_type": "image",
    		"seen": "0",
    		"deleted_fs1": "N",
    		"deleted_fs2": "N",
    		"time": "2020年11月21日 03:11",
    		"side": "right",
    		"media_name": "COLIBRI-IMG-1605960603"
    	}
    }

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }

    {
    	"code": 400,
    	"message": "对话者ID缺失或无效",
    	"data": []
    }

    {
    	"code": 400,
    	"message": "你没有权限向此聊天发送直接消息",
    	"data": []
    }

    {
    	"code": 400,
    	"message": "你的账户已被此账户屏蔽",
    	"data": []
    }

    {
    	"code": 500,
    	"message": "处理请求时发生错误。请稍后再试。",
    	"data": []
    }

    {
    	"code": 400,
    	"message": "消息的媒体类型无效或缺失",
    	"data": []
    }

获取聊天

请使用此 (https://mariago.site/mobile_api/get_chats) API访问聊天列表端点

GET参数

字段	值	说明
session_id	访问令牌ID	例如: de25cc16eb00960f076...

成功响应

{
        "code": 200,
        "message": "聊天获取成功",
        "data": [
            {
            "user_id": 78,
            "username": "mansurTLs",
            "name": "名字 姓氏",
            "avatar": "http://colibri.loc/upload/default/avatar.png",
            "verified": "0",
            "chat_id": 9,
            "time": "17分钟前",
            "last_message": "y",
            "new_messages": "",
            "chat_url": "http://colibri.loc/conversation/@mansurTLs"
            },
            {"user_id": 34, "username": "jack_nelson", "name": "Jack Nelson", "avatar": "http://colibri.loc/upload/default/avatar.png",…}
        ]
    }

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }

获取消息

请使用此 (https://mariago.site/mobile_api/get_messages) API访问消息列表端点

GET参数

字段	值	说明
session_id	访问令牌ID	例如: de25cc16eb00960f076...
user_id	对话者用户ID	例如: 4567
offset_up	第一条消息偏移ID	仅在加载当前聊天的旧消息时需要。
offset_down	最后一条消息偏移ID	仅在加载当前聊天的新消息时需要。
page_size	每次请求的消息总数限制	推荐: 20

成功响应

{
        "code": 200,
        "data": [
            {
                "id": 86,
                "sent_by": 7,
                "sent_to": 78,
                "owner": true,
                "message": "1",
                "media_file": "",
                "media_type": "none",
                "seen": "0",
                "deleted_fs1": "N",
                "deleted_fs2": "N",
                "time": "2020年11月22日 10:11",
                "side": "right"
            },
            {...}
        ]
    }

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }

    {
        "code": 400,
        "message": "对话者ID缺失或无效",
        "data": []
    }

    {
        "code": 204,
        "message": "未找到数据",
        "data": []
    }

搜索消息

请使用此 (https://mariago.site/mobile_api/search_messages) API访问消息搜索端点

GET参数

字段	值	说明
session_id	访问令牌ID	例如: de25cc16eb00960f076...
user_id	对话者用户ID	例如: 4567
query	搜索关键词	例如: `你好`
page_size	搜索结果行数限制	默认是(50)行
offset_up	第一条消息偏移ID	仅在加载之前的消息时需要。
offset_down	最后一条消息偏移ID	仅在加载下一条消息时需要。

成功响应

{
        "code": 200,
        "total": 1,
        "data":[
            {
                "id": 8,
                "sent_by": 10,
                "sent_to": 5,
                "owner": true,
                "message": "你好！",
                "media_file": "",
                "media_type": "none",
                "seen": "0",
                "deleted_fs1": "N",
                "deleted_fs2": "N",
                "time": "2021年3月23日 11:03",
                "side": "right",
                "media_raw": ""
            }
        ]
    }

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }

    {
        "code": 400,
        "message": "对话者ID缺失或无效",
        "data": []
    }

    {
        "code": 204,
        "data": [],
        "message": "未找到数据"
    }

删除消息

请使用此 (https://mariago.site/mobile_api/delete_message) API访问删除聊天消息的端点

POST参数

字段	值	说明
session_id	访问令牌ID	例如: de25cc16eb00960f076...
message_id	要删除的消息ID	例如: `34`

成功响应

{
        "code": 200,
        "message": "消息删除成功",
        "data": []
    }

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }

    {
        "code": 400,
        "message": "消息ID缺失或无效",
        "data": []
    }

    {
        "code": 400,
        "message": "未找到具有此ID的消息。请检查您的详细信息！",
        "data": []
    }

清除聊天/删除

请使用此 (https://mariago.site/mobile_api/clear_chat) API访问清除和删除聊天历史的端点

POST参数

字段	值	说明
session_id	访问令牌ID	例如: de25cc16eb00960f076...
user_id	对话者用户ID	例如: 4567
delete_chat	清除后删除聊天	例如: 以下选项之一（1/0）

成功响应

{
        "code": 200,
        "message": "聊天删除成功",
        "data": []
    }

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }

    {
        "code": 400,
        "message": "对话者ID缺失或无效",
        "data": []
    }