From 4ed1518d878a102d6792d35976e481cfedd863eb Mon Sep 17 00:00:00 2001 From: anoadragon453 Date: Tue, 4 Jun 2024 08:47:43 +0000 Subject: deploy: 18c11968937c8313e363d2dc1cae38435af137a6 --- v1.109/admin_api/server_notices.html | 235 +++++++++++++++++++++++++++++++++++ 1 file changed, 235 insertions(+) create mode 100644 v1.109/admin_api/server_notices.html (limited to 'v1.109/admin_api/server_notices.html') diff --git a/v1.109/admin_api/server_notices.html b/v1.109/admin_api/server_notices.html new file mode 100644 index 0000000000..bcb2254e16 --- /dev/null +++ b/v1.109/admin_api/server_notices.html @@ -0,0 +1,235 @@ + + + + + + Server Notices - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + +
+
+ +
+ +
+ +

Server Notices

+

The API to send notices is as follows:

+
POST /_synapse/admin/v1/send_server_notice
+
+

or:

+
PUT /_synapse/admin/v1/send_server_notice/{txnId}
+
+

You will need to authenticate with an access token for an admin user.

+

When using the PUT form, retransmissions with the same transaction ID will be +ignored in the same way as with PUT /_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId}.

+

The request body should look something like the following:

+
{
+    "user_id": "@target_user:server_name",
+    "content": {
+        "msgtype": "m.text",
+        "body": "This is my message"
+    }
+}
+
+

You can optionally include the following additional parameters:

+
    +
  • type: the type of event. Defaults to m.room.message.
    • +
  • state_key: Setting this will result in a state event being sent.
    • +
+

Once the notice has been sent, the API will return the following response:

+
{
+    "event_id": "<event_id>"
+}
+
+

Note that server notices must be enabled in homeserver.yaml before this API +can be used. See the server notices documentation for more information.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + -- cgit 1.4.1