简要描述:

  • 消息通知

请求域名:

  • https://dev8.yunzmall.com/business/1/

未读列表请求接口API:

GET/admin/message/unread

已读列表请求接口API:

GET/admin/message/read

待处理列表请求接口API:

GET/admin/message/waitHandle

参数:

参数名 是否必须 类型 说明
notice_type string 消息类型
plugin string 消息插件标识

返回示例:

正确时返回:

{
    "result": 1,
    "msg": "list",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "uniacid": 6,
                "business_id": 1,
                "recipient_id": 2,
                "operate_id": 1,
                "plugin": "project-manager",
                "notice_type": "1",
                "handle_status": 0,
                "status": 0,
                "created_at": "2022-08-05 17:35:00",
                "message_body": {
                    "head": "将状态更变为:进行中",
                    "title": "测试任务",
                    "content": "",
                    "project_name": "默认项目",
                    "notice_time": "2022-08-05 17:35:00"
                },
                "send_staff": {
                    "id": 2,
                    "uniacid": 6,
                    "business_id": 1,
                    "uid": 2457,
                    "user_id": "",
                    "name": "行圆的",
                    "mobile": "17023456432",
                    "position": "",
                    "gender": 0,
                    "telephone": "",
                    "email": "",
                    "avatar": "vcode=vc1020a663f6887d1a",
                    "alias": "",
                    "status": 0,
                    "qr_code": "",
                    "address": "",
                    "open_userid": "",
                    "main_department": "",
                    "updated_at": null,
                    "created_at": null,
                    "deleted_at": null,
                    "right_type": 0,
                    "disabled": 0,
                    "userid": "",
                    "avatar_mediaid": "vcode=vc1020a663f6887d1a"
                }
            }
        ],
        "first_page_url": "http://demo.yun.cn/business/6/admin/message/unread?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://demo.yun.cn/business/6/admin/message/unread?page=1",
        "next_page_url": null,
        "path": "http://demo.yun.cn/business/6/admin/message/unread",
        "per_page": 20,
        "prev_page_url": null,
        "to": 1,
        "total": 1,
		"unreadMum":1,
		"waitHandleNum":0,
    }
}

错误时返回:

{
  "result": 0,
  "msg": "",
  "data": []
}

data参数说明

参数名 类型 说明
status int 状态:0未读1已读
handle_status int 待处理状态:0已处理1待处理
notice_type int 消息类型
plugin int 插件类型
created_at string 创建时间
send_staff obj 消息发布者
message_body obj 消息内容体
unreadMum int 消息未读数量
waitHandleNum int 消息待处理数量

send_staff参数说明:

参数名 类型 说明
id int 员工ID
name string 员工名称
avatar string 员工头像

message_body参数说明: 这个的格式会根据不同的插件显示不同的

参数名 类型 说明
head string 通知头部标题
title string 通知名称
content string 通知内容
project_name string 项目名称
notice_time string 通知时间

备注:

  • 更多返回错误代码请看首页的错误代码描述