Send a notification to a set of users. You can send emails to friends of the logged in user that have added the application without any confirmation, or you can direct a user of your application to the URL returned by this function to email users who have not yet added your application. You can also send messages to the logged in user's notification page without requiring confirmation. Your application can send up to 40 notifications to the notifications page, of which 10 can include email notifications, per user per day. Notifications sent to the notifications page for non-app users are subject to spam control. Additionally, any notification that you send on behalf of a user will be shown on that user's notifications page as a "sent notification."
| Type | Name | Required | Description |
|---|---|---|---|
| string | api_key | ✔ | The application key associated with the calling application. |
| string | session_key | ✔ | The session key of the logged in user. |
| float | call_id | ✔ | The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function. |
| string | sig | ✔ | An MD5 hash of the current request and your secret key, as described in the authentication guide. |
| string | v | ✔ | This must be set to 1.0 to use this version of the API. |
| string | format | Desired response format. Either XML (default) or JSON. | |
| string | callback | Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter. | |
| array | to_ids | ✔ | Comma-separated list of recipient ids. These must be either friends of the logged-in user or people who have added your application. To send a notification to the current logged in user without a name prepended to the message, set to_ids to the empty string. |
| string | notification | ✔ | RBML for the notifications page. Uses a stripped down version allowing only text and links. |
| string | RBML for the email. Uses a stripped down version allowing only text, links, and line breaks. If not passed, no email will be sent. Use rb:notif-subject around a line of text to define the subject of the email. |