API 中心

数字工厂底座

地市云

发送消息

最近更新时间：9/19/2023, 8:29:14 PM作者：andrewren(任豪)

本页目录：

接口描述

接口请求域名 http://iam-api.{工业环境域名}

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeSendMsg

本接口用于发送消息。

输入参数

参数名称 必选 类型 描述
Action 是 String openapi公共参数，本接口取值：DescribeSendMsg
Receivers 是 Array of String 消息接受者数组，可传入多个accountId
ReceiverType 是 Integer 接受者类型
Type 是 Integer 用来标识消息类型分为 0通知，1待办；待办消息可用于提醒用户办理代办事项，应用方可根据具体的产品需求决定发送哪种消息类型
TplType 是 Integer 模版类型分为 0使用模版，1不使用模版
Source 是 Integer 消息模板来源,与TplId确定模板.不使用模版时默认传1009
Title 是 String 消息标题
TplId 否 Integer 消息模板编号,与Source确定模板.
MsgAction 是 Integer 消息最终行为。使用二进制位表示消息行为，第0位是否发送邮件，第1位是否发送短信，第2位是否发送站内信，第3位表示是否发送企业微信
Extra 否 String 扩展字段(未使用)
KvParams 否 Object 消息参数，k-v型参数，可以邮件和站内信模板中以key-value键值对形式替换模板内容。短信模板和企业微信模板无法使用该传参
Params 否 Array of String 消息参数，用来按顺序替换模板内容。在短信模板中是{1},{2}..这种形式(因为使用了腾讯云的短信服务)，在邮件和站内信中是以{{.P1}}，{{.P2}}这种形式。对于企业微信发送消息也仅支持这一种，若模板没有参数，请设置为空数组
TemplateParams 否 map[String]String 消息参数（不推荐），可以在邮件、站内信中以json格式传值，较为方便。但无法用于短信和微信
OpMasterId 否 string 操作用户的账号Id，当信息发送类型是SendType_Type_AllSP时，寻找OpMasterId对应的代理商(有代理商就是给代理商, 没有就是给SP), 进行消息发送信
DefaultContext 否 Arrya of byte 当MsgAction=0x04 时，如果DefaultContext不为 空，则消息显示DefaultContext 的内容(html格式代 码)
ReceiverMails 否 Array of String 消息接受者邮箱
MasterId 否 String 多租户场景下，消息接收者租户ID
MsgAction 内容 详情
0x01 邮件 应用方通过指定的邮件模版向用户发送站内邮件
0x02 短信 第三方应用发送短信给用户
0x04 站内信 消息将显示在消息中心
0x07 All 应用方向用户发送所有消息

KvParams

字段 类型 说明
Key String 模板的key参数
Value Integer 值

ReceiverType

name value means
ReceiverTypeUser 0 发送给普通用户
ReceiverTypeAdmin 1 发送给该主账户下的所有的管理员账户(strategy=20)
SendType_Type_AllSP 2 发送给所有超级管理员(role=10)
SendType_Type_Admin_Manager 3 发送给对应account_id的sp账号
SendType_Type_Email 4 发送给ReceiverMails参数下的邮箱
SendType_Type_Customer_Manager 5 发送给对应account_id的客户经理账号

输出参数

Response

参数名称 类型 描述
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId

示例

示例1 短信

平台代办事项通知 尊敬的平台管理员{1}，您好！ 平台有{2}个任务待处理，其中{3}，请关注。 {4}

输入示例

{
    "Receivers":      ["159xxxxxxx"],
    "ReceiverType" :   0,
    "Type":           0,
    "Source":         0,
    "Title":          "",
    "TplId":          510953,
    "Params":         ["wzj", "100", "176065069531760650695317", "2019-12-31"],
    "MsgAction":      0x02,
    "Extra":          "",
    "KvParams":       null,
    "TemplateParams" : null
}

示例2 邮件+站内信

邮件模板：

课程学习提醒                                                                  
                                                                                     
    尊敬的【平台名】用户，您好！                                                
    您的企业给您下发了学习课程（课程名称：${1}），请点击查看详情。  
                                                                                     
    此致                                                                                                         
                                                                                                                 
     【平台名】

输入示例

{
    "Receivers":      ["560647730515413366"],
    "ReceiverType":   0,
    "Type":           0,
    "Source":         1015,
    "Title":          "课程学习提醒",
    "TplId":          15001, 
    "Params":         ["课程","url"],
    "MsgAction":      0x05,
    "Extra":          "",
    "KvParams":       null,
    "TemplateParams": null
}

输出示例

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}

错误码

以下仅列出了接口业务逻辑相关的错误码

错误码 描述