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.
Require the package with composer:
composer require maxbeckers/amazon-alexa-php
Handle the request:
- map request data to request object
- validate request
- handle request data
- create response
- send response
Map needed request headers and request body to Request.
use MaxBeckers\AmazonAlexa\Request\Request;
...
$requestBody = file_get_contents('php://input');
$alexaRequest = Request::fromAmazonRequest($requestBody, $_SERVER['HTTP_SIGNATURECERTCHAINURL'], $_SERVER['HTTP_SIGNATURE']);The RequestValidator will handle the amazon request validation.
use MaxBeckers\AmazonAlexa\Validation\RequestValidator;
...
$validator = new RequestValidator();
$validator->validate($alexaRequest);For different requests it's helpful to create different RequestHandlers.
use MaxBeckers\AmazonAlexa\RequestHandler\RequestHandlerRegistry;
...
$requestHandlerRegistry = new RequestHandlerRegistry();
$requestHandlerRegistry->addHandler($myRequestHandler);use MaxBeckers\AmazonAlexa\RequestHandler\RequestHandlerRegistry;
...
$requestHandler = $requestHandlerRegistry->getSupportingHandler($alexaRequest);
$response = $requestHandler->handleRequest($alexaRequest);header('Content-Type: application/json');
echo json_encode($response);
exit();The new request handler must extend AbstractRequestHandler.
In constructor set the supportedApplicationIds to your skill Ids.
public function __construct()
{
$this->supportedApplicationIds = ['my_amazon_skill_id'];
}Then implement the abstract supportsRequest-method.
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.
use MaxBeckers\AmazonAlexa\Helper\ResponseHelper;
...
public function handleRequest(Request $request): Response
{
return $this->responseHelper->respond('Success :)');
}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.
$helper = new DeviceAddressInformationHelper();
$fullAddress = $helper->getAddress($request);
$countryAndPostalCode = $helper->getCountryAndPostalCode($request);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.
$ssmlGenerator = new SsmlGenerator();
$ssmlGenerator->say('one');
$ssmlGenerator->pauseStrength(SsmlGenerator::BREAK_STRENGTH_MEDIUM);
$ssmlGenerator->say('two');
$ssml = $ssmlGenerator->getSsml();
// $ssml === '<speak>one <break strength="medium" /> two</speak>'There is also a symfony bundle on maxbeckers/amazon-alexa-bundle.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent