{"id":50226908,"url":"https://github.com/ux-nl/genesys-api","last_synced_at":"2026-05-26T16:03:48.869Z","repository":{"id":148116794,"uuid":"546018127","full_name":"ux-nl/genesys-api","owner":"ux-nl","description":"PHP package to communicate with the Genesys API. ","archived":false,"fork":false,"pushed_at":"2026-01-12T10:46:34.000Z","size":121,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-02-06T09:11:47.036Z","etag":null,"topics":["api","api-client","genesys","genesys-cloud","genesyscloud","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/ux-nl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"vormkracht10"}},"created_at":"2022-10-05T11:32:38.000Z","updated_at":"2026-01-12T10:46:38.000Z","dependencies_parsed_at":"2025-01-10T22:38:08.675Z","dependency_job_id":null,"html_url":"https://github.com/ux-nl/genesys-api","commit_stats":null,"previous_names":["ux-nl/genesys-api"],"tags_count":0,"template":false,"template_full_name":"ux-nl/php-package-template","purl":"pkg:github/ux-nl/genesys-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ux-nl%2Fgenesys-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ux-nl%2Fgenesys-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ux-nl%2Fgenesys-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ux-nl%2Fgenesys-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ux-nl","download_url":"https://codeload.github.com/ux-nl/genesys-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ux-nl%2Fgenesys-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33528089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"ssl_error","status_checked_at":"2026-05-26T15:22:15.568Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["api","api-client","genesys","genesys-cloud","genesyscloud","php"],"created_at":"2026-05-26T16:03:46.491Z","updated_at":"2026-05-26T16:03:48.859Z","avatar_url":"https://github.com/ux-nl.png","language":"PHP","funding_links":["https://github.com/sponsors/vormkracht10"],"categories":[],"sub_categories":[],"readme":"# PHP Genesys API\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/vormkracht10/genesys-api.svg?style=flat-square)](https://packagist.org/packages/vormkracht10/genesys-api)\n[![Tests](https://github.com/vormkracht10/genesys-api/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/vormkracht10/genesys-api/actions/workflows/run-tests.yml)\n[![Total Downloads](https://img.shields.io/packagist/dt/vormkracht10/genesys-api.svg?style=flat-square)](https://packagist.org/packages/vormkracht10/genesys-api)\n\nThis package is a PHP wrapper for the [Genesys](https://www.genesys.com/) API. The package provides a fluent syntax to interact with the API.\n\n-   [Installation](#installation)\n-   [Usage](#usage)\n    -   [Authentication](#authentication)\n    -   [Create Genesys API client](#create-genesys-api-client)\n    -   [Conversations](#conversations)\n        -   [Get conversation](#get-conversation)\n        -   [List conversations](#list-conversations)\n        -   [Create conversation](#create-conversation)\n        -   [Messages for conversation](#messages-for-conversation)\n        -   [Message for conversation](#message-for-conversation)\n        -   [Get message draft for conversation](#get-message-draft-for-conversation)\n        -   [Update message draft for conversation](#update-message-draft-for-conversation)\n        -   [Update conversation participant](#update-conversation-participant)\n        -   [Emails for conversation](#emails-for-conversation)\n        -   [Update attributes for conversation](#update-attributes-for-conversation)\n        -   [Replace participant](#replace-participant)\n    -   [Users](#users)\n        -   [Get user](#get-user)\n        -   [List users](#list-users)\n        -   [Create user](#create-user)\n        -   [Update user](#update-user)\n        -   [Delete user](#delete-user)\n        -   [Get queues for user](#get-queues-for-user)\n    -   [Queues](#queues)\n        -   [Get queue](#get-queue)\n        -   [List queues](#list-queues)\n        -   [Create queue](#create-queue)\n        -   [Update queue](#update-queue)\n        -   [Delete queue](#delete-queue)\n        -   [Get the wrap-up codes for a queue](#get-the-wrap-up-codes-for-a-queue)\n        -   [Get the members of a queue](#get-the-members-of-a-queue)\n-   [Testing](#testing)\n-   [Changelog](#changelog)\n-   [Contributing](#contributing)\n-   [Security Vulnerabilities](#security-vulnerabilities)\n-   [Credits](#credits)\n-   [License](#license)\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require vormkracht10/genesys-api\n```\n\n## Usage\n\n### Authentication\n\nThis 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.\n\n### Create Genesys API client\n\n```php\nuse Vormkracht10\\GenesysApi\\Genesys;\n\n$accessToken = '{access-token}';\n\n$genesys = Genesys::api(\n  region: 'us-west-1', // optional, default is 'us-east-1'\n  accessToken: $accessToken\n);\n```\n\n### Conversations\n\n#### Get conversation\n\n```php\n$genesys-\u003econversations()-\u003eget(id: '{conversation-id}');\n```\n\n#### List conversations\n\n```php\n$genesys-\u003econversations()-\u003elist();\n```\n\n#### Create conversation\n\n```php\n$genesys-\u003econversations()-\u003ecreate(\n  params: []\n);\n```\n\n#### Messages for conversation\n\n```php\n$genesys-\u003econversations()-\u003emessages(id: '{conversation-id}');\n```\n\n#### Message for conversation\n\n```php\n$genesys-\u003econversations()-\u003emessage(\n  conversationId: '{conversation-id}',\n  messageId: '{message-id}'\n);\n```\n\n#### Get message draft for conversation\n\n```php\n$genesys-\u003econversations()-\u003egetMessageDraft(\n  conversationId: '{conversation-id}',\n);\n```\n\n#### Update message draft for conversation\n\n```php\n$genesys-\u003econversations()-\u003eupdateMessageDraft(\n  conversationId: '{conversation-id}',\n  params: []\n);\n```\n\n#### Update conversation participant\n\n```php\n$genesys-\u003econversations()-\u003eupdateParticipant(\n  conversationId: '{conversation-id}',\n  participantId: '{participant-id}',\n  params: []\n);\n```\n\n#### Emails for conversation\n\n```php\n$genesys-\u003econversations()-\u003eemails(id: '{conversation-id}');\n```\n\n#### Update attributes for conversation\n\n```php\n$genesys-\u003econversations()-\u003eupdateAttributes(\n  conversationId: '{conversation-id}',\n  participantId: '{participant-id}',\n  params: [\n    'labels' =\u003e ['Done', 'Mailed customer']\n  ]\n);\n```\n\n#### Replace participant\n\n```php\n$genesys-\u003econversations()-\u003ereplaceParticipant(\n  conversationId: '{conversation-id}',\n  participantId: '{participant-id}',\n  params: [\n    'userId' =\u003e '{user-id}'\n  ]\n);\n```\n\n### Users\n\n#### Get user\n\n```php\n$genesys-\u003eusers()-\u003eget(id: '{user-id}');\n\n// With parameters\n$genesys-\u003eusers()-\u003eget(id: '{user-id}', params: ['expand' =\u003e 'languagePreference']);\n```\n\n#### List users\n\n```php\n$genesys-\u003eusers()-\u003elist();\n```\n\n#### Create user\n\n```php\n$genesys-\u003eusers()-\u003ecreate([\n  'name' =\u003e 'Test',\n  'department' =\u003e 'Test Department',\n  'email' =\u003e 'test@testdepartment.com',\n  'addresses' =\u003e [],\n  'title' =\u003e 'Lorem Ipsum',\n  'password' =\u003e 'P1hQrt4WytLxz2gF%LYc',\n  'divisionId' =\u003e null,\n  'state' =\u003e 'active',\n])\n```\n\n#### Update user\n\n```php\n$genesys-\u003eusers()-\u003eupdate(\n  id: '{user-id}',\n  params: [\n    'name' =\u003e 'New name',\n]);\n```\n\n#### Delete user\n\n```php\n$genesys-\u003eusers()-\u003edelete(id: '{user-id}');\n```\n\n#### Get queues for user\n\n```php\n$genesys-\u003eusers()-\u003equeues(id: '{user-id}');\n```\n\n### Queues\n\n#### Get queue\n\n```php\n$genesys-\u003equeues()-\u003eget(id: '{queue-id}');\n```\n\n#### List queues\n\n```php\n$genesys-\u003equeues()-\u003elist([\n  'pageNumber' =\u003e 1,\n  'pageSize' =\u003e 25,\n  'sortOrder' =\u003e 'desc',\n]);\n```\n\n#### Create queue\n\n```php\n$genesys-\u003equeues()-\u003ecreate([\n  'name' =\u003e 'Test queue'\n]);\n```\n\n#### Update queue\n\n```php\n$genesys-\u003equeues()-\u003eupdate(\n  id: '{queue-id}',\n  params: [\n    'name' =\u003e 'New name',\n]);\n```\n\n#### Delete queue\n\n```php\n$genesys-\u003equeues()-\u003edelete(id: '{queue-id}');\n```\n\n#### Get the wrap-up codes for a queue\n\n```php\n$genesys-\u003equeues()-\u003egetWrapupCodes(\n  id: '{queue-id}',\n  params: [\n    'pageSize' =\u003e 25,\n    'pageNumber' =\u003e 1\n  ]\n);\n```\n\n#### Get the members of a queue\n\n```php\n$genesys-\u003equeues()-\u003emembers(\n  id: '{queue-id}',\n  params: [\n    'pageSize' =\u003e 25,\n    'pageNumber' =\u003e 1\n  ]\n);\n```\n\n## Testing\n\n```bash\ncomposer test\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](../../security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n-   [Bas van Dinther](https://github.com/vormkracht10)\n-   [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fux-nl%2Fgenesys-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fux-nl%2Fgenesys-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fux-nl%2Fgenesys-api/lists"}