发送站内通知

权限

身份管理API是以应用维度授权的，在调用接口前需为不同的应用设置接口权限，详情请参考API权限。

权限代码	描述
app_notice_msg	应用侧消息通知管理权限
all	全部接口读写权限

请求说明

POST https://{your_domain}/api/v2/tenant/notice/insite/asyncSend

请求头

参数名	中文名称	必须	类型	描述
Authorization	授权	是	String	格式：Bearer {access_token}
Content-Type	内容类型	是	String	固定值：application/json; charset=utf-8

请求示例

{
    "title": "通知标题66",
    "content": "内容：检测到您的账号存在异常风险，查看异常详情66。",
    "message_type": "TEXT",
    "user_names": [
        "ziceUser",
        "zhangaaa01"
    ],
    "org_codes": [
        "10000"
    ],
    "all": false
}

请求参数

参数名	中文名称	必须	类型	描述
title	通知标题	是	String	不为空，长度不超过100
content	通知内容	是	String	不为空，长度不超过1024
message_type	消息类型	是	String	TEXT=文本 MARKDOWN=markdown
user_names	用户集合	否	List	填写用户名，最多100个
org_codes	组织集合	否	List	填写组织编码，最多20个
all	是否发送所有	否	Boolean	为false时，userNames和orgCodes有一个必须不为空

返回示例

成功示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
    "noitce_id": "20220809161411767-9524-8618BA3BB"
}


错误示例：
HTTP/1.1 400 Bad Request
{
  "error_code": "NOTICE.0004",
  "error_msg": "通知标题不能为空"
}

返回参数

参数名	中文名称	类型	描述
notice_id	通知ID	String

错误码

状态码	错误码	错误信息	处理措施
400	COM.0601	参数错误，缺少参数或者参数类型不正确	请检查入参是否符合校验规则
		Parameter missing or incorrect parameter type
400	NOTICE.0004	通知标题不能为空	请检查入参中的通知标题字段是否为空
		Notice title cannot be empty
400	NOTICE.0005	通知内容不能为空	请检查入参中的通知内容字段是否为空
		Notice content cannot be empty
400	NOTICE.0006	通知消息类型不能为空	请检查入参中的通知消息类型字段是否为空
		Notification message type cannot be empty
400	NOTICE.0007	通知标题不符合校验规则	请检查入参中的通知标题字段是否符合校验规则
		Notice title does not meet verification rules
400	NOTICE.0008	通知内容不符合校验规则	请检查入参中的通知内容字段是否符合校验规则
		Notice content does not meet verification rules
400	NOTICE.0010	通知用户名数量不符合校验规则	请检查入参中的用户名数量是否符合校验规则
		Notice that the number of usernames does not meet the verification rules
400	NOTICE.0011	通知组织数量不符合校验规则	请检查入参中的组织数量是否符合校验规则
		The number of notification organizations does not meet the verification rules
400	NOTICE.INSITE.0003	本次发送的站内通知数超过规格限制	本次发送的通知数超过限制数量，请明天再发送通知
		The number of in-site notifications sent this time exceeds the specification limit
400	NOTICE.INSITE.0004	站内通知的用户或组织范围不能为空	请检查入参中的用户或组织的范围是否为空
		User or organization scope for in-site notifications cannot be empty