https://github.com/vormkracht10/genesys-api
PHP package to communicate with the Genesys API.
https://github.com/vormkracht10/genesys-api
api api-client genesys genesys-cloud genesyscloud php
Last synced: 4 months ago
JSON representation
PHP package to communicate with the Genesys API.
- Host: GitHub
- URL: https://github.com/vormkracht10/genesys-api
- Owner: vormkracht10
- License: mit
- Created: 2022-10-05T11:32:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-09T19:05:54.000Z (over 1 year ago)
- Last Synced: 2025-01-10T22:39:06.458Z (5 months ago)
- Topics: api, api-client, genesys, genesys-cloud, genesyscloud, php
- Language: PHP
- Homepage:
- Size: 116 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# PHP Genesys API
[](https://packagist.org/packages/vormkracht10/genesys-api)
[](https://github.com/vormkracht10/genesys-api/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/vormkracht10/genesys-api)
This package is a PHP wrapper for the [Genesys](https://www.genesys.com/) API. The package provides a fluent syntax to interact with the API.
- [Installation](#installation)
- [Usage](#usage)
- [Authentication](#authentication)
- [Create Genesys API client](#create-genesys-api-client)
- [Conversations](#conversations)
- [Get conversation](#get-conversation)
- [List conversations](#list-conversations)
- [Create conversation](#create-conversation)
- [Messages for conversation](#messages-for-conversation)
- [Message for conversation](#message-for-conversation)
- [Get message draft for conversation](#get-message-draft-for-conversation)
- [Update message draft for conversation](#update-message-draft-for-conversation)
- [Update conversation participant](#update-conversation-participant)
- [Emails for conversation](#emails-for-conversation)
- [Update attributes for conversation](#update-attributes-for-conversation)
- [Replace participant](#replace-participant)
- [Users](#users)
- [Get user](#get-user)
- [List users](#list-users)
- [Create user](#create-user)
- [Update user](#update-user)
- [Delete user](#delete-user)
- [Get queues for user](#get-queues-for-user)
- [Queues](#queues)
- [Get queue](#get-queue)
- [List queues](#list-queues)
- [Create queue](#create-queue)
- [Update queue](#update-queue)
- [Delete queue](#delete-queue)
- [Get the wrap-up codes for a queue](#get-the-wrap-up-codes-for-a-queue)
- [Get the members of a queue](#get-the-members-of-a-queue)
- [Testing](#testing)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Security Vulnerabilities](#security-vulnerabilities)
- [Credits](#credits)
- [License](#license)
## Installation
You can install the package via composer:
```bash
composer require vormkracht10/genesys-api
```
## Usage
### Authentication
This package only provides a way to interact with the API. To handle the authentication logic we created the [oauth2-genesys](https://github.com/vormkracht10/oauth2-genesys) package which provides a [league/oauth2-client](https://github.com/thephpleague/oauth2-client) provider for Genesys.
### Create Genesys API client
```php
use Vormkracht10\GenesysApi\Genesys;
$accessToken = '{access-token}';
$genesys = Genesys::api(
region: 'us-west-1', // optional, default is 'us-east-1'
accessToken: $accessToken
);
```
### Conversations
#### Get conversation
```php
$genesys->conversations()->get(id: '{conversation-id}');
```
#### List conversations
```php
$genesys->conversations()->list();
```
#### Create conversation
```php
$genesys->conversations()->create(
params: []
);
```
#### Messages for conversation
```php
$genesys->conversations()->messages(id: '{conversation-id}');
```
#### Message for conversation
```php
$genesys->conversations()->message(
conversationId: '{conversation-id}',
messageId: '{message-id}'
);
```
#### Get message draft for conversation
```php
$genesys->conversations()->getMessageDraft(
conversationId: '{conversation-id}',
);
```
#### Update message draft for conversation
```php
$genesys->conversations()->updateMessageDraft(
conversationId: '{conversation-id}',
params: []
);
```
#### Update conversation participant
```php
$genesys->conversations()->updateParticipant(
conversationId: '{conversation-id}',
participantId: '{participant-id}',
params: []
);
```
#### Emails for conversation
```php
$genesys->conversations()->emails(id: '{conversation-id}');
```
#### Update attributes for conversation
```php
$genesys->conversations()->updateAttributes(
conversationId: '{conversation-id}',
participantId: '{participant-id}',
params: [
'labels' => ['Done', 'Mailed customer']
]
);
```
#### Replace participant
```php
$genesys->conversations()->replaceParticipant(
conversationId: '{conversation-id}',
participantId: '{participant-id}',
params: [
'userId' => '{user-id}'
]
);
```
### Users
#### Get user
```php
$genesys->users()->get(id: '{user-id}');
// With parameters
$genesys->users()->get(id: '{user-id}', params: ['expand' => 'languagePreference']);
```
#### List users
```php
$genesys->users()->list();
```
#### Create user
```php
$genesys->users()->create([
'name' => 'Test',
'department' => 'Test Department',
'email' => '[email protected]',
'addresses' => [],
'title' => 'Lorem Ipsum',
'password' => 'P1hQrt4WytLxz2gF%LYc',
'divisionId' => null,
'state' => 'active',
])
```
#### Update user
```php
$genesys->users()->update(
id: '{user-id}',
params: [
'name' => 'New name',
]);
```
#### Delete user
```php
$genesys->users()->delete(id: '{user-id}');
```
#### Get queues for user
```php
$genesys->users()->queues(id: '{user-id}');
```
### Queues
#### Get queue
```php
$genesys->queues()->get(id: '{queue-id}');
```
#### List queues
```php
$genesys->queues()->list([
'pageNumber' => 1,
'pageSize' => 25,
'sortOrder' => 'desc',
]);
```
#### Create queue
```php
$genesys->queues()->create([
'name' => 'Test queue'
]);
```
#### Update queue
```php
$genesys->queues()->update(
id: '{queue-id}',
params: [
'name' => 'New name',
]);
```
#### Delete queue
```php
$genesys->queues()->delete(id: '{queue-id}');
```
#### Get the wrap-up codes for a queue
```php
$genesys->queues()->getWrapupCodes(
id: '{queue-id}',
params: [
'pageSize' => 25,
'pageNumber' => 1
]
);
```
#### Get the members of a queue
```php
$genesys->queues()->members(
id: '{queue-id}',
params: [
'pageSize' => 25,
'pageNumber' => 1
]
);
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Bas van Dinther](https://github.com/vormkracht10)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.