首页 帮助中心 API

查询短信发送结果

说明: 查询指定msgId集合的发送结果,支持查询最近90-120天的短信记录。

请求参数说明:

参数 说明 是否必填 类型

appId

应用id(短信-短信应用)

String

msgIds

sendSms接口响应返回的平台id,多个用英文逗号分隔,单次查询最大200个msgId

String

请求URL:

                      
                        https://api.onbuka.com/v3/getReport?appId={appId}&msgIds={msgIds}
                      
                    

请求示例:

                      
                        RequestURL:
                          https://api.onbuka.com/v3/getReport?appId=4luaKsL2&msgIds=2108021054011000095,2108021059531000096
                        RequestMethod:
                          GET
                        RequestHeaders:
                          Content-Type:application/json;charset=UTF-8
                          Sign:05d7a50893e22a5c4bb3216ae3396c7c
                          Timestamp:1630468800
                          Api-Key:bDqJFiq9
                      
                    

响应参数说明:

参数 说明 类型

status

状态码,0成功,其他失败参见状态码说明

String

reason

失败原因说明

String

success

发送成功的条数

String

fail

发送失败的条数

String

sending

正在发送的条数

String

nofound

Id未找到的条数(包含队列中的短信)

String

array

找到发送结果的json集合

JSONArray

msgId

提交号码对应平台msgId

String

number

提交号码

String

receiveTime

发送时间,ISO8601标准时间格式(2021-02-12T09:30:03+08:00)

String

status

发送状态:0发送成功,-1:发送中,1:发送失败(不包含队列中的短信)

String

响应示例:

                    
                      {
                        "status": "0",
                        "reason": "success",
                        "success": "2",
                        "fail": "0",
                        "sending": "0",
                        "nofound": "0",
                        "array": [
                          {
                            "msgId": "2108021054011000095",
                            "number": "91856321412",
                            "receiveTime": "2021-02-12T09:30:03+08:00",
                            "status": "0"
                          },
                          {
                            "msgId": "2108021059531000096",
                            "number": "91856321413",
                            "receiveTime": "2021-02-12T09:30:03+08:00",
                            "status": "0"
                          }
                        ]
                      }
                    
                  
 

意见反馈

0/500