README

这是一个简单的 Laravel 服务提供者，提供对 PHP RingCentral SDK 的访问。

安装

此包需要 PHP 8.0 和 Laravel 8 或更高版本。

要使用 Composer 安装 PHP 客户端库

composer require coxlr/laravel-ringcentral

此包将自动注册 RingCentral 提供者和外观。

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Coxlr\RingCentral\RingCentralServiceProvider" --tag="config"

然后更新 config/ringcentral.php 以包含您的凭据。或者，您也可以更新您的 .env 文件，如下所示

RINGCENTRAL_CLIENT_ID=my_client_id
RINGCENTRAL_CLIENT_SECRET=my_client_secret
RINGCENTRAL_SERVER_URL=my_server_url
RINGCENTRAL_USERNAME=my_username
RINGCENTRAL_OPERATOR_TOKEN=my_operator_jwt

#If admin details are a different extension to the operator
RINGCENTRAL_ADMIN_TOKEN=my_admin_jwt

此包使用 JWT 认证方法。您可以在 此处 了解更多有关为您的 RingCentral 帐户设置 JWT 的信息。

使用方法

要使用 RingCentral 客户端库，您可以使用外观，或从服务容器中请求实例。

发送短信消息（需要登录扩展为公司操作员）

RingCentral::sendMessage([
    'to'   => '18042221111',
    'text' => 'Using the facade to send a message.'
]);

或者

$ringcentral = app('ringcentral');

$ringcentral->sendMessage([
    'to'   => '18042221111',
    'text' => 'Using the instance to send a message.'
]);

属性

检索扩展（需要管理员访问权限）

RingCentral::getExtensions();

或者

$ringcentral = app('ringcentral');

$ringcentral->getExtensions();

获取操作员发送和接收的消息

RingCentral::getOperatorMessages();

或者

$ringcentral = app('ringcentral');

$ringcentral->getOperatorMessages();

默认的起始日期是前 24 小时，要指定搜索的起始日期，请将所需日期作为参数传递。

RingCentral::getOperatorMessages((new \DateTime())->modify('-1 hours'));

参数

获取给定扩展发送和接收的消息（需要管理员访问权限）

RingCentral::getMessagesForExtensionId(12345678);

或者

$ringcentral = app('ringcentral');

$ringcentral->getMessagesForExtensionId(12345678);

默认的起始日期是前 24 小时，要指定搜索的起始日期，请将所需日期作为参数传递。

RingCentral::getMessagesForExtensionId(12345678, (new \DateTime())->modify('-1 hours'));

参数

获取消息附件（需要管理员访问权限）

RingCentral::getMessageAttachmentById(12345678, 910111213, 45678910);

或者

$ringcentral = app('ringcentral');

$ringcentral->getMessageAttachmentById(12345678, 910111213, 45678910);

参数

有关使用 RingCentral 客户端库的更多信息，请参阅 官方客户端库仓库。

测试

composer test

如果在测试时使用 RingCentral 沙箱环境，请在测试时设置以下环境变量为 true，以处理沙箱消息前缀。

RINGCENTRAL_IS_SANDBOX=true

可以设置一个可选的环境值，以防止在测试时触碰到 RingCentral 的速率限制。这将在每个测试之前添加一个延迟，持续设置的时间。

RINGCENTRAL_DELAY_REQUEST_SECONDS=20

变更日志

有关最近更改的更多信息，请参阅 变更日志。

贡献

有关详细信息，请参阅 贡献指南。

安全性

如果您发现任何安全相关的问题，请通过电子邮件 hey@leecox.me 联系我们，而不是使用问题跟踪器。

鸣谢

• Lee Cox

许可协议

MIT 许可协议 (MIT)。请参阅 许可文件 了解更多信息。