中國(guó)站
幫助中心 > 通信 > API文檔 > 拉取短信狀態(tài)接口 > 拉取短信狀態(tài)

拉取短信狀態(tài)

描述

獲取用戶發(fā)送的短信狀態(tài)信息。

接口地址

  1. /sms/querySendStatus

HTTP METHOD

POST

HTTP BODY編碼格式

application/x-www-form-urlencoded

請(qǐng)求參數(shù)

以下請(qǐng)求參數(shù)列表僅列出了接口請(qǐng)求參數(shù)和部分公共參數(shù)，完整公共參數(shù)列表見 公共請(qǐng)求參數(shù)。

名稱 類型 是否必填 說明
phone string 否 手機(jī)號(hào)碼
startDate string 否 開始日期, 格式為yyyy-MM-dd
endDate string 否 結(jié)束日期, 格式為yyyy-MM-dd
pageIndex string 否 查詢起始位置, 默認(rèn)為 1
pageSize string 否 查詢個(gè)數(shù), 取值區(qū)間 [0-100], 默認(rèn)為 100

返回結(jié)果

名稱 類型 說明
code int 錯(cuò)誤碼
RequestId string 唯一請(qǐng)求 ID，每次請(qǐng)求都會(huì)返回。
message string 結(jié)果描述
data Array 短信發(fā)送結(jié)果數(shù)據(jù)

data字段詳情

名稱 類型 說明
serialno string 短信發(fā)送記錄唯一標(biāo)識(shí)
phone string 手機(jī)號(hào)碼
content string 短信內(nèi)容
description string 短信發(fā)送結(jié)果描述
sendstatus string 發(fā)送狀態(tài)
requesttime string 發(fā)送時(shí)間

請(qǐng)求示例

  1.     curl -X POST \
  2.     "https://api.yisu.com/sms/querySendStatus" \
  3.     -H "content-type: application/x-www-form-urlencoded" \
  4.     -d "accessId=abcdefghijklmnop&endDate=2019-12-23&nonce=27212&pageIndex=1&phone=15766050514&startDate=2019-12-23×tamp=1577955495&signature=H9kgkwceTJJ1CXYYnXj01Hhx2iM%3D"

返回示例

  1. {
  2.   "code": 0,
  3.   "message": "成功",
  4.   "data": [
  5.     {
  6.       "serialno": "157776004286312634551380000000074804",
  7.       "phone": "13800000000",
  8.       "content": "【***】您的驗(yàn)證碼為111111，請(qǐng)?jiān)?0分鐘內(nèi)輸入!",
  9.       "sendstatus": "發(fā)送成功",
  10.       "description": "請(qǐng)求成功",
  11.       "requesttime": "2019-12-31 10:40:42"
  12.     },
  13.     {
  14.       "serialno": "157775763495912634551380000000045589",
  15.       "phone": "13800000000",
  16.       "content": "【***】您的驗(yàn)證碼為111111，請(qǐng)?jiān)?0分鐘內(nèi)輸入!",
  17.       "sendstatus": "發(fā)送成功",
  18.       "description": "請(qǐng)求成功",
  19.       "requesttime": "2019-12-31 10:00:34"
  20.     }
  21.   ],
  22.   "requestId": "c1c9dc4fe90cabafc0eea8b792d79349"
  23. }