View source for Extension:MassMessage/API

<languages/>
<translate>
== Sending messages == <!--T:1-->
</translate>
{{API-head
|module=massmessage
|version=
|prefix=
|rrights=massmessage
|postonly=Yes
|description=
|query=no
}}

You can use the API with <code>action=massmessage</code> to send messages.

<translate>
=== Parameters === <!--T:2-->
</translate>
* <code>spamlist</code> - Page containing list of pages to send messages to
* <code>subject</code> - Subject line of message
* <code>message</code> - Body of message
* <code>token</code> - Edit token from {{ll|API:Tokens|action{{=}}tokens}}

<translate>
=== Example === <!--T:3-->
</translate>
{{note|1=For the sake of simplicity, all parameters are passed in a GET request in this example. However, this API action requires POST requests.}}

{{ApiEx
|desc=
|p1=action=massmessage
|p2=spamlist=Wikipedia%20Signpost
|p3=subject=New%20Wikipedia%20Signpost
|p4=message=The%20new%20Signpost%20is%20ready%20for%20reading
|result=<syntaxhighlight lang="xml"><?xml version="1.0"?>
<api>
  <massmessage result="success" count="500" />
</api>
</syntaxhighlight>
}}

<translate>
=== Returned fields === <!--T:4-->
</translate>
* <code>result</code> - "success" if message was sent properly.
* <code>count</code> - how many messages were queued

<translate>
== Modifying delivery lists == <!--T:5-->
</translate>
{{API-head
|module=editmassmessagelist
|version=
|prefix=
|rrights=None
|postonly=Yes
|description=
|query=no
}}

ContentHandler-based delivery lists can be edited using the API with <code>action=editmassmessagelist</code>. You can also use the standard {{ll|API:Edit|action{{=}}edit}}, but that requires serializing the JSON yourself, and will result in less specific error messages.

<translate>
=== Parameters === <!--T:6-->
</translate>
* <code>spamlist</code> - Title of the delivery list to update
* <code>add</code> - Titles to add to the list
* <code>remove</code> - Titles to remove from the list
* <code>token</code> - Edit token from {{ll|API:Tokens|action{{=}}tokens}}

<translate>
=== Example === <!--T:7-->
</translate>
{{note|1=For the sake of simplicity, all parameters are passed in a GET request in this example. However, this API action requires POST requests.}}
{{ApiEx
|desc=
|p1=action=editmassmessagelist
|p2=spamlist=Wikipedia%20Signpost
|p3=add=User%20%talk:Foo{{!}}_
|p4=remove=User%20talk:Baz{{!}}Baz
|result=<syntaxhighlight lang="xml"><?xml version="1.0"?>
<api>
  <editmassmessagelist result="Done">
    <added>
      <page title="User talk:Foo" missing="" />
    </added>
    <invalidadd>
      <item invalidtitle="" xml:space="preserve">_</item>
    </invalidadd>
    <removed>
      <page title="User talk:Baz" />
    </removed>
    <invalidremove>
      <item>Baz</item>
    </invalidremove>
  </editmassmessagelist>
</api></syntaxhighlight>
}}

<translate>
=== Returned fields === <!--T:8-->
</translate>
* <code>result</code> - "Success" if the entire request succeeded; "Done" if some or all of it failed.
* <code>added</code> - List of pages added, if "add" was specified in the request
** <code>missing</code> - If the attribute exists, the page does not exist on the wiki (for rendering redlinks)
* <code>invalidadd</code> - List of pages that could not be added, if any
** <code>invalidtitle</code> - If the attribute exists, the title is invalid
** <code>invalidsite</code> - If the attribute exists, the site is invalid
* <code>removed</code> - List of pages removed, if "remove" was specified in the request
* <code>invalidremove</code> - List of pages that could not be removed because they weren't in the list, if any