LiveMessage.send
From Facebook Developer Wiki
This API method is currently in Beta.
Contents |
Description
Sends a live message to a particular user's browser, which should be handled in FBJS. Messages can only be sent and received by users who have authorized your application.
Parameters
| Required | Name | Type | Description | |
| 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. | ||
| recipient | uid | The user ID of the message recipient. | ||
| event_name | string | Name of the "event" for which messages will be sent and received (max length: 128 bytes). Use this event_name when you initialize the LiveMessage FBJS object so your recipient can receive the message. | ||
| message | string | A JSON-encoded string of the message to send (max length: 1024 bytes). |
Example Requests
$facebook->api_client->liveMessage_send('563683308','rochambeau','{message:"Let\'s start a game."}');
Example Return XML
<?xml version="1.0" encoding="UTF-8"?>
<liveMessage_send_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</liveMessage_send_response>
Error Codes
| Code | Description | |
| 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. | |
| 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. | |
| 292 | Either the sender or the recipient has not accepted the TOS for the application. | |
| 1100 | An unknown (but specific to LiveMessage) error occurred when sending the LiveMessage. | |
| 1101 | The event_name parameter is too long. | |
| 1102 | The message parameter is too long. |
