{"id":18753135,"url":"https://github.com/bottenderjs/bottender-handovers","last_synced_at":"2025-07-17T17:36:42.485Z","repository":{"id":119418365,"uuid":"119333138","full_name":"bottenderjs/bottender-handovers","owner":"bottenderjs","description":"An experimental package for Messenger Handover Protocol with Bottender.","archived":false,"fork":false,"pushed_at":"2018-07-26T09:05:12.000Z","size":117,"stargazers_count":4,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-13T00:53:08.873Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bottenderjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-29T04:48:07.000Z","updated_at":"2020-12-01T10:47:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"08dca4ab-eab7-41c3-b54c-9477d932048b","html_url":"https://github.com/bottenderjs/bottender-handovers","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/bottenderjs/bottender-handovers","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bottenderjs%2Fbottender-handovers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bottenderjs%2Fbottender-handovers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bottenderjs%2Fbottender-handovers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bottenderjs%2Fbottender-handovers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bottenderjs","download_url":"https://codeload.github.com/bottenderjs/bottender-handovers/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bottenderjs%2Fbottender-handovers/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259653994,"owners_count":22890934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T17:24:27.747Z","updated_at":"2025-06-13T13:35:15.019Z","avatar_url":"https://github.com/bottenderjs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bottender-handovers\n\n[![npm](https://img.shields.io/npm/v/bottender-handovers.svg?style=flat-square)](https://www.npmjs.com/package/bottender-handovers)\n[![Build Status](https://travis-ci.org/bottenderjs/bottender-handovers.svg?branch=master)](https://travis-ci.org/bottenderjs/bottender-handovers)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\n\u003e An experimental package for [Messenger Handover Protocol](https://developers.facebook.com/docs/messenger-platform/handover-protocol) with [Bottender](https://github.com/Yoctol/bottender).\n\n## Installation\n\n```sh\nnpm install bottender-handovers\n```\n\n## Usage\n\n```js\nconst { middleware } = require('bottender');\nconst handovers = require('bottender-handovers');\n\nconst handleHandovers = handovers({\n  shouldControlPass: context =\u003e context.event.text === '/help',\n  shouldControlTake: context =\u003e\n    context.event.isStandby \u0026\u0026 context.event.text === '/back',\n  willControlPass: async context =\u003e {\n    await context.sendText('Passing thread control to the page inbox.');\n  },\n  didControlTake: async context =\u003e {\n    await context.sendText('Took thread control back.');\n  },\n});\n\n// This bot should be assigned as primary receiver app\nbot.onEvent(\n  middleware([\n    handleHandovers,\n    async context =\u003e {\n      if (!context.event.isStandby) {\n        await context.sendText('Respond by bot.');\n      }\n    },\n  ])\n);\n```\n\n### Using Request Thread Control\n\n`bottender-handovers` provide two built-in functions to utilize Messenger Platform's Request Thread Control events. Simply pass them to `shouldControlPass` option.\n\n```js\nconst { middleware } = require('bottender');\nconst handovers = require('bottender-handovers');\nconst {\n  isRequestThreadControlFrom,\n  isRequestThreadControlFromPageInbox,\n} = handovers;\n\n// request from and pass to 3rd party CRM service\nconst myCRMAppId = 123456;\nconst handleHandovers = handovers({\n  shouldControlPass: isRequestThreadControlFrom(myCRMAppId),\n  targetAppId: myCRMAppId,\n});\n\n// request from and pass to Facebook Page Inbox\nconst handleHandovers = handovers({\n  shouldControlPass: isRequestThreadControlFromPageInbox,\n});\n```\n\n## Options\n\n### shouldControlPass(context): boolean\n\nDefault: `() =\u003e false`.\n\n### shouldControlTake(context): boolean\n\nDefault: `() =\u003e false`.\n\n### willControlPass(context)\n\nDefault: `() =\u003e {}`.\n\n### willControlTake(context)\n\nDefault: `() =\u003e {}`.\n\n### didControlPass(context)\n\nDefault: `() =\u003e {}`.\n\n### didControlTake(context)\n\nDefault: `() =\u003e {}`.\n\n### targetAppId\n\nDefault: `263902037430900` (Page Inbox).\n\n## License\n\nMIT © [Yoctol](https://github.com/bottenderjs/bottender-handovers)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbottenderjs%2Fbottender-handovers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbottenderjs%2Fbottender-handovers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbottenderjs%2Fbottender-handovers/lists"}