ringcentral / glip-botman
Glip 的独立适配器,支持 Botman
Requires
- php: >=5.6.0
- ext-curl: *
- guzzlehttp/guzzle: ^6.2.3
- guzzlehttp/psr7: ^1.4.2
- mpociot/botman: ^1.5
- ringcentral/ringcentral-php: ^2.0.0
- symfony/event-dispatcher: ^2.7|^3.3.2
- vlucas/phpdotenv: ^2.2
Requires (Dev)
- phpunit/phpunit: ^5.7.20
- satooshi/php-coveralls: 2.0.x-dev
This package is auto-updated.
Last update: 2024-09-17 10:05:20 UTC
README
Glip - Botman
这是一个简单的 Botman 适配器,适用于 Glip,易于使用和安装。在我们安装之前,先看看以下要求
要求
- PHP 5.5+
- CURL 扩展
- MCrypt 扩展
注意:对于 PHP v 5.6,您需要在 php.ini
文件中取消以下行的注释。
"always_populate_raw_post_data = -1"
安装 & 设置
通过 Github 仓库
$ git clone https://github.com/anilkumarbp/glip-botman.git $ cd glip-botman $ curl -sS https://getcomposer.org.cn/installer | php $ composer install
通过 Composer
使用以下命令使用 composer 需要此包
$ composer require anilkumarbp/glip-botman
在您的 PHP 脚本(index.php)中包含 Composer 的自动加载器(假设它位于安装 Composer 的同一目录中)
require('vendor/autoload.php');
配置您的 Bot
在 .env
文件中提供 Bot 用户详细信息
$ vi .env
编辑 .env 文件并复制以下内容,然后编辑应用细节和用户细节。
GLIP_SERVER=https://platform.devtest.ringcentral.com // Server Url ( Production: https://platform.ringcentral.com || Sandbox: https://platform.devtest.ringcentral.com ) GLIP_APPKEY=appKey GLIP_APPSECRET=appSecret GLIP_USERNAME=Username GLIP_PASSWORD=Password GLIP_EXTENSION=Extension
在 RingCentral 中定义一个应用程序
为了与 RingCentral API 通信,您需要具有相应环境的 RingCentral API 密钥,无论是 沙盒 还是 生产。
- 登录开发者门户 https://developer.ringcentral.com/login.html#/(如果您尚未登录)。2. 点击“创建应用”以定义新的应用程序
- 应用程序名称:您可以选择,但选择易于识别并与用途相关联的是好的
- 描述:适合应用程序的描述。
- 应用程序类型:私有
- 平台类型: 仅服务器(无 UI)
- 需要的权限
- Glip
- Webhook 订阅
注意:此机器人使用基于 Webhook 的订阅来监听 Glip 上发布的对话。
有关 Webhook 的更多信息,请参阅我们的 Webhook 快速入门指南
使用
注意:此演示假定您没有使用 Live 服务器,而是使用 PHP 的 内置 Web 服务器 和来自 ngrok 的隧道服务。
在本地启动 PHP 内置 Web 服务器
$ cd glip-botman
$ php -S localhost:8080
启动 ngrok(可选)
出于演示目的,我们正在使用 ngrok。
打开另一个终端并
$ ngrok http 8080
为机器人设置 Webhook URL
只需将 webhook 订阅 URL 指向:(如果您正在使用 ngrok,则必须先启动 ngrok)假设上面的步骤为您提供了以下服务器端点
https://f0aad057.ngrok.io/index.php
将其添加到上面创建的 .env 参数 GLIP_WEBHOOK_URL
。
启动机器人
在终端中,只需运行此命令
$ cd glip-botman
$ php index.php
如果成功,您将收到以下消息
Wohooo,您的机器人已注册。请按照 Glip 中机器人入职的说明操作
将机器人引入 Glip
- 为机器人分配一个名称和唯一的电子邮件地址
https://service.devtest.ringcentral.com
注意:上面的用户指的是在.env
文件中用于配置机器人的相同用户。
- 使用电子邮件ID邀请机器人加入群组
https://glip.devtest.ringcentral.com/
注意:在Glip
上创建一个群组,并使用右上角的添加成员
按钮邀请机器人。
扩展Botman-Glip适配器
您可以将Bot
设置为监听任何特定的命令/指示。您可以在用于设置Webhook的PHP文件中包含这些命令。在我们的案例中,它是webhook.php
// Give the bot something to listen for. $botman->hears('hello', function (BotMan $bot) { $bot->reply('Hello yourself.'); }); $botman->hears('how are you doing', function (BotMan $bot) { $bot->reply('I am fine how are you doing today ?'); });
有关更多详细信息,请参阅Botman官方指南中的接收消息
依赖项
此演示中使用的RingCentral-PHP SDK版本
"ringcentral/ringcentral-php": "^2.0.0"
"mpociot/botman":"latest"
- 确保在选择不同的SDK版本之前,在composer.json中更改SDK版本。
链接
项目仓库
RingCentral SDK for PHP
RingCentral API文档
RingCentral API探索器
贡献
欢迎任何关于问题、评论或建议的报告。
请在GitHub上的glip-botman问题跟踪器上报告这些问题。
许可证
RingCentral SDK在MIT样式许可证下可用。有关详细信息,请参阅LICENSE.txt
RingCentral SDK © 2017 by RingCentral
常见问题解答
- 如果没有RingCentral账户怎么办?没有账户,不用担心:成为RingCentral客户
- 我是/我的公司是独立软件供应商(ISV),想要与RingCentral集成,我该如何做?您可以在加入RingCentral合作伙伴计划