POST login/users/:user id/notifications/facebook
(Difference between revisions)
Renato.neves (Talk | contribs) (→JSON Parameters) |
Renato.neves (Talk | contribs) |
||
| Line 44: | Line 44: | ||
This API requires Social Login App authentication. See [[Authentication]]. | This API requires Social Login App authentication. See [[Authentication]]. | ||
| + | |||
| + | === Response Status === | ||
| + | |||
| + | {| | ||
| + | ! align="left" width="200px" | ok (200) | ||
| + | | The request was successful. | ||
| + | |- | ||
| + | ! align="left" width="200px" | bad request (400) | ||
| + | | The parameters are missing or invalid. | ||
| + | |- | ||
| + | ! align="left" width="200px" | unauthorized (401) | ||
| + | | The authentication is wrong. See [[Authentication]]. | ||
| + | |- | ||
| + | ! align="left" width="200px" | forbidden (403) | ||
| + | | The Social Login App has no permission to access this user. | ||
| + | |- | ||
| + | ! align="left" width="200px" | not_found (404) | ||
| + | | The user does not have Facebook credential. | ||
| + | |- | ||
| + | ! align="left" width="200px" | internal_server_error (500) | ||
| + | | An unknown error happened. | ||
| + | |} | ||
== Examples == | == Examples == | ||
Revision as of 20:10, 27 December 2014
Contents |
Description
Posts a Facebook notification to the user.
Read the documentation about Facebook Notifications at https://developers.facebook.com/docs/games/notifications to understand how to use this API, the limitations and best practices. Important details:
- Facebook Apps must have Canvas Page configured.
- Facebook Apps can send notifications only to people who have authorized the app.
- No special or extended Facebook permission is required.
- Facebook Apps that send more than 50,000 notifications in a week are required to maintain at least a 17% weekly click-to-impression (CTI) ratio.
- Best practices: https://developers.facebook.com/docs/games/notifications#best_practices
Resource URL
POST https://api.socialidnow.com/v1/marketing/login/users/:user_id/notifications/facebook
Parameters
URL Parameters
| user_id | required | user identifier. |
|---|
JSON Parameters
| notification | required | a hash with the necessary fields to post the notification: |
|---|---|---|
| template | required | The message text of the notification. This can be formatted according to special text templating. Maximum of 180 characters. |
| href | optional | The relative path that someone clicking on the notification will be directed to. This is will be appended to the Facebook app's canvas URL. |
Authentication
This API requires Social Login App authentication. See Authentication.
Response Status
| ok (200) | The request was successful. |
|---|---|
| bad request (400) | The parameters are missing or invalid. |
| unauthorized (401) | The authentication is wrong. See Authentication. |
| forbidden (403) | The Social Login App has no permission to access this user. |
| not_found (404) | The user does not have Facebook credential. |
| internal_server_error (500) | An unknown error happened. |
Examples
Request
curl -iX POST 'https://api.socialidnow.com/v1/marketing/login/users/340/notifications/facebook' \ -d '{"notification": {"template": "Visit Social-ID NOW", "href": "/visit/campaign" }}' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Status: 201
