Feed.publishStoryToUser

From Facebook Developer Wiki

Jump to: navigation, search

Contents

Description

This method has been deprecated.

Please use stream.publish, FB.Connect.streamPublish, and Facebook.streamPublish instead.

Publishes a News Feed story to the user corresponding to the session_key parameter.

Parameters

RequiredNameTypeDescription
required api_key string The application key associated with the calling application. If you specify the API key in your client, you don't need to pass it with every call.
session_key string The session key of the logged in user. The session key is automatically included by our PHP client.
call_id float 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. If you specify the call ID in your client, you don't need to pass it with every call.
sig string An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application. Facebook computes the signature for you automatically.
v string This must be set to 1.0 to use this version of the API. If you specify the version in your client, you don't need to pass it with every call.
title markup The markup displayed in the feed story's title section.
optional format string The desired response format, which can be either XML or JSON. (Default value is XML.)
callback string 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.
body markup The markup displayed in the feed story's body section.
image_1 string The URL of an image to be displayed in the News Feed story.
image_1_link string The URL destination after a click on the image referenced by image_1.
image_2 string The URL of an image to be displayed in the News Feed story.
image_2_link string The URL destination after a click on the image referenced by image_2.
image_3 string The URL of an image to be displayed in the News Feed story.
image_3_link string The URL destination after a click on the image referenced by image_3.
image_4 string The URL of an image to be displayed in the News Feed story.
image_4_link string The URL destination after a click on the image referenced by image_4.
priority string TBD.

Response

The function returns 1 on success, 0 on permissions error, or an error response.

Publishing to News Feed requires you to understand the rules of its operation.

  • The title is required, and is limited to 60 displayed characters (excluding tags).
    • The <a> tag is allowed, and there can only be zero or one instance of it in the title.
    • No other tags are allowed.
  • The body is optional, is limited to 200 displayed characters (excluding tags), and can include the tags <a>, <b>, and <i>.
  • Up to 4 images can be displayed, which are shrunk to fit within 75x75 pixels, cached, and formatted by Facebook. Images can either be a URL, or a facebook PID. If it is a URL, you must own the image and grant Facebook the permission to cache it. Each image must have a link associated with it, which must start with http://
  • Applications are limited to calling this function once every 12 hours for each user.
  • The story may or may not show up in the user's News Feed, depending on the number and quality of competing stories.
  • Developer Note: If an application developer calls feed.publishStoryToUser for his own user ID, the story is always published. This allows for testing and display tweaks.

Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <feed_publishStoryToUser_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd"> 1 </feed_publishStoryToUser_response>

Error Codes

CodeDescription
1 An unknown error occurred. Please resubmit the request.
2 The service is not available at this time.
4 The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5 The request came from a remote address not allowed by this application.
100 One of the parameters specified was missing or invalid.
101 The API key submitted is not associated with any known application.
102 The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103 The submitted call_id was not greater than the previous call_id for this session.
104 Incorrect signature.
Retrieved from "http://wiki.developers.facebook.com/index.php/Feed.publishStoryToUser"
reference