Api說明

通用

請求域名

https://uni.apistd.com

公共參數(shù)

公共參數(shù)為調(diào)用 API 請求時必須攜帶的參數(shù)，統(tǒng)一使用 URL Query 參數(shù)傳輸。

訪問鑒權(quán)

UniSMS 提供以下兩種鑒權(quán)方式共開發(fā)者選擇，可在控制臺-憑證管理中設(shè)置，默認(rèn)為簡易模式。

• 簡易模式 [默認(rèn)]：此模式僅核驗(yàn) AccessKey ID，不對請求參數(shù)進(jìn)行驗(yàn)簽，方便開發(fā)者快速接入。
• HMAC模式：此模式要求使用 AccessKey Secret 對請求參數(shù)進(jìn)行驗(yàn)簽，以加強(qiáng)保障請求的安全與真實(shí)性。

簡易模式

使用簡易模式完成訪問認(rèn)證，僅需將從控制臺-憑證管理中獲得 AccessKey ID 值傳入 URL Query 參數(shù) accessKeyId 即可完成鑒權(quán)。

HMAC模式

使用 HMAC 模式完成訪問認(rèn)證，需將所有 URL Query 參數(shù)按字典順序排列作為待簽文本串，并根據(jù)指定簽名哈希算法進(jìn)行簽名。

新增所須公共參數(shù) (Query) 如下：

簽名生成步驟

1. 提取請求中所有 URL Query 參數(shù)對，根據(jù)參數(shù) Key 按字典順序排序 (正序)，以=連接 Key-Value，以&連接參數(shù)對組成待簽文本串，示例如下：

accessKeyId=rQJEk4mz6gZzTC9X8XHfpQ1Vt&action=sms.message.send&algorithm=hmac-sha256&nonce=d7041f4746a09b10×tamp=1620269782258

2. 使用 HmacSHA256 算法，以 AccessKey ID 對應(yīng)的 AccessKey Secret 作為簽名秘鑰，對待簽文本串生成簽名，輸出為 Base64 (或 Hex) 字符串，示例如下：

xvv9UjzOrQFWe7fFS5IUU9iqIZrncvF093SqXsnfcK8=

3. 將簽名串作為 signature 的值增加到請求 URL Query 參數(shù)中發(fā)送請求，最終完整的請求 URL 示例如下：

https://uni.apistd.com/?action=sms.message.send&accessKeyId=rQJEk4mz6gZzTC9X8XHfpQ1Vt&algorith

發(fā)送短信

使用該接口發(fā)送文本短信至一個或多個收件人。閱讀本文檔前請先閱讀 API 通用說明。

接口定義

• 接口名：sms.message.send
• HTTP Method：POST
• Content-Type：application/json

請求參數(shù) (Body)

* 注：為幫助開發(fā)者快速遷移，UniSMS支持使用 content 參數(shù)直接傳入文本，新接入用戶建議優(yōu)先使用 templateId 傳參

請求示例

curl -X POST 'https://uni.apistd.com/?action=sms.message.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "1860571xxxx",
  "signature": "合一短信",
  "templateId": "signup",
  "templateData": {"code": "3241", "ttl": "10"}
}'

響應(yīng)參數(shù) (Body)

返回結(jié)果 (data)

發(fā)送消息報告 (data.messages)

響應(yīng)示例

成功響應(yīng)示例

Status Code: 200, Response Body:

{
  "code": "0",
  "message": "Success",
  "data": {
    "recipients": 2,
    "messageCount": 2,
    "totalAmount": "0.187500",
    "payAmount": "0.187500",
    "virtualAmount": "0",
    "messages": [
      {
        "id": "4e88293e50aac21d027a9d6c0f33661e",
        "to": "+8618688061234",
        "regionCode": "CN",
        "countryCode": "86",
        "messageCount": 1,
        "status": "sent",
        "upstream": "emay.standard",
        "price": "0.050000"
      },
      {
        "id": "ce02a6c4195c6f8c4b6a7250ccb3b0a1",
        "to": "+12894260331",
        "regionCode": "CA",
        "countryCode": "1",
        "messageCount": 1,
        "status": "sent",
        "upstream": "emay.intl.standard",
        "price": "0.137500"
      }
    ]
  }
}

失敗響應(yīng)示例

Status Code: 400, Response Body:

{
  "code": "105400",
  "message": "InsufficientFunds"
}

語音驗(yàn)證碼

使用該接口發(fā)送語音驗(yàn)證碼 (撥打電話) 至一個接收人。閱讀本文檔前請先閱讀 API 通用說明。

接口定義

• 接口名：sms.voice.verification.send
• HTTP Method：POST
• Content-Type：application/json

請求參數(shù) (Body)

* 注：暫不支持使用國際手機(jī)號

請求示例

curl -X POST 'https://uni.apistd.com/?action=sms.voice.verification.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "1850987xxxx",
  "code": "5201"
}'

響應(yīng)參數(shù) (Body)

返回結(jié)果 (data)

發(fā)送語音報告 (data.messages)

響應(yīng)示例

成功響應(yīng)示例

Status Code: 200, Response Body:

{
  "data": {
    "recipients": 1,
    "messageCount": 1,
    "totalAmount": "0.050000",
    "payAmount": "0.050000",
    "virtualAmount": "0",
    "messages": [
      {
        "id": "7086bf2f0c2e944b15b08897277d8414",
        "to": "+8618509872103",
        "regionCode": "CN",
        "countryCode": "86",
        "messageCount": 1,
        "status": "sent",
        "upstream": "monyun.standard",
        "price": "0.050000"
      }
    ]
  },
  "code": "0",
  "message": "Success"
}

失敗響應(yīng)示例

Status Code: 400, Response Body:

{
  "code": "101301",
  "message": "未設(shè)置有效的上游服務(wù)商"
}

錯誤碼及描述