查詢單個號碼的卡片短信發送記錄和發送狀態等信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dysms:GetCardSmsDetails | none | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CurrentPage | long | 否 | 分頁查看發送記錄,指定發送記錄的的當前頁碼。 | 1 |
PageSize | long | 否 | 分頁查看發送記錄,指定每頁顯示的卡片短信記錄數量。 取值范圍為 1~50。 | 10 |
SendDate | string | 是 | 卡片短信發送日期,支持查詢最近 30 天的記錄。 格式為 yyyyMMdd,例如 20240112。 | 20240112 |
PhoneNumber | string | 是 | 接收短信的國內手機號碼。格式:11 位手機號碼,例如 1390000****。 | 1390000**** |
BizCardId | string | 否 | 卡片短信發送 ID。通過 SendCardSms 接口或 SendBatchCardSms 接口發送卡片短信時,獲取返回值中的 BizCardId 字段。 | 123456^0 |
BizSmsId | string | 否 | 文本短信發送 ID,調用 SendCardSms 接口或 SendBatchCardSms 接口發送卡片短信時,獲取返回值中的 BizCardId 字段。 | 1234576^0 |
BizDigitId | string | 否 | 數字短信發送 ID,調用 SendCardSms 接口或 SendBatchCardSms 接口發送卡片短信時,獲取返回值中的 BizDigitalId 字段。 | 12346^0 |
返回參數
示例
正常返回示例
JSON
格式
{
"AccessDeniedDetail": "無",
"Message": "OK\n",
"CardSendDetailDTO": {
"TotalCount": 10,
"PageSize": 10,
"CurrentPage": 1,
"Records": [
{
"TemplateCode": "CARD_SMS_6***",
"RenderDate": "2024-09-27 12:13:39",
"ReceiveDate": "2024-09-27 11:26:35",
"RenderStatus": 1,
"ReceiveType": "CARD_SMS",
"SendStatus": 3,
"OutId": "12345678",
"PhoneNumber": "156****9080",
"SmsContent": "您收到一條短信消息",
"SendDate": "2024-09-27 11:26:32",
"ErrCode": "Success"
}
]
},
"Code": "OK\n",
"Success": true
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParam.PhoneNumber | Incorrect phone number format. | 手機號格式不正確 |
400 | InvalidParam.PageSize | PageSize must be less than or equal to 50. | pageSize必須小于等于50 |
400 | InvalidParam.SendDate | Only the last 30 days can be queried. | 只能查詢最近30天數據 |
400 | InvalidParameter | At most, only one parameter can be passed among bizCardId, bizSmsId, and bizDigitId. | bizCardId, bizSmsId, bizDigitId這三個字段最多傳一個 |
訪問錯誤中心查看更多錯誤碼。