宣传局 / whatsatool-client
Laravel 包,用于与 WhatSATool API 进行通信
v1.0
2017-08-02 12:04 UTC
Requires
- guzzlehttp/guzzle: ^6.3
- illuminate/support: ~5
Requires (Dev)
- mockery/mockery: ^0.9.9
- orchestra/testbench: ^3.4
- phpunit/phpunit: ^6.2
This package is auto-updated.
Last update: 2024-09-18 03:14:20 UTC
README
描述
此库提供了与 WhatSATool API 通信的基本功能。
安装
首先在 Composer 中要求
composer require campaigningbureau/whatsatool-client
在您的 config/app.php
中添加服务提供者
'providers' => [ ... CampaigningBureau\WhatsAToolClient\WhatsAToolClientProvider::class, ]
您还可以在那里添加外观
'aliases' => [ ... 'WhatsAToolClient' => CampaigningBureau\WhatsAToolClient\WhatsAToolClientFacade::class, ]
发布配置设置
$ php artisan vendor:publish
配置
发布配置文件后,您可以在 config/whatsatool.php
中编辑它们。
请确保您至少配置了 username
和 password
。
default_country_code
用于在提供带本地国家代码的手机号码时创建正确的 MSISDN(例如 0664/1234567)
用法
验证
验证给定的号码
$phonenumber = '+43 664 123 456 87'; CampaigningBureau\WhatsAToolClient\Msisdn::validatePhonenumber($phonenumber);
验证会清理手机号码,这意味着 移除所有非数字字符和前导 00
并检查
- 清理后的手机号码不为空
- 长度小于或等于 15 个字符(有趣的事实:没有官方的最小长度限制)
- 手机号码以有效的 国家代码 开头,该代码可以是
0
(本地)或可在此列表中找到的国家代码。
注册联系人
注册新联系人
$phonenumber = '+43 664 123 456 87'; $msisdn = new Msisdn($phonenumber); try { $simMsisdn = WhatsATool::registerContact($msisdn, $channel, $sendSms); } catch (WhatsAToolException $exception) { Log::error($exception->getMessage()); }
这返回该号码注册的 Sim 的 msisdn 或抛出包含 WhatSATool-API 错误消息的 WhatsAToolException
。
开发
如果您在环境中安装了 PHPUnit,请运行
$ phpunit
如果您未安装 PHPUnit,您可以运行以下命令
$ composer update
$ ./vendor/bin/phpunit
致谢
Msisdn-Logic 基于 https://github.com/CoreProc/msisdn-ph-php/。