Skip to content

CombinedNotice

Provides a unified entry for users to send messages, such as in-site message, SMS, and email


Send notifications

POST
/api/v1/notice/combined/send

Support in-site message, SMS, and email

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json
JSON
{
"noticeTypes": [
"string"
],
"sendSmsParam": {
"outId": "string",
"bizKey": "SIGNUP",
"urgent": true,
"language": "zh_CN",
"mobiles": [
"string"
],
"templateParams": {
"additionalProperties": "string"
},
"receiveObjectType": "string",
"receiveObjectIds": [
0
],
"receivePolicyCodes": [
"string"
]
},
"sendEmailParam": {
"outId": "string",
"bizKey": "SIGNUP",
"language": "zh_CN",
"type": "CUSTOM",
"subject": "subject",
"toAddress": [
[
"user1@xcancloud.com",
"user2@xcancloud.com"
]
],
"ccAddress": [
[
"demo@xcancloud.com"
]
],
"verificationCode": true,
"verificationCodeValidSecond": "300",
"sendTenantId": 0,
"sendUserId": 0,
"html": true,
"content": "string",
"templateParams": {
"additionalProperties": {
}
},
"attachments": [
{
"name": "string",
"url": "string"
}
],
"receiveObjectType": "string",
"receiveObjectIds": [
0
],
"receivePolicyCodes": [
"string"
],
"batch": "true"
},
"sendInsiteParam": {
"messageId": "string",
"pushMediaType": "string",
"sendUserId": 0,
"sendUserName": "string",
"title": "string",
"content": "string",
"receiveObjectType": "string",
"receiveObjectIds": [
0
]
}
}

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

服务器
授权
主体

示例

cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.