README

Releans SDK 允许开发者将其代码中的 Releans 服务。您可以在几分钟内开始使用。

composer require releans/releansapi

创建 Releans 账户

首先，如果您还没有，请通过 注册 Releans 账户，并在仪表板 API 页面上记下您的 API 密钥。

初始化

身份验证

为了设置 API 客户端的身份验证和初始化，您需要以下信息。

API 客户端可以按以下方式初始化。

$oAuthAccessToken = 'oAuthAccessToken'; // OAuth 2.0 Access Token

$client = new ReleansAPILib\ReleansAPIClient($oAuthAccessToken);

类参考

控制器列表

• MessageController
• SenderController
• BalanceController

MessageController

获取单例实例

可以通过 API 客户端访问 MessageController 类的单例实例。

$message = $client->getMessage();

getAllMessages

列出账户发送的所有消息。

function getAllMessages($accept)

参数

示例用法

$accept = '*/*';

$result = $message->getAllMessages($accept);

getViewMessage

返回消息的详细信息。

function getViewMessage(
        $id,
        $accept)

参数

示例用法

$id = 'id';
$accept = '*/*';

$result = $message->getViewMessage($id, $accept);

createSendSMSMessage

发送单个消息。

function createSendSMSMessage(
        $accept,
        $senderId,
        $mobileNumber,
        $body)

参数

示例用法

$accept = 'Accept';
$senderId = 'senderId';
$mobileNumber = 'mobileNumber';
$body = 'message';

$result = $message->createSendSMSMessage($accept, $senderId, $mobileNumber, $body);

完整代码示例

use ReleansAPILib\APIException;
use ReleansAPILib\ReleansAPIClient;


$oAuthAccessToken = 'YOUR_API_KEY'; // OAuth 2.0 Access Token
$client = new ReleansAPIClient($oAuthAccessToken);
$message = $client->getMessage();
$accept = 'Accept';
$senderId = 'Sender_Name_ID';
$mobileNumber = '+44123456789';
$body = 'Hello from Releans';

$result = $message->createSendSMSMessage($accept, $senderId, $mobileNumber, $body);

返回控制器列表

SenderController

获取单例实例

可以从API客户端访问SenderController类的单例实例。

$sender = $client->getSender();

getSenderNameDetails

返回发送者名称的详细信息。

function getSenderNameDetails(
        $id,
        $accept)

参数

示例用法

$id = 'sender-id';
$accept = '*/*';

$result = $sender->getSenderNameDetails($id, $accept);

createSenderName

创建一个新的发送者ID，以便使用它发送消息。

function createSenderName(
        $accept,
        $contentType,
        $body)

参数

示例用法

$accept = 'text/plain';
$contentType = 'text/plain';
$body = 'Your sender name';

$result = $sender->createSenderName($accept, $contentType, $body);

getAllSenders

列出与账户关联的所有发送者名称

function getAllSenders($accept)

参数

示例用法

$accept = '*/*';

$result = $sender->getAllSenders($accept);

返回控制器列表

BalanceController

获取单例实例

可以从API客户端访问BalanceController类的单例实例。

$balance = $client->getBalance();

getBalance

获取您的可用余额

function getBalance($accept)

参数

示例用法

$accept = 'text/plain';

$result = $balance->getBalance($accept);

返回控制器列表

=======

入门

Releans SDK 允许开发者将其代码中的 Releans 服务。您可以在几分钟内开始使用。

composer require releans/php-client-sdk

初始化

身份验证

为了设置 API 客户端的身份验证和初始化，您需要以下信息。

API 客户端可以按以下方式初始化。

$oAuthAccessToken = 'oAuthAccessToken'; // OAuth 2.0 Access Token

$client = new ReleansAPILib\ReleansAPIClient($oAuthAccessToken);

类参考

控制器列表

• MessageController
• SenderController
• BalanceController

MessageController

获取单例实例

可以通过 API 客户端访问 MessageController 类的单例实例。

$message = $client->getMessage();

getAllMessages

列出账户发送的所有消息。

function getAllMessages($accept)

参数

示例用法

$accept = '*/*';

$result = $message->getAllMessages($accept);

getViewMessage

返回消息的详细信息。

function getViewMessage(
        $id,
        $accept)

参数

示例用法

$id = 'id';
$accept = '*/*';

$result = $message->getViewMessage($id, $accept);

createSendSMSMessage

发送单个消息。

function createSendSMSMessage(
        $accept,
        $senderId,
        $mobileNumber,
        $message)

参数

示例用法

$accept = 'Accept';
$senderId = 'senderId';
$mobileNumber = 'mobileNumber';
$message = 'message';

$result = $message->createSendSMSMessage($accept, $senderId, $mobileNumber, $message);

返回控制器列表

SenderController

获取单例实例

可以从API客户端访问SenderController类的单例实例。

$sender = $client->getSender();

getSenderNameDetails

返回发送者名称的详细信息。

function getSenderNameDetails(
        $id,
        $accept)

参数

示例用法

$id = 'sender-id';
$accept = '*/*';

$result = $sender->getSenderNameDetails($id, $accept);

createSenderName

创建一个新的发送者ID，以便使用它发送消息。

function createSenderName(
        $accept,
        $contentType,
        $body)

参数

示例用法

$accept = 'text/plain';
$contentType = 'text/plain';
$body = 'Your sender name';

$result = $sender->createSenderName($accept, $contentType, $body);

getAllSenders

列出与账户关联的所有发送者名称

function getAllSenders($accept)

参数

示例用法

$accept = '*/*';

$result = $sender->getAllSenders($accept);

返回控制器列表

BalanceController

获取单例实例

可以从API客户端访问BalanceController类的单例实例。

$balance = $client->getBalance();

getBalance

获取您的可用余额

function getBalance($accept)

参数

示例用法

$accept = 'text/plain';

$result = $balance->getBalance($accept);

返回控制器列表