全部产品
Search
文档中心

短信服务:QueryMessage - 查询短信发送记录

更新时间:Mar 01, 2024

使用短信MessageId查询短信发送记录。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 300 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dysms:QueryMessageRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
MessageIdstring

消息 ID。

1008030xxx3003

返回参数

名称类型描述示例值
object

接口返回参数。

Statusstring

短信的发送状态。

  • 1:成功(Delivered)
  • 2:失败(Delivery Failed)
  • 3:发送中(Delivering)
1
ErrorDescriptionstring

短信发送状态码的描述。

success
ResponseCodestring

短信提交状态。

OK
ReceiveDatestring

发送短信收到运营商回执的时间。

Mon, 24 Dec 2018 16:58:22 +0800
NumberDetailobject

号码明细。

Carrierstring

号码所属的运营商网络。

CMI
Regionstring

号码所属地区。

HongKong
Countrystring

号码所属国家。

China
Messagestring

短信内容。

Hello!
ResponseDescriptionstring

短信提交状态的详细描述。

The SMS Send Request was accepted
ErrorCodestring

短信发送状态码。

DELIVERED
SendDatestring

短信转发给运营商的时间。

Mon, 24 Dec 2018 16:58:22 +0800
Tostring

接收方号码。

6581xxx810
MessageIdstring

消息 ID。

1008030xxx3003
RequestIdstring

请求 ID。

F655A8D5-B967-440B-8683-DAD6FF8D28D0

示例

正常返回示例

JSON格式

{
  "Status": "1",
  "ErrorDescription": "success",
  "ResponseCode": "OK",
  "ReceiveDate": "Mon, 24 Dec 2018 16:58:22 +0800",
  "NumberDetail": {
    "Carrier": "CMI",
    "Region": "HongKong",
    "Country": "China"
  },
  "Message": "Hello!",
  "ResponseDescription": "The SMS Send Request was accepted",
  "ErrorCode": "DELIVERED",
  "SendDate": "Mon, 24 Dec 2018 16:58:22 +0800",
  "To": "6581xxx810",
  "MessageId": "1008030xxx3003",
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8D28D0"
}

错误码

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