Extension:MassMessage/API

Sending messages
You can use the API with  to send messages.

Parameters

 * : Page containing list of pages to send messages to
 * : Subject line of message
 * : Body of message
 * : Edit token from action=tokens

Example
Note: For the sake of simplicity, all parameters are passed in a GET request in this example. However, this API action requires POST requests.

Returned fields

 * : "success" if message was sent properly.
 * : how many messages were queued

Modifying delivery lists
ContentHandler-based delivery lists can be edited using the API with. You can also use the standard action=edit, but that requires serializing the JSON yourself, and will result in less specific error messages.

Parameters

 * : Title of the delivery list to update
 * : Titles to add to the list
 * : Titles to remove from the list
 * : Edit token from action=tokens

Example
Note: For the sake of simplicity, all parameters are passed in a GET request in this example. However, this API action requires POST requests.

Returned fields

 * : "Success" if the entire request succeeded; "Done" if some or all of it failed.
 * : List of pages added, if "add" was specified in the request
 * : If the attribute exists, the page does not exist on the wiki (for rendering redlinks)
 * : List of pages that could not be added, if any
 * : If the attribute exists, the title is invalid
 * : If the attribute exists, the site is invalid
 * : List of pages removed, if "remove" was specified in the request
 * : List of pages that could not be removed because they weren't in the list, if any