雲尚API

簡訊驗證碼發送

呼叫阿里雲簡訊介面發送驗證碼,支援自訂驗證碼,也可以不傳由平台自動產生 6 位隨機碼。套餐制,每次呼叫扣減 1 次。

介面資訊

項目說明
介面位址POST /api/v3/dxyzm
計費方式套餐制

請求參數

參數類型必填說明
phonestring接收手機號(11 位)
codestring自訂 6 位驗證碼,不傳則由平台產生

請求範例

PHP

<?php
$app_id = 'YOUR_APP_ID';
$app_key = 'YOUR_APP_KEY';
$url = 'https://yunsapi.com/api/v3/dxyzm';
$params = ['phone' => '13800138000'];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'X-APP-ID: ' . $app_id,
    'X-APP-KEY: ' . $app_key,
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

$resp = curl_exec($ch);
curl_close($ch);

echo $resp;

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SmsDemo {
    public static void main(String[] args) throws Exception {
        String appId = "YOUR_APP_ID";
        String appKey = "YOUR_APP_KEY";
        String url = "https://yunsapi.com/api/v3/dxyzm";
        String body = "{\"phone\":\"13800138000\"}";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest req = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Content-Type", "application/json")
                .header("X-APP-ID", appId)
                .header("X-APP-KEY", appKey)
                .POST(HttpRequest.BodyPublishers.ofString(body))
                .build();

        HttpResponse<String> resp = client.send(req, HttpResponse.BodyHandlers.ofString());
        System.out.println(resp.body());
    }
}

回應範例

{
    "code": 0,
    "msg": "傳送成功",
    "data": {
        "phone": "13800138000",
        "code": "123456",
        "generated": false,
        "remain": 9
    },
    "request_id": "req_xxx"
}

回應參數

參數類型說明
data.phonestring接收手機號
data.codestring本次發送的驗證碼,用於與您本地產生的驗證碼比對
data.generatedbooleantrue 表示平台自動產生,false 表示使用了自訂驗證碼
data.remaininteger套餐剩餘次數