querysms

2025-01-24 12:17

概览

API URL：/api/v1/zoloz/globalsms/querysms
API 描述：该接口用于查询短信发送详情，包括短信发送状态、短信发送时间、短信发送成功的条数等。

请求参数

字段名称	数据类型	最大长度	是否必填	描述	示例值
transactionId	String	32	是	需要查询的事务ID。一次只能传入一个transactionId，可通过sendsms API获取transactionId。	"G0062000061MT20230325dAqiXBpQUbVB9h****"

返回参数

字段名称	数据类型	必须返回	描述	示例值
result	Result	是	API请求结果，包含结果状态、结果码和结果消息。	{ "resultStatus": "S", "resultCode": "SUCCESS", "resultMessage": "Success" }
status	int	是	短信发送状态。 `Unsubmitted`：待发送的短信未提交。 `SubmittedFailed`：待发送的短信提交失败。 `Submitted`：待发送的短信已提交。 `Delivered`：短信发送成功。 `DeliveryFailed`：短信发送失败。	"Delivered"
smsNum	String	否	用于计费的短信条数，详见计费说明。	1
sendDate	String	否	短信发送时间。	"2024-03-14T20:26:22+08:00"
deliveredDate	String	否	运营商成功发送短信的回执时间。说明：当`status`为`Delivered`时，才返回该字段。	"2024-03-14T20:26:36+08:00"

处理结果

根据请求结果执行下一步的响应动作，具体如下：

当result.resultStatus的值为S时，表示调用ZOLOZ Global SMS querysms API成功，并返回短信发送详情。
当result.resultStatus的值为F时，表示调用ZOLOZ Global SMS querysms API失败。请检查错误码获取有关该错误的更多信息，并分析导致该错误的原因。

API通用结果码

有关通用结果码的完整列表，请参见API通用结果码。

API特有结果码

Global SMS querysms API的结果码见下表。

结果码	结果状态	英文描述	中文描述
SUCCESS	S	Success	API调用成功
MERCHANT_INFO_MISSING	F	Merchant info missing	商户信息缺失
EXTERNAL_ERROR	F	External error	外部错误
ILLEGAL_STATE	F	Illegal state	非法状态
PARAM_ERROR	F	Param error	参数错误
UNKNOWN_EXCEPTION	F	Unknown exception	未知错误
TRANSACTION_ID_NOT_EXISTED	F	Transaction id does not exist	transactionId不存在

代码示例

请求示例

copy
{
  "transactionId": "G0062000061MT20230325dAqiXBpQUbVB9h****"
}

返回示例

copy
{
    "result": {
        "resultStatus": "S",
        "resultCode": "SUCCESS",
        "resultMessage": "Success"
    },
    "deliveredDate": "2024-03-14T20:26:36+08:00",
    "sendDate": "2024-03-14T20:26:22+08:00",
    "status": "Delivered",
    "smsNum": 1
}