README

这是一个基本的Slim 4 PHP应用程序，用于测试和调试您的Vonage凭证和环境。利用此应用程序来测试您的API凭证是否正常工作，并检查当API请求由Vonage从您的账户接收时，您收到的 webhook 事件数据。

需求
安装和用法
贡献
许可

需求

此应用程序要求您在本地安装以下内容

此外，为了测试您的Vonage账户，您必须有一个Vonage账户。您可以在Vonage仪表板免费创建一个Vonage账户或管理您的Vonage账户详细信息。

此应用程序旨在作为独立测试运行，但也可以与Apache或nginx等Web服务器一起使用。

安装和用法

您可以通过在本地克隆此存储库来运行此应用程序

composer create-project vonage/php-skeleton-app

或者，您可以通过git克隆此存储库

git clone git@github.com:Nexmo/php-skeleton-app.git

一旦您下载了本地副本，请切换到您的终端中的应用程序目录，并安装依赖项

composer install

现在您可以为您自己的Vonage账户设置应用程序。

配置应用程序

为了测试您的API凭证，将提供的.env.example文件重命名为.env，并填写以下环境变量键的值

VONAGE_API_KEY=
VONAGE_API_SECRET=

您可以在您的账户仪表板中找到VONAGE_API_KEY和VONAGE_API_SECRET。

一如既往，请确保不要将敏感的API凭证数据提交到任何公开的版本控制（不要担心，.env文件已在.gitignore中排除）。

运行应用程序

一旦您的API凭证准备就绪，您可以继续使用此骨架应用程序。要启动应用程序的服务器，请在应用程序目录中从命令行运行以下操作

composer run --timeout=0 serve

在浏览器中访问http://localhost:8080，您应该会看到一个准备发送的表单。

发送短信以测试您的设置

您可以通过在浏览器中访问http://localhost:8000并填写表单来测试您的凭证是否有效。您需要提供以下内容

发送短信的电话号码，例如您的个人手机
您希望测试短信消息的起始号码。例如，这可能是您的Vonage配置的虚拟电话号码
要发送的消息

填写字段并选择"发送短信" ... 然后检查您的手机！

处理事件webhook

为了测试从Vonage接收的webhook数据，Vonage API需要一个外部可访问的URL来发送这些数据。开发测试中常用的是ngrok。此服务将为您提供外部可用的Web地址，并创建一个到本地环境的加密隧道。有关使用ngrok进行测试的指南，请参阅Vonage开发者平台，以下是简要说明

ngrok http 8000

当创建隧道时，复制转发URL（看起来类似于https://abcd1234.ngrok.io）；这是您本地应用程序的公开URL。您可以使用它将Vonage服务器的webhooks定向到您的本地应用程序。

一旦您有了ngrok URL，您就可以进入您的Vonage仪表板，并将它作为任何通过webhooks发送事件数据的Vonage服务的事件URL提供。一个很好的测试案例是创建一个语音应用程序，并将以下格式的ngrok URL作为事件URL提供

#{ngrok URL}/webhooks/event

然后您可以调用您的Vonage语音应用程序，并在您的骨架应用程序运行的情况下，可以实时观察webhook数据以诊断任何问题并测试您的Vonage账户。

骨架应用程序还能够接收Vonage API webhook数据。如上文所述的使用ngrok部分，一个很好的测试候选者是Vonage语音应用程序。在您的Vonage仪表板中，您可以创建一个Vonage语音应用程序，配置一个Vonage虚拟电话号码，然后将该号码链接到您的语音应用程序。一旦您确保了您新的语音应用程序的事件URL是#{ngrok URL}/webhooks/event，您就可以给您的Vonage号码打电话。您应该在您的控制台中实时看到webhook数据。例如，响铃电话的数据可能如下所示

[Mon Mar 16 22:03:24 2020] {"from":"447700900000", "to":"447700900000", "uuid":"a123456789012345fbdsw", "conversation_uuid":"CON-234567-fdsfs34-vfddfh-btger3-22345", "status":"ringing", "direction":"inbound", "timestamp":"2020-01-07T11:24:49.478Z"}

您可以通过按住键盘上的CTRL和C键随时退出您的应用程序。

贡献

我们热爱来自每个人的贡献！错误报告、错误修复和对应用程序的反馈始终受到欢迎。请参阅贡献指南以获取更多信息，并请遵循GitHub流程。

许可

该项目受MIT许可证的约束。

vonage / php-skeleton-app

维护者

详细信息