README

SMS API 是一个第三方 PHP 短信服务 API 库

目录

• 安装
• Semaphore
  • 发送短信
  • 批量发送短信
  • 发送优先级短信
  • 获取短信
  • 获取您的账户
  • 获取您的交易记录
  • 获取您的发送者名称
  • 获取您的用户

安装

composer require codehub/sms-api

Semaphore

初始化

<?php

require_once('vendor/autoload.php');

use CodeHub\SMS\Semaphore;

$semaphore = new Semaphore('{API_KEY}', '{SENDER_NAME}'); // Optional SENDER_NAME default to Semaphore

发送短信

echo $semaphore->send('09123456789', 'Your message here');

响应

[
  {
    "message_id": 1234567,
    "user_id": 12345,
    "user": "user@example.com",
    "account_id": 54321,
    "account": "Your Account Name",
    "recipient": "09123456789",
    "message": "The message you sent",
    "sender_name": "SEMAPHORE",
    "network": "Globe",
    "status": "Sent",
    "type": "Single",
    "source": "Api",
    "created_at": "0000-00-00 00:00:00",
    "updated_at": "0000-00-00 00:00:00"
  }
]

批量发送短信

您一次最多可以指定 1,000 个接收者/号码。

echo $semaphore->send(['09123456789', '09987654321'], 'Your message here');

发送优先级短信

通常，消息按接收顺序处理，在流量高峰期间，消息可能会延迟。如果您发送的消息时间敏感，您可能希望使用我们的高级优先级队列，该队列绕过默认消息队列并立即发送消息。 该服务每 160 个字符 SMS 收费 2 个积分。

echo $semaphore->priority('09123456789', 'Your message here');

获取短信

您一次可以检索最多 100 条已发送的消息，支持通过传递可选的 $page 变量进行分页

echo $semaphore->messages(['limit' => 100, 'page' => 3]);

按日期范围筛选

echo $semaphore->messages(['startDate' => '0000-00-00', 'endDate' => '0000-00-00']);

按电信网络筛选，例如 "globe"，"smart"

echo $semaphore->messages(['network' => 'globe']);

按状态筛选，例如 "pending"，"success"

echo $semaphore->messages(['status' => 'success']);

获取您的账户

echo $semaphore->account();

响应

{
  "account_id": 12345,
  "account_name": "Your Organization",
  "status": "Active",
  "credit_balance": 1000
}

获取您的交易记录

echo $semaphore->transactions();

获取您的发送者名称

echo $semaphore->sendernames();

响应

[
  {
    "name":"Semaphore",
    "status":"Active",
    "created":"0000-00-00 00:00:00"
  },
  {
    "name":"Example",
    "status":"Active",
    "created":"0000-00-00 00:00:00"
  }
]

获取您的用户

echo $semaphore->users();

响应

[
  {
    "user_id": 12345,
    "email": "owner@example.com",
    "role": "Owner"
  },
  {
    "user_id": 54321,
    "email": "user@example.com",
    "role": "User"
  }
]