Laravel6 使用腾讯云短信-短信签名状态查询
Laravel6 使用腾讯云短信
短信签名状态查询
SmsSignRequestModel.php
增加describeSmsSigns
方法
/* app/Http/Requests/Api/SmsSignRequest.php */
<?php
namespace App\Http\Models\TencentCloud;
use TencentCloud\Sms\V20190711\Models\AddSmsSignRequest;
use TencentCloud\Sms\V20190711\Models\ModifySmsSignRequest;
use TencentCloud\Sms\V20190711\Models\DeleteSmsSignRequest;
use TencentCloud\Sms\V20190711\Models\DescribeSmsSignListRequest;
class SmsSignRequest
{
·
·
·
/**
* 短信签名状态查询 DescribeSmsSignList
*
* @param Array $signIds 签名 ID 数组。
* @param integer $international 是否国际/港澳台短信:
* 0:表示国内短信。
* 1:表示国际/港澳台短信。
* @return void
*/
public function describeSmsSigns(Array $signIds, int $international = 0)
{
// 实例化一个 sms 修改签名请求对象,每个接口都会对应一个request对象。
$req = new DescribeSmsSignListRequest();
$req->SignIdSet = $signIds;
$req->International = $international;
return $req;
}
}
短信签名验证类增加短信签名状态查询的验证规则
/* app/Http/Requests/Api/SmsSignRequest.php */
<?php
namespace App\Http\Requests\Api;
use Illuminate\Http\Request;
class SmsSignRequest extends FormRequest
{
·
·
·
protected $describeSignsRules = [
'signIds' => 'required|array',
'international' => 'required|integer'
];
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules(Request $request)
{
switch ($request->method) {
case 'GET':
$rules = $this->describeSignsRules;
break;
case 'POST':
$rules = $this->addSignRules;
break;
case 'PUT':
$rules = $this->modifySignRules;
break;
case 'DELETE':
$rules = $this->deleteSignRules;
break;
default:
$rules = $this->addSignRules;
break;
}
return $rules;
}
}
SmsSignController.php
增加签名状态查询方法
/* app/Http/Controllers/Api/SmsSignController.php */
<?php
namespace App\Http\Controllers\Api;
use App\Http\Requests\Api\SmsSignRequest;
use App\Http\Models\TencentCloud\SmsSignRequest as SmsSignRequestModel;
use TencentCloud\Common\Exception\TencentCloudSDKException;
class SmsSignController extends Controller
{
·
·
·
public function describeSigns(SmsSignRequest $request,SmsSignRequestModel $describeSmsSignsRequestModel)
{
try {
$sms = app('tencentcloudSms');
$req = $describeSmsSignsRequestModel->describeSmsSigns($request->signIds, $request->international);
// 通过client对象调用DescribeInstances方法发起请求。注意请求方法名与请求对象是对应的
// 返回的resp是一个DescribeInstancesResponse类的实例,与请求对象对应
$resp = $sms->DescribeSmsSignList($req);
list($DescribeSignListStatusSet, $RequestId) = array_values(json_decode($resp->toJsonString(), true));
if (count($DescribeSignListStatusSet) >= 1) {
return response()->json([
'key' => $RequestId,
'code' => 0,
'message' => 'Ok',
'signs' => $DescribeSignListStatusSet
]);
}
} catch (TencentCloudSDKException $e) {
return response()->json([
'key' => $e->getRequestId(),
'code' => $e->getErrorCode(),
'message' => $e->getMessage()
])->setStatusCode(500);
}
}
}
新增路由
/* routes/api.php */
<?php
use Illuminate\Http\Request;
/*
|--------------------------------------------------------------------------
| API Routes
|--------------------------------------------------------------------------
|
| Here is where you can register API routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| is assigned the "api" middleware group. Enjoy building your API!
|
*/
Route::prefix('v1')->namespace('Api')->name('api.v1.')->group(function () {
// 发送短信
Route::post('sendsms', 'SmsController@send')
->name('sms.send');
// 添加短信签名
Route::post('smsSign', 'SmsSignController@addSign')
->name('sms.sign.add');
// 修改短信签名
Route::put('smsSign', 'SmsSignController@modifySign')
->name('sms.sign.modify');
// 删除短信签名
Route::delete('smsSign', 'SmsSignController@deleteSign')
->name('sms.sign.delete');
// 短信签名状态查询
Route::get('smsSign', 'SmsSignController@describeSigns')
->name('sms.sign.describe');
});
测试
通过 PostMan 测试一下:
本作品采用《CC 协议》,转载必须注明作者和本文链接