Was this article helpful?

socialize.sendNotification

Modified 15:33, 17 Mar 2013 by Tanya

1. Description
1. 1.1. Supporting Providers
2. Request URL
3. Parameters
1. 3.1. Authorization Parameters
4. Response Data
5. Response Example

Description

Sends a notification to a list of friends. Note: To send a notification to a Twitter friend, the friend must be following you and you must also be following the friend.

Supporting Providers

The following providers currently support this operation: Twitter, LinkedIn, Myspace, and Yahoo.

Request URL

http[s]://socialize.gigya.com/socialize.sendNotification

Parameters

Required	Name	Type	Description

Required*	UID	string	The unique ID of the user, with which this method call is associated. This is the UID you receive from Gigya after a successful login of this user. * The UID parameter is required when you call this method through one of the following interfaces: PHP SDK, Java SDK, NET SDK or if you are using the REST API directly with Gigya's proprietary authorization method. * The UID parameter is not required when you call this method through one of the following interfaces: Android SDK, iOS SDK or if you are using an external OAuth2 SDK. Note: If you are using account linking then the UID would be your site user ID. To learn more about Social Login with account linking (best practice), please refer to the Social Login Implementation guide.
Required	recipients	string	A comma separated list of UIDs representing recipients that will receive this notification.
	body	string	The content of the notification. Notification body should not include HTML tags. Links should be provided as simple urls, not <a> tags. For Example: body: 'Check out this lovely site: http://www.myLovelySite.com' Each social network uses a different format for links. Gigya will identify your links and convert them to the proper format corresponding to the social network.
	subject	string	The subject of the notification.
Optional	shortURLs	string	Using this parameter you may determine whether to use Gigya's URL shortening service for URLs, which are published through this method. The optional values for this parameter are: 'always' - always shorten URLs. 'whenRequired' (default) - shorten URLs when needed - when posting to Twitter, LinkedIn, MySpace and Yahoo where the status update is limited to 140 char. 'never' - never shorten URLs. When Gigya's URL shortening service is active, Gigya tracks all the traffic coming from the distributed URLs. In such case, 'Referred Traffic' reports will be available to you. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object.
	context	object	A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
	cid	string	A string of maximum 100 characters length. This string is associated with each transaction and will later appear on reports generated by Gigya in the "Context ID" combo box. The cid allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. The "Context ID" combo box lets you filter the report data by site/application context.
	actionAttributes	JSON object	In Gamification your users receive points for actions they perform on your site, in this case sending a notification grants the user points. Action Attributes may be used to annotate actions with additional information, such as the section of the web site that generated the action. If you set here the actionAttributes, each time a user sends a notification, the action also receives an attribute, for example "tv-show":"glee", which can mean that the action was performed on the "Glee" page of the site. These action attributes are later used to display the GM Plugins filtered according to a certain attribute. For example, you can show the Leaderboard plugin only for top users on the "Glee" page. This parameter receives a JSON object, comprised of a set or sets of a key (category) and a value or values, i.e.: { "<attribute1 name>": ["<attribute1 value1>", "<attribute1 value2>", ...], "<attribute2 name>": "<attribute2 value>", ... } For example: { "tv-show": ["glee", "30rock"], "music": "pop" } In this example the action receives three attributes: {"tv-show":"glee"}, {"tv-show":"30rock"}, and {"music":"pop"}. This parameter may receive a list of up to three sets of key and value entries per call. If more values are entered, only the first three will count and the rest will be ignored. The three sets of key and value can be one key with three values, or three keys with one value each, or two keys, one with two values and the other with one value. You can also choose to input attributes using a generic "Tags" key, with no category name, for example: {"tags": ["glee", "house", "pop"]}. In this case the action receives these three attributes: {"tags":"glee"}, {"tags":"house"}, and {"tags":"pop"}.

	format	string	Determines the format of the response. This parameter is required when using the REST API directly, and irrelevant when using one of our SDKs. The options are: json jsonp - if the format is jsonp then you are required to define a callback method (see parameter below). xml (default) - Deprecated. We do not support XML format anymore, but it is the default due to backwards compatibility. Please set the format parameter to either json or jsonp.
	callback	string	This parameter is relevant only when the format parameter is set to jsonp (see above). In such case this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
	httpStatusCodes	Boolean	The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if occurs.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Note: the authorization parameters are required only if you are using the REST API directly. If you are using one of Gigya's SDKs then these parameters are not required, since the SDK implements the authorization method internally.

The set of required parameters is dependent on your selected method of authorization. There are two options:

If you are conforming with the OAuth 2.0 standard, you will need to Pass an Access Token. For more information, please read the Using Gigya's REST API in compliance with OAuth 2.0 guide.
If you are using Gigya's proprietary authorization method, you will need to pass the parameters specified here. Or, if you are making a call over HTTPS then you may pass the secret parameter instead of the timestamp, nonce and sig parameters. For more information, please read the Using Gigya's REST API with our proprietary authorization method guide.

Response Data

Field	Type	Description

errorCode	integer	The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage	string	A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails	string	This field will appear in the response only in case of an error and will contain the exception info, if available.
callId	string	Unique identifier of the transaction, for debugging purposes.
Field	Type	Description

Note: A field that does not contain data, will not appear in the response.

Response Example

{
    "statusCode": 200,
    "errorCode": 0,
    "statusReason": "OK",
    "callId": "3353d2fbac894289977c102298df60d1"
}

Table of contents

socialize.sendNotification

Table of contents

Description

Supporting Providers

Request URL

Parameters

Authorization Parameters

Response Data

Response Example

Tags

Comments

Attachments

Table of contents