- User - Username or empty when using access token
- Password - Password or access token (Required)
- Host (Required)
Props can be either supplied using the params argument, or through the URL using
Rooms - Room aliases, or with ! prefix, room IDs
user is specified, the
password is treated as the authentication token. This means that no matter what login
flow your server uses, if you can manually retrieve a token, then Shoutrrr can use it.
Password Login Flow¶
password is supplied, the
m.login.password login flow is attempted if the server supports it.
rooms are not specified, the service will send the message to all the rooms that the user has currently joined.
Otherwise, the service will only send the message to the specified rooms. If the user is not in any of those rooms, but have been invited to it, it will automatically accept that invite.
Note: The service will not join any rooms unless they are explicitly specified in
rooms. If you need the user
to join those rooms, you can send a notification with
rooms explicitly set once.
Rooms specified in
rooms will be treated as room IDs if the start with a
! and used directly to identify rooms. If
they have no such prefix (or use a correctly escaped
#) they will instead be treated as aliases, and a directory
lookup will be used to resolve their corresponding IDs.
Note: Don't use unescaped
# for the channel aliases as that will be treated as the
fragment part of the URL.
Either omit them or URL encode them, I.E.
If you do not have TLS enabled on the server you can disable it by providing
disableTLS=yes. This will effectively
http intead of
https for the API calls.