README

此SDK提供与MTECH产品的无缝集成

安装

您可以通过composer安装PHP SDK或下载源代码

通过Composer

推荐使用Composer安装SDK。

composer require mtechke/api

使用方法

SDK需要使用您的用户名和API密钥实例化，您可以从MTECH服务门户获取这些信息。

令牌生成

use Mtechke\Api\MtechApi;;

$username = 'YOUR_USERNAME'; 
$apiKey   = 'YOUR_API_KEY'; 
$mtechApi = new MtechApi($username, $apiKey);

$token    = $mtechApi->token();
$result   = $token->getToken();

print_r($result);

发送短信

use Mtechke\Api\MtechApi;;

$username = 'YOUR_USERNAME'; 
$apiKey   = 'YOUR_API_KEY'; 
$mtechApi = new MtechApi($username, $apiKey);

$token    = $mtechApi->sms();

$result   = $token->sendSms([
    "msisdns" => ["254XXXXXXXXX","254XXXXXXXXX"],
    'sender' => "sender id",
    'message_id' => uniqid(),
    'message' => "Message",
    'token' => "XXXX", // token generated on the token generation
    "message_type" => "Promotional",
    "dlr_url" => "https://callbackexample.com"
]);

print_r($result);

短信

• message_id：这是一个唯一的长字母数字，用于标识每个客户端消息。这是将客户端消息的投递状态发送到提供的“dlr_url”的id。

• message：这是要发送到手机用户的消息字符串。请注意：消息字符串长度没有上限。请注意，一条消息为160个字符。如果您发送一个包含161个字符的消息，我们将将其计为两条消息。

• sender：这是用于发送消息的发送者名称。如果您不确定要提供什么，请联系Mtech支持以获得建议。

• message_type：这可以是“事务性”或“促销性”。“事务性”消息比“促销性”消息具有更高的优先级。“事务性”消息包括OTP。

• dlr_url：这是Mtech将用于将每条消息的投递状态转发到客户端系统的GET回调URL。示例请求：https://callbackexample.com?message_id=aa747fhvhh-47748-464&status=DeliveredToTerminal&msisdn=254712723648 注意：Mtech将在我们从网络接收到消息后立即转发每条发送消息的投递报告。

• encrypted：如果“message”参数中提供的字符串已加密，则提供“1”。否则，如果消息是纯文本，则提供“0”。

• encryption_method：这是用于加密“message”参数中提供的字符串的加密方法。例如：id-aes256-GCM

• msisdns：此参数接受一个数组，包含接收消息的电话号码列表。例如：["254726789778","254726789778"]

注意：我们建议您分批发送消息（每个请求中1-500个msisdns）以减小有效负载的大小

注意：在提供msisdns时使用国际国家前缀，例如254712723648

问题

如果您发现错误，请在我们的GitHub问题跟踪器上提交问题。