versión API Graph

Page Chat Plugin

Lectura

PageChatPlugin

Nueva experiencia para las páginas

This endpoint is supported for Nueva experiencia para las páginas.

Ejemplo

Graph API Explorer
GET /v19.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
}];
Si quieres aprender a usar la API Graph, lee nuestra guía "Uso de la API Graph".

Parámetros

Este extremo no tiene ningún parámetro.

Campos

La lectura de este perímetro mostrará un resultado formateado con JSON:

{ "data": [], "paging": {} }

data

Una lista de nodos de ChatPlugin.

paging

Para obtener más detalles sobre la paginación, consulta la Guía de la API Graph.

Error Codes

ErrorDescripción
190Invalid OAuth 2.0 Access Token
200Permissions error

Creando

You can make a POST request to chat_plugin edge from the following paths:
When posting to this edge, no Graph object will be created.

Parámetros

ParámetroDescripción
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 NONE is set for both entry_point_iconand entry_point_label, the styling will default to the Messenger icon's styling.

entry_point_label
enum {NONE, CHAT, HELP, ASK_US}

The label displayed for the entry point icon. Please note, if NONE is set for both entry_point_iconand entry_point_label, the styling will default to the Messenger icon's styling.

greeting_dialog_display
enum {HIDE, SHOW, WELCOME_MESSAGE}

Determines when the greeting will be displayed. HIDE will hide the dialog until the person clicks the plugin. SHOW will always show the dialog. WELCOME_MESSAGE will show the greeting text above the plugin icon but the dialog will be hidden until the person clicks the plugin.

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

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Error Codes

ErrorDescripción
100Invalid parameter

Actualizando

No puedes realizar esta operación en este extremo.

Eliminando

No puedes realizar esta operación en este extremo.