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

5.0 KiB
Raw Blame History

MessageTaskService

消息发送任务服务


countMessageTasksWithStatus

计算某个状态的消息任务数量

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/MessageTaskService/countMessageTasksWithStatus
  • RPCrpc countMessageTasksWithStatus(CountMessageTasksWithStatusRequest) returns (RPCCountResponse);

请求对象 (CountMessageTasksWithStatusRequest)

{}

响应对象 (RPCCountResponse)

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

调用示例

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

createMessageTask

创建消息任务

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/MessageTaskService/createMessageTask
  • RPCrpc createMessageTask (CreateMessageTaskRequest) returns (CreateMessageTaskResponse);

请求对象 (CreateMessageTaskRequest)

{
  "messageRecipientId": "int64 // 接收人ID",
  "messageMediaInstanceId": "int64 // 媒介实例ID",
  "user": "string // 用户标识",
  "subject": "string // 标题",
  "body": "string // 内容",
  "isPrimary": "bool // 是否优先发送"
}

响应对象 (CreateMessageTaskResponse)

{
  "messageTaskId": "int64 // 消息任务ID"
}

调用示例

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

deleteMessageTask

删除消息任务

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/MessageTaskService/deleteMessageTask
  • RPCrpc deleteMessageTask (DeleteMessageTaskRequest) returns (RPCSuccess);

请求对象 (DeleteMessageTaskRequest)

{
  "messageTaskId": "int64 // 消息任务ID"
}

响应对象 (RPCSuccess)

{}

调用示例

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

findEnabledMessageTask

读取消息任务状态

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/MessageTaskService/findEnabledMessageTask
  • RPCrpc findEnabledMessageTask (FindEnabledMessageTaskRequest) returns (FindEnabledMessageTaskResponse);

请求对象 (FindEnabledMessageTaskRequest)

{
  "messageTaskId": "int64 // 消息任务ID"
}

响应对象 (FindEnabledMessageTaskResponse)

{
  "messageTask": "MessageTask // 消息任务信息"
}

调用示例

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

listMessageTasksWithStatus

根据状态列出某页任务

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/MessageTaskService/listMessageTasksWithStatus
  • RPCrpc listMessageTasksWithStatus(ListMessageTasksWithStatusRequest) returns (ListMessageTasksWithStatusResponse);

请求对象 (ListMessageTasksWithStatusRequest)

{}

响应对象 (ListMessageTasksWithStatusResponse)

{
  "messageTasks": "[]MessageTask"
}

调用示例

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

sendMessageTask

发送某个消息任务

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/MessageTaskService/sendMessageTask
  • RPCrpc sendMessageTask(SendMessageTaskRequest) returns (SendMessageTaskResponse);

请求对象 (SendMessageTaskRequest)

{
  "messageMediaInstanceId": "int64 // 媒介实例ID",
  "user": "string // 用户标识",
  "subject": "string // 标题",
  "body": "string // 内容"
}

响应对象 (SendMessageTaskResponse)

{
  "isOk": "bool // 是否成功",
  "error": "string // 失败时的提示信息",
  "response": "string // 发送成功后响应内容"
}

调用示例

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

updateMessageTaskStatus

修改消息任务状态

  • 角色:admin
  • HTTPPOST https://backend.dooki.cloud/MessageTaskService/updateMessageTaskStatus
  • RPCrpc updateMessageTaskStatus(UpdateMessageTaskStatusRequest) returns (RPCSuccess);

请求对象 (UpdateMessageTaskStatusRequest)

{}

响应对象 (RPCSuccess)

{}

调用示例

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