文档首页 > > API参考> API> 短信操作> 查询短信的发送状态

查询短信的发送状态

分享
更新时间: 2019/09/12 GMT+08:00

功能介绍

  • 接口名称

    ListSmsMsgReport

  • 功能描述

    查询短信的发送状态。

URI

  • URI格式

    GET /v2/{project_id}/notifications/sms/report?status={status}&message_id={message_id}&mobile={mobile}&sign_id={sign_id}&start_time={start_time}&end_time={end_time}&offset={offset}&limit={limit}

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

    获取项目ID请参考获取项目ID

    start_time

    String

    短信发送状态报告查询的起始时间。格式为时间戳毫秒数,如1504146012000。

    end_time

    String

    短信发送状态报告查询的结束时间。格式为时间戳毫秒数,如1504146012000。

    sign_id

    String

    签名ID

    短信签名ID在创建短信签名时由系统自动生成,是短信签名的唯一标识。请在SMN控制台左侧导航栏单击“短信”,在页面的短信签名列表中获取签名ID,可通过查询短信签名获取。

    message_id

    String

    已发送短信的消息ID,您可通过发送短信的接口获取该ID。

    mobile

    String

    手机号码。

    status

    int

    短信发送状态。

    • 0 已发送无状态。
    • 1 发送成功。
    • 2 发送失败。

    offset

    int

    短信发送状态查询的偏移位置,必须大于等于0。

    limit

    int

    查询的短信状态数量限制,最大值为100,默认值为100。

请求消息

请求样例

GET https://{SMN_Endpoint}/v2/{project_id}/notifications/sms/report?status=1&message_id=ce7f2f7343224f8c9597b05a9a0bcc2e&mobile=134****6789&sign_id=*******&start_time=1504146012000&end_time=1504146012000&offset=0&limit=100

响应消息

  • 要素说明

    名称

    参数类型

    说明

    request_id

    String

    请求的唯一标识ID。

    count

    int

    短信发送列表的元素个数。

    data

    Sms_report_data结构体数组

    查询结果的列表。结构体说明请参见表1

    表1 Sms_report_data结构体

    名称

    参数类型

    说明

    约束

    message_id

    String

    唯一的消息ID。

    -

    status

    int

    短信的发送状态。

    0 :短信已发送,等待短信接收状态

    1 :短信发送成功

    2 :短信发送失败

    sign_id

    String

    短信签名ID。

    -

    status_desc

    String

    发送状态描述,包含错误码。

    当前仅只支持特定的状态,请参见Cmpp发送状态描述表

    fee_num

    int

    短信计费条数。

    计算短信字数时,包含短信签名。当短信字数不超过70时,按照70字/条计费。当短信字数超过70时,即为长短信,按照67字/条计算。

    例如,系统发送一条包含490个字符的短信,则计算为490/67=7.31,即8条。

    extend_code

    String

    扩展码。

    -

    nation_code

    String

    国家码。

    -

    mobile

    String

    接收短信的移动电话号码。

    -

    submit_time

    String

    短信提交时间。

    -

    deliver_time

    String

    短信送达时间。

    -

  • 响应样例
    {
       "data":[{
               "message_id": "ce7f2f7343224f8c9597b05a9a0bcc2e",
               "status":0,
               "sign_id": "ce7f2f7343224f8c9597b05a9a0bcc2e",
               "status_desc":null,
               "fee_num": 2,
               "extend_code": null,
               "nation_code": "86",
               "mobile": "134****6789",
               "submit_time": "2016-08-02T08:10:01Z",
               "deliver_time": "2016-08-02T08:10:02Z"         
            },
            {
               "message_id": "b23f2f7343224f8c9597b05a9a0bcc56",
               "status":1,
               "sign_id": "ce7f2f7343224f8c9597b05a9a0bcc2e",
               "status_desc":"DELIVRD",
               "fee_num": 2,
               "extend_code": null,
               "nation_code":"86",
               "mobile": "134****6789",
               "submit_time": "2016-08-02T08:10:01Z",
               "deliver_time": "2016-08-02T08:10:02Z"
            },
            {
               "message_id": "589f2f7343224f8c9597b05a9a0bcsde",
               "status":2,
               "sign_id": "ce7f2f7343224f8c9597b05a9a0bcc2e",
               "status_desc":"REJECTD",
               "fee_num": 2,
               "extend_code": null,
               "nation_code": "86",
               "mobile": "134****6789",
               "submit_time": "2016-08-02T08:10:01Z",
               "deliver_time": "2016-08-02T08:10:02Z"
             }],
       "request_id":"ce7f2f7343224f8c9597b05a9a0bcc2e",
       "count":3
    }

返回值

请参考返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区