Files
pyGoEdge-UserPanel/reference/goedge 文档/MessageService.md
2025-11-18 03:36:49 +08:00

3.1 KiB
Raw Blame History

MessageService

消息相关服务


countUnreadMessages

计算未读消息数

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/MessageService/countUnreadMessages
  • RPCrpc countUnreadMessages (CountUnreadMessagesRequest) returns (RPCCountResponse);

请求对象 (CountUnreadMessagesRequest)

{}

响应对象 (RPCCountResponse)

{
  "count": "int64 // 数量"
}

调用示例

curl -X POST "https://backend.dooki.cloud/MessageService/countUnreadMessages" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

listUnreadMessages

列出单页未读消息

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/MessageService/listUnreadMessages
  • RPCrpc listUnreadMessages (ListUnreadMessagesRequest) returns (ListUnreadMessagesResponse);

请求对象 (ListUnreadMessagesRequest)

{
  "offset": "int64 // 读取位置",
  "size": "int64 // 数量通常不能小于0"
}

响应对象 (ListUnreadMessagesResponse)

{
  "messages": "[]Message"
}

调用示例

curl -X POST "https://backend.dooki.cloud/MessageService/listUnreadMessages" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

updateAllMessagesRead

设置所有消息为已读

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/MessageService/updateAllMessagesRead
  • RPCrpc updateAllMessagesRead (UpdateAllMessagesReadRequest) returns (RPCSuccess);

请求对象 (UpdateAllMessagesReadRequest)

{}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/MessageService/updateAllMessagesRead" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

updateMessageRead

设置消息已读状态

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/MessageService/updateMessageRead
  • RPCrpc updateMessageRead (UpdateMessageReadRequest) returns (RPCSuccess);

请求对象 (UpdateMessageReadRequest)

{
  "messageId": "int64",
  "isRead": "bool"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/MessageService/updateMessageRead" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'

updateMessagesRead

设置一组消息已读状态

  • 角色:admin, user
  • HTTPPOST https://backend.dooki.cloud/MessageService/updateMessagesRead
  • RPCrpc updateMessagesRead (UpdateMessagesReadRequest) returns (RPCSuccess);

请求对象 (UpdateMessagesReadRequest)

{
  "messageIds": "[]int64",
  "isRead": "bool"
}

响应对象 (RPCSuccess)

{}

调用示例

curl -X POST "https://backend.dooki.cloud/MessageService/updateMessagesRead" \
  -H "Content-Type: application/json" \
  -H "X-Edge-Access-Token: <YOUR_TOKEN>" \
  -d '{
    ...
  }'