SMS Service

Use APIs exposed by Guodu to implement SMS-related service, which includes sending SMS, checking quota/surplus, etc., _(*1)

This service provides only the most basic features, and designated to be integrated into other project as infrastructure., _(*2)

use Homer\Sms\Guodu\Service as GuoduSmsService;

$service = new GuoduSmsService('account', 'password');
// - or the full version
// $service = new GuoduSmsService('account', 'password', $optionsOfService, $instanceOfClient);

// send message
$service->send('message', $subscriber, $optionsOfMessage);
// query quota
$quota = $service->queryQuota();

API

construct

__construct($account, $password, array $options = [], $httpClient = null), _(*3)

$account guodu's account used to send message
$password password that goes with account, should be MD5'd
$options options for creating a GuoduSmsService. Including:
- name name of merchant(e.g., 【XXX】), can be either prepend or append to the message.
- affix 附加号码 a part of sender's number that will be used to
- send_url url for sending message (typically, you will not change it at all, since there is no other environment prepared by guodu currently)
- quota_url url for querying quota (typically, you will not change it at all, since there is no other environment prepared by guodu currently)
$httpClient GuzzleHttp client instance

send message

send($message, $subscriber, array $options = []), _(*4)

$message message to deliver
$subscriber subscriber or a list of subscribers
$options options for sending a message. Including:
- send_time when will this message be delivered. If not set, the message will be delivered right away. It's in YYYYMMDDHHIISS format.
- msg_type message type. Should one either 8 (for 普通短信, which is default) or 15 (for 长短信)
- name_pos name position in the message, should be one of 0(for hiding name), 1(for appending, which is default) and 2 (for prepending to the message)
- expires_at message can be temporarily stored on message server, and we're allowed to give it an expiry time. It's in YYYYMMDDHHIISS format.
- round_trip when turned on, the response from guodu will be parsed and returned. default false.