跳转到内容

批量发送状态查询

接口描述
  • 请求URL:/admin-api/open/sms/queryBatchStatus
  • 请求方式:POST
  • 请求类型:application/json
请求参数
字段名变量名必填类型示例值描述
批次idbatchIdLong批次id:1712743263703797760批次id:1712743263703797760
发送时间sendTimeLong例如20181225yyyyMMdd
号码mobileString17888999000号码
分页页码pageNointeger1页码,从 1 开始
每页条数pageSizeinteger10每页条数,默认10条 <=100
请求示例数据
json
{
  "batchId": "1712641546907684864",
  "sendTime": 20231013,
  "pageNo": 1,
  "pageSize": 10
}
返回参数
字段名变量名必填类型示例值描述
返回状态codeint00-处理成功,其他-处理有误,详见错误码
返回信息msgStringsuccess具体错误原因,例如:参数格式校验错误
返回数据dataobject{}返回数据,json格式数据
响应时间timeString1661227655420请求响应时间
data 数据格式
字段名变量名必填类型示例值描述
记录ididString774记录id
发送状态sendStatusString10发送状态
发送时间sendTimeString1662628647000发送时间
发送结果的编码sendCodeString0发送结果的编码
发送结果的提示sendMsgString请求成功发送结果的提示
接收状态receiveStatusString0接收状态
接收时间receiveTimeString1662628647000接收时间
自定义参数outIdString2022081901如订单号或短信发送记录流水号,状态查询会回传,最大支持256位
返回示例数据
json
{
    "code": 0,
    "data": {
      "list": [
        {
          "id": 774,
          "sendStatus": 10,
          "sendTime": 1662628647000,
          "sendCode": 0,
          "sendMsg": "请求成功",
          "receiveStatus": 0,
          "receiveTime": 1662628647000,
          "outId": "2022081901"
        }
      ],
      "total": 1
    },
    "msg": "success",
    "time": 1662628673102
}