Download the PHP package coxlr/laravel-ringcentral without Composer
On this page you can find all versions of the php package coxlr/laravel-ringcentral. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download coxlr/laravel-ringcentral
More information about coxlr/laravel-ringcentral
Files in coxlr/laravel-ringcentral
Package laravel-ringcentral
Short Description A Laravel package for the RingCentral SDK for PHP
License MIT
Homepage https://github.com/coxlr/laravel-ringcentral
Informations about the package laravel-ringcentral
A Laravel package for the RingCentral SDK for PHP
This is a simple Laravel Service Provider providing access to the RingCentral SDK for PHP.
Installation
This package requires PHP 8.0 and Laravel 8 or higher.
To install the PHP client library using Composer:
The package will automatically register the RingCentral
provider and facade.
You can publish the config file with:
Then update config/ringcentral.php
with your credentials. Alternatively, you can update your .env
file with the following:
This package uses the JWT autentication method. You can learn more about setting up JWT for your RingCentral account here.
Usage
To use the RingCentral Client Library you can use the facade, or request the instance from the service container.
Sending an SMS message (requires login in extension to be company operator)
Or
Properties
Name | Required | Type | Default | Description |
---|---|---|---|---|
to | true | String | The number to send the message to, must include country code | |
text | true | String | The text of the message to send |
Retrieving Extensions (requires admin access)
Or
Get messages sent and received for the operator
Or
The default from date is the previous 24 hours, to specify the date to search from pass the require date as a parameter.
Parameters
Name | Required | Type | Default | Description |
---|---|---|---|---|
fromDate | false | Object | The date and time to start the search from must be a PHP date object | |
toDate | false | Object | The date and time to end the search must be a PHP date object | |
perPage | false | Int | 100 | The number of records to return per page |
Get messages sent and received for a given extension (Needs admin access)
Or
The default from date is the previous 24 hours, to specficy the date to search from pass the require date as a parameter.
Parameters
Name | Required | Type | Default | Description |
---|---|---|---|---|
extensionId | true | String | The RingCentral extension Id of the extension to retrieve the messages for | |
fromDate | false | Object | The date and time to start the search from must be a PHP date object | |
toDate | false | Object | The date and time to end the search must be a PHP date object | |
perPage | false | Int | 100 | The number of records to return per page |
Get a messages attachment (requires admin access)
Or
Parameters
Name | Required | Type | Default | Description |
---|---|---|---|---|
extensionId | true | String | The RingCentral extension Id of the extension the messages belongs to | |
messageId | true | String | The id of the message of the the attachment belongs to | |
attachmentId | true | String | The id of the attachment |
For more information on using the RingCentral client library, see the official client library repository.
Testing
If using the RingCentral sandbox environment when testing set the following environment variable to true to handle sandbox message prefix.
An optional environment value can be set to prevent hitting RingCentral rate limits when testing. This will add a delay for the set seconds before each test.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.