更新时间:2024-07-24 GMT+08:00
分享

消息中心发送消息

操作场景

本章节指导用户通过调用API向用户消息中心发送消息。

操作步骤

  1. 获取接口相关信息:

    URL格式:/knowledge/public/api/v1/messages

  2. 发送“https://ipdcenter.cn-north-4.huaweicloud.com/xxxxx/knowledge/public/api/v1/messages”。

    其中,请求参数如下:

    表1 入参

    参数

    是否必选

    参数类型

    描述

    fromSysId

    String

    来源系统id(与fromSys二选一)

    fromSys

    String

    来源系统名称(与fromSysId二选一)

    fromSysMessageId

    String

    来源系统消息标识(来源系统内唯一)

    fromUserAccountId

    String

    申请人账号id

    sendTime

    String

    申请时间(yyyy-MM-dd HH:mm:ss)

    messageType

    String

    消息类型:

    • CHANGE_NOTIFICATION变更通知
    • SPECIAL_NOTICE特别公告
    • SERVICE_CASES服务案例
    • SERVICE_NOTIFICATION服务通知

    messageSubject

    String

    消息主题

    messageTemplateName

    String

    消息模板名称

    messageData

    String

    消息数据(模板内容填充)

    messageContent

    String

    消息内容(和消息模板二选一)

    messageRedirectUrl

    String

    消息跳转地址

    deliveryType

    String

    消息投递类型:

    • ALL全体消息
    • USER指定用户消息

    receiver

    Array of String

    消息接收者(MessageDeliveryType为USER时需要传user id)

    请求示例(JSON参数)

    [
      {
        "fromSysId": "0",
        "fromSysMessageId": "basic2234567415966011",
        "fromUserAccountId": "1008600000015687941",
        "sendTime": "2023-10-17 11:03:26",
        "messageType": "SERVICE_NOTIFICATION",
        "messageSubject": "消息主题06",
        "messageContent": "消息内容06",
        "messageRedirectUrl": "http://w3.huawei.com/next/indexa.html?locale=zh#path=home",
        "deliveryType": "USER",
        "receiver": "1008600000055320663"
      }
    ]

  3. 在Request Header中增加“X-Auth-Token”。
  4. 查看请求响应结果。

    请求成功时,响应参数如下:

    {
      "errorCode": "0000",
      "errorMsg": "success"
    }

相关文档