bahricanli/corvass-php

Corvass API 的 PHP 客户端库

1.1.0 2022-07-26 12:37 UTC

This package is not auto-updated.

Last update: 2024-09-17 23:00:00 UTC


README

Latest Version on Packagist Software License Build Status StyleCI Scrutinizer Code Quality Code Coverage Total Downloads

此软件包提供了一种易于使用的 Corvass 服务,可以与 XML 和 Http API 一起使用。

此软件包同时支持 XML 和 Http API,提供了一个易于使用的 Corvass 服务。

如需查看土耳其语版本,请访问:BENIOKU

内容

安装

您可以通过 composer 安装此软件包

composer require bahricanli/corvass-php

设置 Corvass 服务

您需要注册 Corvass 才能使用此通道。

使用方法

首先,使用您选择的客户端实现启动 CorvassService。

  • CorvassXmlClient
  • CorvassHttpClient(这实际上是一个类似 Rest 的客户端,但供应商这样命名他们的 API。)
require __DIR__ . '/../vendor/autoload.php';

use BahriCanli\Corvass\CorvassService;
use BahriCanli\Corvass\CorvassService;
use BahriCanli\Corvass\ShortMessageFactory;
use BahriCanli\Corvass\Http\Clients\CorvassXmlClient;
use BahriCanli\Corvass\Http\Clients\CorvassHttpClient;
use BahriCanli\Corvass\ShortMessageCollectionFactory;

$service = new CorvassService(new CorvassXmlClient(
    'sms.corvass.net/xml',
    'username',
    'password',
    'outboxname'
), new ShortMessageFactory(), new ShortMessageCollectionFactory());

// ya da

$service = new CorvassService(new CorvassHttpClient(
    new GuzzleHttp\Client(),
    'https://sms.corvass.net/http',
    'username',
    'password',
    'outboxname'
), new ShortMessageFactory(), new ShortMessageCollectionFactory());

可用方法

成功启动您的 CorvassService 实例后;使用以下方法之一发送短信。

一条消息 - 单个或多个接收者

$response = $service->sendShortMessage(['5530000000', '5420000000'], 'This is a test message.');

if($response->isSuccessful()) {
    // storeGroupIdForLaterReference is not included in the package.
    storeGroupIdForLaterReference($response->groupId());
} else {
    var_dump($response->message());
    var_dump($response->statusCode());
    var_dump($response->status());
}

多条消息 - 多个接收者

请注意,如果您使用该方法,每条消息只能有一个接收者。(这也是一个 API 限制,我没有破解。)

$response2 = $service->sendShortMessages([[
    'recipient' => '5530000000',
    'message' => 'This is a test.',
], [
    'recipient' => '5420000000',
    'message' => 'This is another test.',
]]);

if($response2->isSuccessful()) {
    // storeGroupIdForLaterReference is not included in the package.
    storeGroupIdForLaterReference($response2->groupId());
} else {
    var_dump($response2->message());
    var_dump($response2->statusCode());
    var_dump($response2->status());
}

交叉引用

$response->groupId() 如果客户端是 CorvassHttpClient,则会抛出 BadMethodCallException。$response->messageReportIdentifiers() 如果客户端是 CorvassXmlClient,则会抛出 BadMethodCallException。

谨慎更改客户端实现。

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

测试

$ composer test

安全性

如果您发现任何安全相关的问题,请通过电子邮件 bahri@bahri.info 联系,而不是使用问题跟踪器。

贡献

有关详细信息,请参阅 CONTRIBUTING

鸣谢

许可证

MIT 许可证(MIT)。请参阅 许可证文件 以获取更多信息。