magojr / php-smpp
基于PHP的SMPP客户端库
Requires
- php: >=5.3.3
- ext-mbstring: *
- ext-sockets: *
This package is auto-updated.
Last update: 2024-09-12 06:11:54 UTC
README
这是一个简化版的SMPP客户端库,用于通过SMPP v3.4发送或接收短信。
除了客户端,此库还包含一个将UTF-8文本转换为GSM 03.38编码的编码器,以及一个套接字包装器。套接字包装器在PHP的套接字扩展之上提供了连接池、IPv6和超时监控功能。
与第一个版本相比,此库发生了显著变化,该版本需要命名空间并包含一些工作组件。您可以在1.0.1-namespaced找到该版本。
此库需要sockets PHP扩展,不支持Windows。也提供了兼容Windows的版本。
基本用法示例
要发送短信,你可以这样做
<?php require_once 'smppclient.class.php'; require_once 'gsmencoder.class.php'; require_once 'sockettransport.class.php'; // 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地址。你可以通过设置forceIpv6或forceIpv4来修改此功能,强制它只使用IPv6或IPv4。
除了DNS查找,它还会使用gethostbyname()查找本地IPv4地址,因此"localhost"对IPv4有效。对于IPv6 localhost,指定"::1"。
实现说明
- 你不能以收发器身份连接,尽管SMPP v.3.4支持。
- SMPP的SUBMIT_MULTI操作,它将短信发送给一组接收者,目前不支持。你可以轻松添加它。
- 如果read()超时,套接字将返回false(但不是readAll或write)。你可以使用此功能来实现enquire_link策略。如果你需要每30秒发送一次enquire_link,请将超时设置为30秒,并在readSMS()返回false后发送enquire_link命令。
- 上述示例假设SMSC默认数据编码为GSM 03.38。
- 如果你想获取投递回执,请记住激活已注册的投递(设置为SMPP::REG_DELIVERY_SMSC_BOTH / 0x01)。
- SmppClient和传输组件都支持一个调试回调,默认为error_log。使用此功能重定向调试信息。
常见问题解答
我可以用这个在网站上发送消息吗?
不单独使用。PHP在网站上处理请求后,它会关闭所有连接。大多数SMPP提供商不希望你打开和关闭连接,你应该保持它们活跃,并定期发送enquire_link命令。这意味着你可能需要获取某种长期运行的过程,例如使用进程控制函数,并实现一种可以从中推送的队列系统。这需要服务器级别的shell访问权限以及Unix进程的知识。
我如何接收投递收据或短信?
要接收投递收据或短信,除了发射器外,还必须连接接收器。这个接收器必须等待投递收据到达,这意味着你可能需要使用进程控制函数。
我们有一个开源实现,在php-smpp-worker,你可以从中获得灵感,但我们不能帮助你制作自己的。也许你应该调查一下你的SMSC提供商是否可以提供基于HTTP的API或使用像kannel这样的通用软件,这个项目只提供协议实现和基本的套接字包装器。
我无法发送超过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秒的超时。
为什么我会收到'Failed to read reply to command: 0x4','Message Length is invalid'或'Error in optional part'错误?
最可能的原因是你的SMPP提供商不支持对消息字段进行NULL终止。规范对此问题没有明确说明,因此有一个切换。设置SmppClient::$sms_null_terminate_octetstrings = false;并再次尝试。
'绑定失败'是什么意思?
这通常意味着你的SMPP提供商拒绝了你的登录凭证,即你的用户名或密码。
我可以在没有SMPP服务器的情况下测试客户端库吗?
许多服务提供商可以为您提供演示账户,但您也可以使用logica opensmpp 模拟器(Java)或smsforum 客户端测试工具(Linux 可执行文件)。除了测试多个真实生活中的 SMPP 服务器外,此库还对这些模拟器进行了测试。
这里没有提到我遇到的问题,我该怎么办?
请获取完整的调试信息,并在 GitHub 上创建一个问题。请确保不要包括 BindTransmitter 调用的发送 PDU 十六进制码,因为它将包含您的用户名和密码。其他十六进制输出是好的,并且非常感激。任何 PHP 警告或通知也可能很重要。请包括您正在连接的 SMPP 服务器信息以及任何具体细节。