PageChatPlugin
GET /v18.0/{page-id}/chat_plugin HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->get(
'/{page-id}/chat_plugin',
'{access-token}'
);
} catch(Facebook\Exceptions\FacebookResponseException $e) {
echo 'Graph returned an error: ' . $e->getMessage();
exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
echo 'Facebook SDK returned an error: ' . $e->getMessage();
exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
"/{page-id}/chat_plugin",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{page-id}/chat_plugin",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/{page-id}/chat_plugin"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
Reading from this edge will return a JSON formatted result:
{ "
data
": [], "paging
": {} }
data
paging
Error | Description |
---|---|
200 | Permissions error |
210 | User not visible |
chat_plugin
edge from the following paths: Parameter | Description |
---|---|
alignment enum {LEFT, RIGHT} | Alignment of the Chat Plugin, to the left or right. |
desktop_bottom_spacing int64 | Spacing of the Chat Plugin on the bottom of the desktop website, in pixels. |
desktop_side_spacing int64 | Spacing of the Chat Plugin on the side of the desktop website, in pixels. |
entry_point_icon enum {MESSENGER_ICON, CHAT_ROUND_ICON, CHAT_ANGULAR_ICON, NONE} | The style for the entry point icon. Please note, if |
entry_point_label enum {NONE, CHAT, HELP, ASK_US} | The label displayed for the entry point icon. Please note, if |
greeting_dialog_display enum {HIDE, SHOW, WELCOME_MESSAGE} | Determines when the greeting will be displayed. |
guest_chat_mode enum {ENABLED, DISABLED} | Allow a customer to use the Chat Plugin without being logged in to Facebook. |
mobile_bottom_spacing int64 | Spacing of the Chat Plugin on the bottom of the mobile website, in pixels. |
mobile_chat_display enum {APP_SWITCH, CHAT_TAB} | Determines how to display the chat on the mobile website, |
mobile_side_spacing int64 | Spacing of the Chat Plugin on the side of the mobile website, in pixels. |
theme_color string | Color of the Chat Plugin, in hexadecimal except white (FFFFFF). |
welcome_screen_greeting string | The greeting text that will be displayed before the user starts a conversation, maximum of 80 characters. Supports Emoji |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |