GetCardSmsDetails - 查询单个号码的卡片短信发送记录和发送状态等信息

更新时间:
复制 MD 格式

查询单个号码的卡片短信发送记录和发送状态等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dysms:GetCardSmsDetails

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

CurrentPage

integer

分页查看发送记录,指定发送记录的当前页码。

1

PageSize

integer

分页查看发送记录,指定每页显示的卡片短信记录数量。

取值范围为 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 接口发送卡片短信时,获取返回值中的 BizSmsId 字段。

1234576^0

BizDigitId

string

数字短信发送 ID,调用 SendCardSms 接口或 SendBatchCardSms 接口发送卡片短信时,获取返回值中的 BizDigitalId 字段。

12346^0

返回参数

名称

类型

描述

示例值

object

返回信息。

AccessDeniedDetail

string

访问被拒绝详细信息;只有 RAM 校验失败才会返回此字段。

Message

string

状态码的描述。

OK

CardSendDetailDTO

object

卡片短信发送结果。

TotalCount

integer

总量。

10

PageSize

integer

页数。

10

CurrentPage

integer

页码。

1

Records

array<object>

卡片短信发送记录列表。

object

卡片短信发送记录。

TemplateCode

string

模板 code。

CARD_SMS_6***

RenderDate

string

渲染时间。

2024-09-27 12:13:39

ReceiveDate

string

接收时间。

2024-09-27 11:26:35

RenderStatus

integer

解析状态。取值:

  • 0:未解析;

  • 1:解析成功;

  • 3:未解析。

1

ReceiveType

string

接收短信类型。

CARD_SMS

SendStatus

integer

发送状态。取值:

  • 1:发送中;

  • 2:发送失败;

  • 3:发送成功;

  • 4:寻址失败

3

OutId

string

客户传输 outId。

12345678

PhoneNumber

string

接收短信手机号。

156****9080

SmsContent

string

短信内容。只有文本短信有值。

您收到一条短信消息

SendDate

string

短信发送时间。

2024-09-27 11:26:32

ErrCode

string

发送错误码。

Success

Code

string

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见 API 错误码

OK

Success

boolean

调用接口是否成功。取值:

  • true:调用成功。

  • false:调用失败。

true

示例

正常返回示例

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这三个字段最多传一个

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情