一、 API接口介绍
alibaba.aliqin.fc.sms.num.send (短信发送)
向指定手机号码发送模板短信,模板内可设置部分变量。使用前需要在阿里大于管理中心添加短信签名与短信模板。测试时请直接使用正式环境HTTP请求地址。 【重要】批量发送(一次传递多个号码eg:1381111111,1382222222)会产生相应的延迟,触达时间要求高的建议单条发送
公共参数
请求地址:
环境 | HTTP请求地址 | HTTPS请求地址 |
---|---|---|
正式环境 | http://gw.api.taobao.com/router/rest | https://eco.taobao.com/router/rest |
沙箱环境 | http://gw.api.tbsandbox.com/router/rest | https://gw.api.tbsandbox.com/router/rest |
公共请求参数:
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
method | String | 是 | API接口名称。 |
app_key | String | 是 | TOP分配给应用的AppKey。 |
target_app_key | String | 否 | 被调用的目标AppKey,仅当被调用的API为第三方ISV提供时有效。 |
sign_method | String | 是 | 签名的摘要算法,可选值为:hmac,md5。 |
sign | String | 是 | API输入参数签名结果,签名算法介绍请点击这里。 |
session | String | 否 | 用户登录授权成功后,TOP颁发给应用的授权信息,详细介绍请点击这里。当此API的标签上注明:“需要授权”,则此参数必传;“不需要授权”,则此参数不需要传;“可选授权”,则此参数为可选。 |
timestamp | String | 是 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8,例如:2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。 |
format | String | 否 | 响应格式。默认为xml格式,可选值:xml,json。 |
v | String | 是 | API协议版本,可选值:2.0。 |
partner_id | String | 否 | 合作伙伴身份标识。 |
simplify | Boolean | 否 | 是否采用精简JSON返回格式,仅当format=json时有效,默认值为:false。 |
请求参数
名称 | 类型 | 是否必须 | 示例值 | 更多限制 | 描述 |
---|---|---|---|---|---|
extend | String | 可选 | 123456 | 公共回传参数,在“消息返回”中会透传回该参数;举例:用户可以传入自己下级的会员ID,在消息返回时,该会员ID会包含在内,用户可以根据该会员ID识别是哪位会员使用了你的应用 | |
sms_type | String | 必须 | normal | 短信类型,传入值请填写normal | |
sms_free_sign_name | String | 必须 | 阿里大于 | 短信签名,传入的短信签名必须是在阿里大于“管理中心-验证码/短信通知/推广短信-配置短信签名”中的可用签名。如“阿里大于”已在短信签名管理中通过审核,则可传入”阿里大于“(传参时去掉引号)作为短信签名。短信效果示例:【阿里大于】欢迎使用阿里大于服务。 | |
sms_param | Json | 可选 | {"code":"1234","product":"alidayu"} | 短信模板变量,传参规则{"key":"value"},key的名字须和申请模板中的变量名一致,多个变量之间以逗号隔开。示例:针对模板“验证码${code},您正在进行${product}身份验证,打死不要告诉别人哦!”,传参时需传入{"code":"1234","product":"alidayu"} | |
rec_num | String | 必须 | 13000000000 | 短信接收号码。支持单个或多个手机号码,传入号码为11位手机号码,不能加0或+86。群发短信需传入多个号码,以英文逗号分隔,一次调用最多传入200个号码。示例:18600000000,13911111111,13322222222 | |
sms_template_code | String | 必须 | SMS_585014 | 短信模板ID,传入的模板必须是在阿里大于“管理中心-短信模板管理”中的可用模板。示例:SMS_585014 |
响应参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | BizResult | 0 | 返回值 |
|
二、SDK实现
三、调用方法
header(‘Content-Type: text/html; charset=UTF-8‘); $sms = new Alidayu; $sms->appkey = "24535123"; $sms->secretKey = ‘1d7ed250f68e3c096f9b18a434765456‘; $code = strval(rand(100000,999999)); $requestMethod = "alibaba.aliqin.fc.sms.num.send"; $apiParams = array(); $apiParams["extend"] = "123456"; $apiParams["sms_type"] = "normal"; $apiParams["sms_free_sign_name"] = "方倍工作室"; $apiParams["sms_param"] = json_encode(array("code"=>$code)); $apiParams["rec_num"] = "15889386666"; $apiParams["sms_template_code"] = "SMS_75835210"; $resp = $sms->execute($requestMethod, $apiParams); var_dump($resp);
四、代码下载
扫描关注下文二维码,回复 “1245” 获取
时间: 2024-10-12 13:55:20