Messenger Platform

Handover Protocol API Reference

This guide contains references for the endpoints used for Handover Protocol.

Create

Allows an app to participate in Handover Protocol.

Endpoints

EndpointDescription

/PAGE-ID/extend_thread_control

Allows an app to extend control of a conversation

/PAGE-ID/pass_thread_control

Allows an app to pass control of a conversation to another app

/PAGE-ID/pass_thread_metadata

Allows an app to pass information about a conversation to other apps linked to the Page during Handover Protocol

/PAGE-ID/release_thread_control

Allows an app to release control of a conversation before control expires

Properties

PropertyDescription

recipient

object

Required. A JSON object that contains the ID of the person receiving the message

id
int
The Page-scoped ID for the person receiving the message

target_app_id

int

The ID for the app that requested control of the conversation. Required when passing control of a conversation from one app to another


To pass control to an inbox set the value to 263902037430900 for the Page Inbox or 1217981644879628 for the Instagram Inbox

metadata

string

Additional information about a conversation to be included in Handover Protocol webhook notifications.

Read

EndpointDescription

/PAGE-ID/secondary_receivers

Allows a Primary Receiver app, if one is set, to retrieve the list of app

/PAGE-ID/thread_owner

Allows a Primary Receiver app, if one is set, to retrieve the app ID for the app that current owns a conversation

Learn More