README

关于 Msegat

沙特阿拉伯领先的短信服务提供商，通过可靠的投递能力最大化您的覆盖范围。

功能

• 向多个收件人发送短信。
• 使用自定义的发件人名称 ID 向多个收件人发送短信。
• 发送一次性密码 (OTP)。
• 计算信息成本点。
• 查询发件人名称 ID。
• 查询余额。

安装

composer require hossammonir/msegat

发布仓库配置

php artisan vendor:publish --provider="HossamMonir\Msegat\MsegatServiceProvider"

这会将 msegat.php 配置发布到 config/msegat.php。

准备环境

将以下配置添加到 .env 文件。

MSEGAT_DEFAULT_SENDER="Type your default sender name"
MSEGAT_USERNAME="Your Msegat Account Username"
MSEGAT_API_KEY="Your API Key"

<您可以从这个 URL 获取您的 API 密钥 MSEGAT，登录成功后。

使用方法

发送短信消息

• 使用默认的发件人名称 ID 向多个收件人发送短信，该 ID 您已在 .env 文件中填写。

    use HossamMonir\Msegat\Facades\Msegat;

    Msegat::numbers(['05xxxxxxxx', '05xxxxxxxx'])
            ->message('Hello World')
            ->sendWithDefaultSender();

• 使用 自定义 发件人名称 ID 向多个收件人发送短信。

    use HossamMonir\Msegat\Facades\Msegat;

    Msegat::numbers(['05xxxxxxxx', '05xxxxxxxx'])
            ->message('Hello World')
            ->sendWithSender('DigitalTunnel');

JSON 响应示例

{
    "response": {
        "code": "1",
        "message": "Success"
    }
}

一次性密码 (OTP)

• 使用默认的发件人名称 ID 发送 OTP 消息。

    use HossamMonir\Msegat\Facades\Msegat;

    Msegat::numbers(['05xxxxxxxx'])
            ->sendOTP();

• 如果您想使用 OTP 发件人名称发送免费的 OTP，您可以在 sendOTP 方法中传递 'OTP'。

    use HossamMonir\Msegat\Facades\Msegat;

    Msegat::numbers(['05xxxxxxxx'])
            ->sendOTP('OTP');

JSON 响应示例

{
    "response": {
        "code": "1",
        "message": "Success"
    },
    "pin": "7693"
}

查询

使用 Msegat 计算信息成本

    use HossamMonir\Msegat\Facades\Msegat;

    Msegat::numbers(['9665xxxxxxxx', '9665xxxxxxxx', '9665xxxxxxxx'])
        ->message('Hello World')
        ->calculateCost();

JSON 响应示例

{
    "total_numbers": 3,
    "point_cost": 2.75,
    "message_length": 23
}

获取所有发件人名称 ID

    use HossamMonir\Msegat\Facades\Msegat;

    Msegat::getSenders();

JSON 响应示例

{
    "response": [
        {
            "SenderID": "Digital",
            "Status": "Refused"
        },
        {
            "SenderID": "DigitalTunnel",
            "Status": "Activated"
        }
    ]
}

获取账户余额

    use HossamMonir\Msegat\Facades\Msegat;

    Msegat::getBalance();

JSON 响应示例

{
    "response": {
        "balance": 964795
    }
}

错误代码

• 1 - 成功
• M0000 - 成功
• M0001 - 变量缺失
• M0002 - 无效的登录信息
• M0022 - 超出发件人允许数量
• M0023 - 发件人名称处于激活状态或正在激活或被拒绝
• M0024 - 发件人名称应为英文或数字
• M0025 - 发件人名称长度无效
• M0026 - 发件人名称已激活或未找到
• M0027 - 激活代码不正确
• 1010 - 变量缺失
• 1020 - 无效的登录信息
• 1050 - 消息体为空
• 1060 - 余额不足
• 1061 - 消息重复
• 1064 - 免费OTP，无效的消息内容您应使用 "Pin Code is: xxxx" 或 "Verification Code: xxxx" 或 "رمز التحقق: 1234"，或升级您的账户并激活您的发件人以发送任何内容
• 1110 - 发件人名称缺失或不正确
• 1120 - 手机号码不正确
• 1140 - 消息长度过长
• M0029 - 无效的发件人名称 - 发件人名称应仅包含字母、数字，且最大长度应为 11 个字符
• M0030 - 发件人名称应以 AD 结尾
• M0031 - 允许上传文件的最大大小为 5 MB
• M0032 - 仅允许 pdf、png、jpg 和 jpeg 文件
• M0033 - 发件人类型应为普通或白名单
• M0034 - 请使用 POST 方法
• M0036 - 没有任何发件人

许可证

Msegat 软件包是开源软件，许可协议为 MIT 许可证。