售前咨询
4008-753-365 , (021) 6695-7999
* 在线交谈可咨询售前、售后等问题,在您开始接入 SUBMAIL 产品时,售前顾问和售后技术支持工程师可帮助您解决遇到的任何使用问题
售前顾问咨询 09:00 - 20:00 (24x7)
购物车
在线商务咨询
咨询热线:4008 753 365 (021) 6695 7999
返回顶部

API: log/message(BETA)

 

   概览

 

log/message 是 SUBMAIL 的短信发送日志查询 API。

log/message API 可以方便的查询详细的短信发送日志和状态记录,不仅如此,log/message API 还可以按短信模板、手机号码、发送状态、开始/结束日期等条件筛选日志的返回结果。

 

   URL
<主> https://api.mysubmail.com/log/message
<备> https://api.submail.cn/log/message
   支持格式
json
https://api.mysubmail.com/log/message.json
默认
xml
https://api.mysubmail.com/log/message.xml
 
   请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的短信应用 ID

recipient

string

可选

全部联系人

按接收者返回数据

默认返回全部联系人数据,要指定返回某个联系人的日志,请将该值设为 该联系人的11位手机号码

project

string

可选

全部项目标识

按短信项目标识返回数据

默认返回全部项目数据,要指定短信项目标识返回某个项目(即短信模板)的日志,请将该值设为该模板的项目标识

result_status

string

可选

全部数据

按发送状态返回数据 delivered , dropped

默认返回全部数据,要指定所有发送成功的日志,请将该值设为 delivered ,要查询发送失败的数据,请将该指 dropped

start_date

UNIX 时间戳

可选

当日凌晨
00:00:00

日志查询的开始时间(使用 UNIX 时间戳格式)

 

默认值:当日的凌晨 如:2015-04-05 00:00:00

如需指定开始时间:2015-04-05 00:00:00 请将其转换为 UNIX 时间戳格式 例:2015-04-05 00:00:00 的UNIX时间戳 1428163200

end_date

UNIX 时间戳

可选

当日23:59:59

日志查询的结束时间(使用 UNIX 时间戳格式)

 

默认值:当日的23:59:59 如:2015-04-05 23:59:59

如需指定结束时间:2015-04-05 23:59:59 请将其转换为 UNIX 时间戳格式 例:2015-04-05 23:59:59 的UNIX时间戳 1428249599

order_by

string

可选

desc

返回数据时执行的升序或降序(asc or desc)

若希望返回的数据按照发送时间升序排列,请将 order_by 参数设为 asc,反之则设为 desc

rows

string

可选

50

单次返回数据的行数

请将该值控制在10-1000之间,若指定了一个无效的 rows 参数,API 将默认返回 50 行数据

offset

string

可选 0

数据偏移指针

该值可以指定返回数据的偏移指针,例:假如单次请求的开始至结束日期包含150条数据,rows参数采用默认的50行,此时需要查询第51-100行的数据,请将 offset 参数设为1(即数据偏移50行)即可得到第51-100行的数据,offset=2时,将返回第101-150行数据,以此类推

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   代码示例

使用 POST 方法获取日志


 

 


使用 CURL 获取发送日志


 
   返回码