Take Thread Control API Reference

To use the Handover Protocol, the Graph API version should be set to 2.6 or greater.

Part of the Handover Protocol, take thread control allows the Primary Receiver app to take control of a specific thread from a Secondary Receiver app. The Secondary Receiver app will receive a take_thread_control webhook event when it loses thread control.

Contents

Request URI

To thread control, make a POST request to

https://graph.facebook.com/v2.6/me/take_thread_control?access_token=<PAGE_ACCESS_TOKEN>

Example Request

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient":{"id":"<PSID>"},
  "metadata":"String to pass to the secondary receiver" 
}' "https://graph.facebook.com/v2.6/me/take_thread_control?access_token=<PAGE_ACCESS_TOKEN>"

Example Response

{
  "success":true
}

Properties

Property Type Description

recipient

Object

recipient object

recipient.id

Integer

The PSID of the message recipient.

metadata

String

Optional. Metadata passed back to the secondary app in the take_thread_control webhook event.

Error Codes

For error codes see this page.