1. trait
  2. shankesgk2
  3. \
  4. NetEaseIM
  5. \
  6. Traits
  7. \
  8. SmsTrait

SmsTrait

trait SmsTrait (View source)

短信功能

Methods

array
smsSendcode(string $mobile, int $templateid, int $authCode = null, int $codeLen = 4, string $deviceId = null, bool $needUp = false)

发送短信/语音短信验证码

array|bool
smsVerifycode(string $mobile, string $code)

校验指定手机号的验证码是否合法。

array
smsSendtemplate(int $templateid, array $mobiles, array $params = [], bool $needUp = false)

发送模板短信

array
smsQuerystatus(int $sendid)

查询通知类和运营类短信发送状态 根据短信的sendid(sendtemplate.action接口中的返回值)，查询短信发送结果。

Details

at line 34
array smsSendcode(string $mobile, int $templateid, int $authCode = null, int $codeLen = 4, string $deviceId = null, bool $needUp = false)

发送短信/语音短信验证码

Parameters

string $mobile 目标手机号，非中国大陆手机号码需要填写国家代码(如美国：+1-xxxxxxxxxx)或地区代码(如香港：+852-xxxxxxxx)
int $templateid 模板编号(如不指定则使用配置的默认模版)
int $authCode 客户自定义验证码，长度为4～10个数字；如果设置了该参数，则codeLen参数无效
int $codeLen 验证码长度，范围4～10，默认为4
string $deviceId 目标设备号，可选参数
bool $needUp 是否需要支持短信上行。true:需要，false:不需要；说明：如果开通了短信上行抄送功能，该参数需要设置为true，其它情况设置无效

Return Value

array $result 或 ['error'=>true,'message'=>$message]

at line 58
array|bool smsVerifycode(string $mobile, string $code)

校验指定手机号的验证码是否合法。

Parameters

string $mobile 目标手机号，非中国大陆手机号码需要填写国家代码(如美国：+1-xxxxxxxxxx)或地区代码(如香港：+852-xxxxxxxx)
string $code 验证码

Return Value

array|bool true 或 ['error'=>true,'message'=>$message]

at line 79
array smsSendtemplate(int $templateid, array $mobiles, array $params = [], bool $needUp = false)

发送模板短信

Parameters

int $templateid 模板编号(由客户顾问配置之后告知开发者)
array $mobiles 接收者号码列表，JSONArray格式,如["186xxxxxxxx","186xxxxxxxx"]，限制接收者号码个数最多为100个；非中国大陆手机号码需要填写国家代码(如美国：+1-xxxxxxxxxx)或地区代码(如香港：+852-xxxxxxxx)
array $params 短信参数列表，用于依次填充模板，JSONArray格式，每个变量长度不能超过30字，如["xxx","yyy"];对于不包含变量的模板，不填此参数表示模板即短信全文内容
bool $needUp 是否需要支持短信上行。true:需要，false:不需要；说明：如果开通了短信上行抄送功能，该参数需要设置为true，其它情况设置无效

Return Value

array $result 或 ['error'=>true,'message'=>$message]

at line 101
array smsQuerystatus(int $sendid)

查询通知类和运营类短信发送状态 根据短信的sendid(sendtemplate.action接口中的返回值)，查询短信发送结果。

Parameters

int $sendid 发送短信的编号sendid

Return Value

array $result 或 ['error'=>true,'message'=>$message]