获取短信发送状态 - GetUSMSSendReceipt

简介

调用接口GetUSMSSendReceipt短信发送状态信息

💡 短信提交发送后，可调用接口GetUSMSSendReceipt查询及获取短信发送的状态信息；若发送后未立即拿到回执状态，建议在发送后5至10分钟内在尝试代用获取，若超过12小时仍未拿到发送状态，可联系UCloud技术支持协助

定义

公共参数

参数名	类型	描述信息	必填
Action	string	对应的 API 指令名称，当前 API 为 `GetUSMSSendReceipt`	Yes
PublicKey	string	用户公钥，可从控制台获取	Yes
Signature	string	根据公钥及 API 指令生成的用户签名，参见签名算法	Yes

请求参数

参数名	类型	描述信息	必填
Region	string	地域。参见地域和可用区列表	No
Zone	string	可用区。参见可用区列表	No
ProjectId	string	项目ID。不填写为默认项目，子帐号必须填写。请参考GetProjectList接口	No
SessionNoSet.N	string	发送短信时返回的SessionNo集合，SessionNoSet.0,SessionNoSet.1…格式，单次调用集合数需控制在100个以内	Yes

响应字段

字段名	类型	描述信息	必填
RetCode	int	返回状态码，为 0 则为成功返回，非 0 为失败	Yes
Action	string	操作指令名称	Yes
Message	string	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息	No
Data	array[ReceiptPerSession]	回执信息集合	Yes

数据模型

ReceiptPerSession

字段名	类型	描述信息	必填
SessionNo	string	发送短信时返回的SessionNo	Yes
ReceiptSet	array[ReceiptPerPhone]	每个手机号的短信回执信息集合	Yes

ReceiptPerPhone

字段名	类型	描述信息	必填
Phone	string	手机号码	Yes
CostCount	int	消耗短信条数	Yes
ReceiptResult	string	回执结果，枚举值： > 发送成功: 代表成功 > Success: 代表成功 > 发送失败: 代表失败 > Fail: 代表失败 > 状态未知: 代表未知 > Unknow: 代表未知	Yes
ReceiptCode	string	状态报告编码	Yes
ReceiptDesc	string	回执结果描述	Yes
ReceiptTime	int	回执返回时间	Yes
UserId	string	自定义的业务标识ID，字符串	Yes

示例

请求示例


https://api.tnqacloud.com/?Action=GetUSMSSendReceipt
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=GqkCNOVN
&SessionNoSet.N=nAQDODtO

响应示例


{
  "Action": "GetUSMSSendReceiptResponse",
  "Data": [
    {
      "ReceiptSet": [
        {
          "CostCount": 6,
          "Phone": "QbPtKJPa",
          "ReceiptCode": "0",
          "ReceiptDesc": "DxMRsuET",
          "ReceiptResult": "发送成功",
          "ReceiptTime": 6,
          "UserId": "1213"
        }
      ],
      "SessionNo": "BmThtoRB"
    }
  ],
  "Message": "OnVhSPcD",
  "RetCode": 0
}