Make an announcement

Properties	Values
HTTP method	`POST`
Interface path	`/nd/api/enterprise/broadcast`
Category	Enterprise API

Interface description

Interface path: /nd/api/enterprise/broadcast

POST request body parameters

Parameter	Type	Description (source requirements, defaults and scope)
`title`	`string`	Announcement content string (required)
`content`	`string`	content (required)
`target_users`	`string[]`	JSON array of recipient user IDs. Pass `[]` when no users are specified directly.
`target_deps`	`string[]`	JSON array of target department IDs. Recipients include members of these departments and their subdepartments. Pass `[]` when no departments are specified.

Scroll horizontally to view all columns

When both target_users and target_deps are empty arrays, no announcement is sent. When at least one array is nonempty, the specified users and users in the target departments are combined before sending. Supply both JSON arrays explicitly. Parameter names do not contain []; do not serialize an entire array into a string.

Both arrays empty: no announcement is sent.

{
  "title": "Example announcement",
  "content": "Example content",
  "target_users": [],
  "target_deps": []
}

Send to the combined audience of specified users and department members (example IDs):

{
  "title": "Example announcement",
  "content": "Example content",
  "target_users": ["2001"],
  "target_deps": ["3001"]
}

Return field description

{"code":0,"success":true}

Call instructions

Before calling, you need to complete Get token or the corresponding login-free authentication, and carry Authorization: Bearer <access_token> in the request header.
If there are differences in parameters and return fields due to deployment versions, the actual private cloud API documents and joint debugging results should prevail.
Category: Enterprise API.

Confirm Recipient Scope

An empty array does not mean everyone. If only target_users is nonempty, send to those users. If only target_deps is nonempty, send to members of those departments and their subdepartments. If both are nonempty, combine the audiences. If both are empty, do not send. These rules describe explicitly supplied arrays; they do not assume that omitting a parameter is equivalent to passing an empty array.