README

Spryng PHP API库

您好，欢迎使用Spryng PHP API库的文档。本指南包含如何使用库的实用信息。完整的PHPDOC可以在此存储库中找到。

安装和初始化

使用composer

安装库最简单的方法是使用composer

composer require spryng/spryng-api-http-php

安装完成后，您可以按如下方式初始化Spryng

require( 'vendor/autoload.php');

use SpryngApiHttpPhp\Client;

$spryng = new Client('username', 'password', 'My Company');

不使用composer

如果您尚未使用composer，可以使用自动加载器

require ('SpryngApiHttpPhp/src/Spryng/Api/Autoloader.php');

$spryng = new Client('username', 'password', 'My Company');

发送短信

要发送短信，您应使用Client::sms->send()方法。它接受以下参数

• $recipient 接收短信的电话号码
• $body 短信正文
• $options 如allowlong和route之类的附加参数

选项

您可以在请求中指定多个选项。这些选项的要求可以在通用文档中找到。

• route 输入您的分配路由。
• reference 用于投递报告的可选引用。
• allowlong 是否允许长短信。应该是true或false。
• rawencoding ISO/UTF编码

完整示例

require( 'vendor/autoload.php')

use SpryngApiHttpPhp\Client;

$spryng = new Client('username', 'password', 'My Company');

try 
{
    $spryng->sms->send('31612345678', 'A sample message!', array(
        'route'     => 'business',
         'allowlong' => true
         'reference' => 'ABC123456789'
         'rawencoding' => false)
    );
}
catch (InvalidRequestException $e)
{
    echo $e->getMessage();
}

请求信用余额

除了发送短信消息外，还可能请求当前的信用余额。此方法不需要任何参数，可以使用如下方式使用

require( 'vendor/autoload.php')

use SpryngApiHttpPhp\Client;

$spryng = new Client('username', 'password', 'My Company');

echo 'Current credit balance: ' . $spryng->sms->checkBalance();