Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxbeckers/amazon-alexa-php
Php library for amazon echo (alexa) skill development.
https://github.com/maxbeckers/amazon-alexa-php
alexa alexa-custom-skill alexa-sdk alexa-skill alexa-skill-kit amazon amazon-alexa-php amazon-alexa-skill amazon-echo echo library php php7 php71 php72 skill ssml
Last synced: 26 days ago
JSON representation
Php library for amazon echo (alexa) skill development.
- Host: GitHub
- URL: https://github.com/maxbeckers/amazon-alexa-php
- Owner: maxbeckers
- License: mit
- Created: 2017-07-08T12:06:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T09:50:29.000Z (6 months ago)
- Last Synced: 2024-09-29T19:41:27.452Z (about 1 month ago)
- Topics: alexa, alexa-custom-skill, alexa-sdk, alexa-skill, alexa-skill-kit, amazon, amazon-alexa-php, amazon-alexa-skill, amazon-echo, echo, library, php, php7, php71, php72, skill, ssml
- Language: PHP
- Homepage:
- Size: 387 KB
- Stars: 113
- Watchers: 13
- Forks: 29
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://scrutinizer-ci.com/g/maxbeckers/amazon-alexa-php/?branch=master)
[](https://scrutinizer-ci.com/g/maxbeckers/amazon-alexa-php/?branch=master)
[](https://scrutinizer-ci.com/g/maxbeckers/amazon-alexa-php/?branch=master)
[](https://opensource.org/licenses/mit-license.php)
[](https://github.com/maxbeckers/amazon-alexa-php/issues)
# Amazon alexa php library
This library is a helper for amazon echo (alexa) skills with php. With this library it's very simple to handle alexa requests in your php application. You only create some handlers for the requests of your alexa skill and add them to a registry.
## Install via composer
Require the package with composer:
```
composer require maxbeckers/amazon-alexa-php
```
## Usage
Handle the request:
- map request data to request object
- validate request
- handle request data
- create response
- send response
### Map request data to request object
Map needed request headers and request body to `Request`.
```php
use MaxBeckers\AmazonAlexa\Request\Request;
...
$requestBody = file_get_contents('php://input');
$alexaRequest = Request::fromAmazonRequest($requestBody, $_SERVER['HTTP_SIGNATURECERTCHAINURL'], $_SERVER['HTTP_SIGNATURE']);
```
### Validate request
The `RequestValidator` will handle the amazon request validation.
```php
use MaxBeckers\AmazonAlexa\Validation\RequestValidator;
...
$validator = new RequestValidator();
$validator->validate($alexaRequest);
```
### Register request handlers
For different requests it's helpful to create different RequestHandlers.
```php
use MaxBeckers\AmazonAlexa\RequestHandler\RequestHandlerRegistry;
...
$requestHandlerRegistry = new RequestHandlerRegistry();
$requestHandlerRegistry->addHandler($myRequestHandler);
```
### Use registry to handle request
```php
use MaxBeckers\AmazonAlexa\RequestHandler\RequestHandlerRegistry;
...
$requestHandler = $requestHandlerRegistry->getSupportingHandler($alexaRequest);
$response = $requestHandler->handleRequest($alexaRequest);
```
### Render response
```php
header('Content-Type: application/json');
echo json_encode($response);
exit();
```
### Create a new request handler
The new request handler must extend `AbstractRequestHandler`.
In constructor set the `supportedApplicationIds` to your skill Ids.
```php
public function __construct()
{
$this->supportedApplicationIds = ['my_amazon_skill_id'];
}
```
Then implement the abstract `supportsRequest`-method.
```php
public function supportsRequest(Request $request): bool
{
return $request->request instanceOf MaxBeckers\AmazonAlexa\Request\Request\Standard\IntentRequest &&
'MyTestIntent' === $request->request->intent->name;
}
```
Then implement the `handleRequest`-method. For simple responses there is a `ResponseHelper`.
```php
use MaxBeckers\AmazonAlexa\Helper\ResponseHelper;
...
public function handleRequest(Request $request): Response
{
return $this->responseHelper->respond('Success :)');
}
```
## Check device address information
To get either "Full Address" or "Country & Postal Code" from the customer you need the permissions for user api call. More informations for the call see [device-address-api](https://developer.amazon.com/de/docs/custom-skills/device-address-api.html).
```php
$helper = new DeviceAddressInformationHelper();
$fullAddress = $helper->getAddress($request);
$countryAndPostalCode = $helper->getCountryAndPostalCode($request);
```
## Generate SSML
For SSML output you can use the `SsmlGenerator`. With the helper will generate valid SSML for alexa. All types of alexa known SSML tags have a function in the `SsmlGeneator`.
You can add all SSML you need to the generator and call `getSsml` to get the full string.
```php
$ssmlGenerator = new SsmlGenerator();
$ssmlGenerator->say('one');
$ssmlGenerator->pauseStrength(SsmlGenerator::BREAK_STRENGTH_MEDIUM);
$ssmlGenerator->say('two');
$ssml = $ssmlGenerator->getSsml();
// $ssml === 'one two'
```
## Symfony Integration
There is also a symfony bundle on [maxbeckers/amazon-alexa-bundle](https://github.com/maxbeckers/amazon-alexa-bundle).