README

Cecula SMS

介绍

Cecula SMS包（也称为库）使您能够快速集成并从您的应用程序中发送A2P和P2P消息。

如何使用

按照安装部分中的说明使用composer安装Cecula SMS，或从GitHub克隆
登录到Cecula开发者平台，注册您的应用程序并生成API密钥
将Cecula类包含或require到您的脚本中

安装

使用composer安装

composer require cecula/sms

从GitHub克隆

git clone https//github.com/cecula/php-library.git

如何生成API密钥

您的API密钥首次在注册应用程序时生成。要注册应用程序，请登录到开发者仪表板，导航到应用程序 > 添加，输入您应用程序的名称，然后点击提交。应用程序将被注册，并将生成新的API密钥。将API密钥复制到您的项目中。点击developer.cecula.com开始。

将包加载到您的项目中

如果您使用composer安装了应用程序，请使用以下代码将包加载到您的项目中

require_once __DIR__."/vendor/autoload.php"
$cecula = new \Cecula\Cecula("<API_KEY>");

如果您从GitHub克隆，请使用以下代码将包加载到您的项目中

require_once "/path/to/class/Cecula.php";
$cecula = new \Cecula\Cecula("<API_KEY>");

发送A2P短信

要使用字母数字身份向单个或多个联系人发送短信，请使用以下代码

    $messageData = [
        "origin" => "LAB",
        "message" => "It's a good day to be alive. What are you working on?",
        "recipients" => [
            "234809xxxxxxx"
        ]
    ]

    $cecula->sendA2PSMS($messageData);

您的响应应该如下所示

   {
       "status": "sent",
       "reference": "4982953",
       "sentTo": [ "234809xxxxxxx" ],
       "invalid": [],
       "declined": [],
       "declineReason": "",
       "code": "1801"
   }

发送P2P短信

要使用数字身份发送消息，请使用以下代码

   $messageData = [
       "origin" => "2348050209037",
       "message" => "Testing the power of many",
       "recipients" => [
           "2349090000246",
           "2349090000271"
       ]
   ];

   $cecula->sendP2PSMS($messageData);

您的响应应该如下所示

    {
        "status": "sent",
        "code": "1801",
        "messageID": "2579",
        "sentTo":[
            {
                "recipient": "2349090000246",
                "id": "5990"
            },
            {
                "recipient": "2349090000271",
                "id": "5991"
            }
        ],
        "declined": []
    }

检查A2P短信余额

要获取您的A2P短信余额，请使用以下方式调用getA2PBalance方法

    $cecula->getA2PBalance();

您应该得到如下所示的响应

    {
        "balance": 234.1
    }

检查同步云余额

要获取您的同步云余额，请使用以下方式调用getSyncCloudBalance方法：此方法不需要参数

    $request = [
        "identity": "234909xxxxxxx"
    ];
    
    $cecula->getSyncCloudBalance($request);

您应该得到如下所示的响应

    {
        "balance": 9513
    }

错误响应

在由于某种原因请求失败的情况下，您应该从请求的端点收到如下所示的错误响应

        {
            "error": "Invalid PIN Ref",
            "code": "CE2000"
        }

下表显示了错误代码及其描述的列表

cecula / sms

维护者

详细信息