\Qiniu\SmsSms

Summary

Methods

Properties

Constants

__construct()
createSignature()
updateSignature()
querySignature()
checkSingleSignature()
deleteSignature()
createTemplate()
queryTemplate()
querySingleTemplate()
updateTemplate()
deleteTemplate()
sendMessage()
querySendSms()
imgToBase64()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

get()
delete()
post()
PUT()

$auth
$baseURL

N/A

File: addons/qiniu/SDK/src/Qiniu/Sms/Sms.php
Package: Application
Class hierarchy: \Qiniu\Sms\Sms
Uses

Properties

$auth

$auth

$baseURL

$baseURL

Methods

__construct()

__construct(\Qiniu\Auth  $auth) : mixed

Parameters

\Qiniu\Auth

$auth

Returns

mixed —

createSignature()

createSignature(string  $signature, string  $source, string  $pics = null) : array

创建签名

Parameters

string	$signature	签名
string	$source	签名来源，申请签名时必须指定签名来源
string	$pics	签名对应的资质证明图片进行 base64 编码格式转换后的字符串，可选

Returns

array —

updateSignature()

updateSignature(string  $id, string  $signature, string  $source, string  $pics = null) : array

编辑签名

Parameters

string	$id	签名 ID
string	$signature	签名
string	$source	签名来源
string	$pics	签名对应的资质证明图片进行 base64 编码格式转换后的字符串，可选

Returns

array —

querySignature()

querySignature(string  $audit_status = null, int  $page = 1, int  $page_size = 20) : array

列出签名

Parameters

string	$audit_status	审核状态："passed"(通过), "rejected"(未通过), "reviewing"(审核中)
int	$page	页码。默认为 1
int	$page_size	分页大小。默认为 20

Returns

array —

checkSingleSignature()

checkSingleSignature(string  $signature_id) : array

查询单个签名

Parameters

string

$signature_id

Returns

array —

deleteSignature()

deleteSignature(string  $signature_id) : array

删除签名

Parameters

string

$signature_id

签名 ID

Returns

array —

createTemplate()

createTemplate(string  $name, string  $template, string  $type, string  $description, string  $signature_id) : array

创建模板

Parameters

string	$name	模板名称
string	$template	模板内容可设置自定义变量，发送短信时候使用，参考:${code}
string	$type	notification：通知类,verification：验证码,marketing：营销类,voice：语音类
string	$description	申请理由简述
string	$signature_id	已经审核通过的签名

Returns

array —

array

queryTemplate()

queryTemplate(string  $audit_status = null, int  $page = 1, int  $page_size = 20) : array

列出模板

Parameters

string	$audit_status	审核状态：passed (通过), rejected (未通过), reviewing (审核中)
int	$page	页码。默认为 1
int	$page_size	分页大小。默认为 20

Returns

array —

querySingleTemplate()

querySingleTemplate(string  $template_id) : array

查询单个模版

Parameters

string

$template_id

模版ID

Returns

array —

updateTemplate()

updateTemplate(string  $id, string  $name, string  $template, string  $description, string  $signature_id) : array

编辑模板

Parameters

string	$id	模板 ID
string	$name	模板名称
string	$template	模板内容
string	$description	申请理由简述
string	$signature_id	已经审核通过的签名 ID

Returns

array —

deleteTemplate()

deleteTemplate(string  $template_id) : array

删除模板

Parameters

string

$template_id

模板 ID

Returns

array —

sendMessage()

sendMessage(string  $template_id, array  $mobiles, array  $parameters = null) : array

发送短信

Parameters

string	$template_id	模板 ID
array	$mobiles	手机号
array	$parameters	自定义模板变量，变量设置在创建模板时，参数template指定

Returns

array —

querySendSms()

querySendSms(string  $job_id = null, string  $message_id = null, string  $mobile = null, string  $status = null, string  $template_id = null, string  $type = null, string  $start = null, int  $end = null, int  $page = 1, int  $page_size = 20) : array

查询发送记录

Parameters

string	$job_id	发送任务返回的 id
string	$message_id	单条短信发送接口返回的 id
string	$mobile	接收短信的手机号码
string	$status	sending: 发送中，success: 发送成功，failed: 发送失败，waiting: 等待发送
string	$template_id	模版 id
string	$type	marketing:营销，notification:通知，verification:验证码，voice:语音
string	$start	开始时间，timestamp，例如: 1563280448
int	$end	结束时间，timestamp，例如: 1563280471
int	$page	页码，默认为 1
int	$page_size	每页返回的数据条数，默认20，最大200

Returns

array —

imgToBase64()

imgToBase64(mixed  $img_file) : mixed

Parameters

mixed

$img_file

Returns

mixed —

get()

get(mixed  $url, mixed  $contentType = 'application/x-www-form-urlencoded') : mixed

Parameters

mixed	$url
mixed	$contentType

Returns

mixed —

delete()

delete(mixed  $url, mixed  $contentType = 'application/json') : mixed

Parameters

mixed	$url
mixed	$contentType

Returns

mixed —

post()

post(mixed  $url, mixed  $body, mixed  $contentType = 'application/json') : mixed

Parameters

mixed	$url
mixed	$body
mixed	$contentType

Returns

mixed —

PUT()

PUT(mixed  $url, mixed  $body, mixed  $contentType = 'application/json') : mixed

Parameters

mixed	$url
mixed	$body
mixed	$contentType

Returns

mixed —