Graph API Version

Page Conversations

Reading

Get a list of conversations between people and your Page, your Business Page, or your Instagram Professional account.

New Page Experience

This endpoint is supported for New Page Experience.

Permissions

For Messenger conversations between people and your Page, your app will need: For Instagram Messaging conversations between people and your Instagram Professional account, your app will need:
  • A Page access token requested by a person who can perform the MESSAGING task on the Page linked to your Instagram Business account
  • The instagram_basic, instagram_manage_messages, and pages_manage_metadata permissions
  • Your app must be owned by a verified business

Limitations

  • Time-based pagination is not available for the conversations endpoint.

Example

Graph API Explorer
GET /v20.0/{page-id}/conversations 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}/conversations',
    '{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}/conversations",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/conversations",
    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}/conversations"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

ParameterDescription
folder
string

The target folder from which to retrieve conversations. Valid values are: inbox, other, page_done, and spam. Use folder=page_done for retrieving conversations archived after mid-2018.

platform
enum {INSTAGRAM, MESSENGER}

The messaging platform used for the conversations

user_id
string

The Page-scoped ID for the person who started the conversation with the Page

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of UnifiedThread nodes.

paging

For more details about pagination, see the Graph API guide.

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter
613Calls to this api have exceeded the rate limit.
190Invalid OAuth 2.0 Access Token
368The action attempted has been deemed abusive or is otherwise disallowed
230Permissions disallow message to user
104Incorrect signature
2500Error parsing graph query

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.