Graph API
Graph API-Version

Nachricht

Eine einzelne Nachricht in einer Messenger- oder Instagram Messaging-Unterhaltung.

Verwende den Unterhaltungsendpunkt oder Webhooks zum Abrufen der einzelnen Nachrichten-IDs.

Lesen

Graph API Explorer
GET /v21.0/{message-id} 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(
    '/{message-id}',
    '{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(
    "/{message-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{message-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{message-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Anforderungen

TypBeschreibung

App-Review

Erforderlich für den Zugriff auf Daten von Personen, die in deiner App keine Rolle haben, z. B. Entwickler*innen, Tester*innen oder Admins

Funktionen

Nicht zutreffend

Schlüssel

Ein Seiten-Zugriffsschlüssel von einer Person, die die MODERATE- oder MESSAGING-Aufgabe auf der abgefragten oder mit dem professionellen Instagram-Konto verknüpften Seite ausführen kann.

Berechtigungen

Die pages_messaging- und pages_manage_metadata-Berechtigungen

Die instagram_basic- und instagram_manage_messaging-Berechtigungen sind auch für Instagram Messaging erforderlich.

Einschränkungen

Für Instagram Messaging

  • Nur professionelle Instagram-Konten mit einer verknüpften Facebook-Seite können auf diesen Endpunkt zugreifen.
  • Bei Abfrage dieses Endpunkts werden alle Nachrichten für diese Unterhaltung zurückgegeben. Du kannst jedoch nur Daten zu den letzten 20 Nachrichten in der Unterhaltung abrufen. Wenn eine Nachricht nicht zu den letzten 20 Nachrichten zählt, wird ein Fehler zurückgegeben, der besagt, dass die Nachricht gelöscht wurde.

Felder

Wenn ein Feld nicht über Daten verfügt, wird es in der JSON-Antwort nicht zurückgegeben.

NameBeschreibung

attachments.data

Array
file_url
generic_template
id
image_data
name
video_data

Medien, wie eine Bild-, Video- oder Datei-CDN-URL, die an die Nachricht angehängt sind.


Die URL für die an die Nachricht angehängte Datei

Die URL für das an die Nachricht angehängte Bild. Kann die folgenden Schlüssel-Wert-Paare enthalten:

  • cta: Objekt mit title, type und url
  • medial_url: String, URL für das Bild
  • subtitle: String, in Pixeln
  • title: String

Die ID für den Anhang

Die URL für das an die Nachricht angehängte Bild. Kann die folgenden Schlüssel-Wert-Paare enthalten:

  • animated_gif_preview_url: String, URL für die Vorschau des GIFs
  • animated_gif_url: String, URL für das GIF
  • height: Integer, in Pixeln
  • max_height: Integer, in Pixeln
  • max_width: Integer, in Pixeln
  • preview_url: String, Vorschau der URL
  • render_as_sticker: Boolscher Wert, wahr oder falsch
  • url: String, URL für das Bild
  • width: Integer, in Pixeln

Der Name für den Anhang

Die URL für das an die Nachricht angehängte Video

created_time

datetime

Zeitpunkt der Nachrichtenerstellung

from

Objekt
id
email
name
username

Informationen darüber, wer die Nachricht gesendet hat. Das kann eine Person, Seite oder ein professionelles Instagram-Konto sein.

Die ID kann eine Instagram-spezifische ID oder seitenspezifische ID für eine Person oder eine Seiten-ID oder die ID des professionellen Instagram-Kontos für dein Unternehmen sein.

Die E-Mail-Adresse für eine Person oder Facebook-Seite. Nur Seitennachrichten

Der Name für eine Person oder Facebook-Seite. Nur Seitennachrichten

Der Benutzer*innen-Name für eine Person auf Instagram oder dein professionelles Instagram-Konto. Nur Instagram-Nachrichten

"from": {
    "username": "INSTAGRAM-USERNAME",
    "id": "ID"
  }

id

String

Die ID für eine Nachricht

is_unsupported

Boolescher Wert

Wird nur zurückgegeben, wenn true; eine Nachricht mit nicht unterstütztem Inhalt.

message

String

Textinhalt für die Nachricht. Wenn zur Nachricht kein Text gehört, ist dies leer.

reactions

Array
data Array
reaction Emoji
users Array von Objekten
id

username

Die Arten von Reaktionen, die die Nachricht erhalten hat, mit einer Liste aller Personen, die mit dieser Reaktionsart reagiert haben.

Ein Array mit Reaktionsobjekten

Der Emoji-Reaktionstyp

Eine Liste der Personen, die auf die Nachricht reagiert haben


Die ID kann eine Instagram-spezifische ID für eine Person auf Instagram oder die ID des professionellen Instagram-Kontos für dein Unternehmen sein.

Der Benutzername für eine Person auf Instagram oder dein professionelles Instagram-Konto. Nur Instagram-Nachrichten

"reactions":
  {
    "reaction": "❤️",
    "users" : [
      {
        "username": "INSTAGRAM-USERNAME",
        "id": "ID", 
      },
    ]
  }

shares

Array

Geteilte Medien wie ein Beitrag oder eine Produktvorlage, die in der Nachricht enthalten sind. Beachte, dass du für das „shares“-Objekt auch die Unterfelder anfordern musst, um die Daten abzurufen.

"shares": {
  "data": [{
    "template": {
      "payload":{
        "product": {
           "elements":{     //Can contain multiple products if applicable
             "data": [
              {
                "id" : "PRODUCT-ID",    // 0 if business can't see this product
                "retailer_id": "ID-ASSIGNED-BY-THE-RETAILER", 
                "image_url" : "IMAGE-URL", 
                "name" : "PRODUCT-NAME",
                "price" : "$10"
              },
            ],
          }
        }
      }
    }
  }]
}

story

Array

Der Link und die ID für eine Story. Nur Erwähnungen und Antworten werden unterstützt.

StoryReply: 
{
    "link": "CDN-URL",
    "id": "STORY-ID"
}

StoryMention: 
{
    "link": "CDN-URL",
    "id": "STORY-ID"
}

tags

Objekt

Ein data-Array mit Namen für Markierungen, die den Nachrichtenordner und die Quelle der Nachricht angeben.

  • Für Facebook-Seiten kann name folgende Werte aufweisen: inbox, read und source:chat.

to

Objekt
data Array
id
email
name
username

Informationen darüber, wer die Nachricht erhalten hat.



Die ID kann eine Instagram-spezifische ID oder seitenspezifische ID für eine Person oder eine Seiten-ID oder die ID des professionellen Instagram-Kontos für dein Unternehmen sein.

Die E-Mail-Adresse für eine Person oder Facebook-Seite. Nur Seitennachrichten

Der Name für eine Person oder Facebook-Seite. Nur Seitennachrichten

Der Benutzer*innen-Name für eine Person auf Instagram oder dein professionelles Instagram-Konto. Nur Instagram-Nachrichten

"to": {
  "data": [
    { 
      "username": "INSTAGRAM-USERNAME", 
      "id": "ID" 
    }
  ]
}

Edges

Name Beschreibung

/attachments

An eine Nachricht angehängte Dateien.

/shares

Geteilte Elemente, einschließlich Links, Fotos, Videos, Sticker und Produkte.

Erstellen

Diesen Vorgang kannst du nicht für diesen Endpunkt ausführen.

Aktualisieren

Diesen Vorgang kannst du nicht für diesen Endpunkt ausführen.

Löschen

Diesen Vorgang kannst du nicht für diesen Endpunkt ausführen.