qranio-com/php-smpp

PHP SMPP客户端库

v1.0 2014-05-16 13:28 UTC

This package is not auto-updated.

Last update: 2024-09-28 16:45:36 UTC


README

这是一个简化版的SMPP客户端库,用于通过SMPP v3.4发送或接收短信。

除了客户端,此库还包含一个编码器,用于将UTF-8文本转换为GSM 03.38编码,以及一个套接字包装器。套接字包装器在PHP的套接字扩展之上提供了连接池、IPv6和超时监控功能。

此库需要套接字 PHP扩展,不支持Windows。还有一个Windows兼容版本

安装

php composer.phar require its/php-smpp:dev-master

基本用法示例

要发送短信,您可以这样做

<?php
require_once 'vendor/autoload.php';

use OnlineCity\Transport\SocketTransport;
use OnlineCity\SMPP\SMPP;
use OnlineCity\SMPP\SmppClient;
use OnlineCity\SMPP\SmppAddress;
use OnlineCity\Encoder\GsmEncoder; 

// Construct transport and client
$transport = new SocketTransport(array('smpp.provider.com'),2775);
$transport->setRecvTimeout(10000);
$smpp = new SmppClient($transport);

// Activate binary hex-output of server interaction
$smpp->debug = true;
$transport->debug = true;

// Open the connection
$transport->open();
$smpp->bindTransmitter("USERNAME","PASSWORD");

// Optional connection specific overrides
//SmppClient::$sms_null_terminate_octetstrings = false;
//SmppClient::$csms_method = SmppClient::CSMS_PAYLOAD;
//SmppClient::$sms_registered_delivery_flag = SMPP::REG_DELIVERY_SMSC_BOTH;

// Prepare message
$message = 'H€llo world';
$encodedMessage = GsmEncoder::utf8_to_gsm0338($message);
$from = new SmppAddress('SMPP Test',SMPP::TON_ALPHANUMERIC);
$to = new SmppAddress(4512345678,SMPP::TON_INTERNATIONAL,SMPP::NPI_E164);

// Send
$smpp->sendSMS($from,$to,$encodedMessage,$tags);

// Close connection
$smpp->close();

要接收短信(或投递回执)

<?php
require_once 'smppclient.class.php';
require_once 'sockettransport.class.php';

// Construct transport and client
$transport = new SocketTransport(array('smpp.provider.com'),3600);
$transport->setRecvTimeout(60000); // for this example wait up to 60 seconds for data
$smpp = new SmppClient($transport);

// Activate binary hex-output of server interaction
$smpp->debug = true;
$transport->debug = true;

// Open the connection
$transport->open();
$smpp->bindReceiver("USERNAME","PASSWORD");

// Read SMS and output
$sms = $smpp->readSMS();
echo "SMS:\n";
var_dump($sms);

// Close connection
$smpp->close();

连接池

您可以指定一个连接列表,让SocketTransport按顺序或随机尝试每个连接。如果您提供了一个具有多个A/AAAA记录的主机名,它将尝试每个记录。如果您想监控DNS查找,请在构建传输之前将defaultDebug设置为true。

(可配置)发送超时控制它将等待每个服务器超时的时间。尝试长列表的服务器可能需要很长时间,这取决于超时时间。您可以在连接尝试之前和之后更改超时。

传输支持IPv6,并且当可用时将优先考虑IPv6地址而不是IPv4。您可以通过设置forceIpv6或forceIpv4来修改此功能,强制它只使用IPv6或IPv4。

除了DNS查找外,它还会使用gethostbyname()查找本地IPv4地址,因此“localhost”适用于IPv4。对于IPv6 localhost,指定"::1”。

实现说明

  • 您不能以收发器身份连接,尽管SMPP v.3.4支持这一点。
  • SMPP的SUBMIT_MULTI操作(向多个接收者发送短信)目前不支持。您可以轻松添加它。
  • 套接字在read()(但不是readAll或write)超时时将返回false。您可以使用此功能来实现enquire_link策略。如果您需要每30秒发送一次enquire_link,请设置超时为30秒,并在readSMS()返回false后发送enquire_link命令。
  • 上述示例假设SMSC默认数据编码为GSM 03.38
  • 如果您想获得投递回执,请记住激活已注册的投递(设置为SMPP::REG_DELIVERY_SMSC_BOTH / 0x01)。
  • SmppClient和传输组件都支持一个调试回调,默认为error_log。使用此功能重定向调试信息。

常见问题解答(F.A.Q.)

我发送的短信不能超过160个字符
有三种内置方法发送连接短信(csms);CSMS_16BIT_TAGS,CSMS_PAYLOAD,CSMS_8BIT_UDH。CSMS_16BIT_TAGS是默认的,如果它不起作用,请尝试另一种。

此库与PHP 5.2.x兼容吗?
它在PHP 5.3上进行了测试,但已知与5.2也兼容。

它可以在Windows上运行吗?
需要套接字扩展,这个扩展在Windows上可用,但功能不完整。请使用Windows兼容版,该版本使用fsockopen和流函数。

为什么我没有看到任何调试输出?
请记得为SocketTransport和SmppClient实现一个调试回调以使用。否则,它们默认使用error_log,它可能会或可能不会打印到屏幕。

为什么我收到'res_nsend()失败'或'无法连接到指定的任何主机'的错误?
您的提供商的DNS服务器可能存在IPv6地址(AAAA记录)的问题。尝试设置SocketTransport::$forceIpv4=true;。您也可以尝试指定一个IP地址(或一个IP地址列表)。在构造传输之前设置SocketTransport:$defaultDebug=true;也有助于解决连接问题。

我已经尝试强制使用IPv4和/或指定一个IP地址,但我仍然收到'无法连接到指定的任何主机'的错误?
这可能是防火墙问题阻止了您的连接,或者完全是其他问题。确保已启用并显示调试输出。如果您看到类似'Socket连接到1.2.3.4:2775失败;操作超时'的信息,这意味着无法建立连接。如果不是防火墙问题,您可以尝试增加连接超时。sendTimeout也指定了连接超时,调用$transport->setSendTimeout(10000);设置10秒超时。

为什么我收到'无法读取命令回复: 0x4','消息长度无效'或'可选部分错误'的错误?
很可能您的SMPP提供商不支持消息字段的NULL终止。对此问题的规范不明确,因此有一个开关。设置SmppClient::$sms_null_terminate_octetstrings = false;并再次尝试。

'绑定失败'是什么意思?
这通常意味着您的SMPP提供商拒绝了您的登录凭据,即您的用户名或密码。

我可以在没有SMPP服务器的情况下测试客户端库吗?
许多服务提供商可以为您提供演示账户,但您也可以使用logica opensmpp模拟器(java)或smsforum客户端测试工具(Linux可执行文件)。除了测试了多个真实的SMPP服务器之外,这个库还测试了这些模拟器。

这里没有提到的问题,我该怎么办?
请获取完整的调试信息,并在GitHub上创建一个问题。请确保不要包含绑定发送器的Send PDU十六进制代码,因为它将包含您的用户名和密码。其他十六进制输出是可接受的,并且非常受赞赏。任何PHP警告或通知也可能很重要。请包括您连接到的SMPP服务器信息以及任何具体细节。