sms.history

sms.history 命令用于获取历史短信。

通过指定以下内容来请求获取短信历史记录：

使用开始日期和结束日期的明确时间区间
由“上一个时间区间”样式查询定义的时间区间（最后 "24h" 等）
上一次记录条数
无标识符，用于返回整个帐户的短信历史记录
标签。有关标签的更多信息，请参见使用标签
id 数组
文本消息的内容

TR50 请求

Definite time period 时，

// Definite time period request
{
    "1": {
        "command": "sms.history",
        "params": {
            "msisdn": "mymsisdn",
            "start": "2017-01-01T00:00:00Z",
            "end": "2017-01-31T23:59:59Z",
            "offset": 0,
            "limit": 50,
            "sort": "-dateSent",
            "direction": "mo"
        }
    }
}

Last period of time 时，

// Last period of time request
{
    "1": {
        "command": "sms.history",
        "params": {
            "msisdn": "mymsisdn",
            "last": "24h",
            "offset": 0,
            "limit": 50,
            "sort": "-dateSent"
        }
    }
}

上一次记录数

// Last number of records request
{
    "1": {
        "command": "sms.history",
        "params": {
            "msisdn": "mymsisdn",
            "records": 100,
            "offset": 0,
            "sort": "-dateSent",
        }
    }
}

无标识符

// No identifiers are set then the SMS history of the entire organization will be returned for the specific period specified
{
    "1": {
        "command": "sms.history",
        "params": {
            "start": "2017-12-01T00:00:00Z",
            "end": "2018-01-31T23:59:59Z"
        }
    }
}

基于标签

// Based on Tags
{
  "1": {
      "command": "sms.history",
      "params": {
            "start": "2017-12-01T00:00:00Z",
            "end": "2018-01-31T23:59:59Z",
            "tags":"career1"
          }
  }
}

id 数组

// Array of ids
{
  "1": {
      "command": "sms.history",
      "params": {
            "start": "2017-12-01T00:00:00Z",
            "end": "2018-01-31T23:59:59Z",
            "id": ["59962ef7fe2a133569421d26", "59261f811c5bd72b33e800c7"]
      }
  }
}

消息内容

// Content of a Message
{
  "1": {
      "command": "sms.history",
      "params": {
            "start": "2017-12-01T00:00:00Z",
            "end": "2018-01-31T23:59:59Z",
            "message": "\"Message for the second template\""
      }
  }
}

请求参数

名称	类型	必需	描述
thingKey	字符串	是*	标识要获取其短信历史记录的连接。
esn	字符串		标识要获取其短信历史记录的连接。
iccid	字符串		标识要获取其短信历史记录的连接。
imei	字符串		标识要获取其短信历史记录的连接。
imsi	字符串		标识要获取其短信历史记录的连接。
meid	字符串		标识要获取其短信历史记录的连接。
msisdn	字符串		标识要获取其短信历史记录的连接。
*需要使用以上参数之一。
start	字符串		发出 definite time period request 时，此参数是指定时间窗口开始的时间戳。
end	字符串		发出 definite time period request 时，该参数是指定时间窗口结束的时间戳。
last	字符串		发出 last period of time request 时，此参数指定最后 X 个时间量，以秒 (s)、分钟 (m)、小时 (h) 或天 (d) 为单位。
records	整数		发出 last number of records request 时，此参数指定要返回的记录条数。零值将返回全局最大记录条数。
offset	整数		用于分页的起始记录偏移量。如果未指定，则默认值为 0。
limit	整数		限制返回的结果数量。默认值为最大配置大小。
sort	字符串		字符串指示方向（+ 表示升序，- 表示降序）和作为结果排序依据的列。要按 dateSend 降序排序，则使用 "-dateSent"。
direction	字符串		根据消息的方向过滤历史记录的结果。对于移动设备发起的消息，方向为 "mo"，对于移动设备终止的消息，方向为 "mt"。如果省略，则同时返回移动设备发起的消息和移动设备终止的消息。
external	布尔型		外部命令是可选的布尔字段（默认值为 false），将其设置为 true 时，仅返回与连接无关的消息记录。否则，将不执行此类筛选。

TR50 响应

如果命令发送成功，将显示一条成功消息并返回找到的历史记录。否则，将返回错误和错误消息。

返回的记录数受 M2M 服务的限制。如果选择的结果超出物联网设备管理门户的限制，则应缩短时间窗口或降低所请求的记录条数。

{
  "1": {
    "success": true,
    "params": {
      "count": 321,
      "values": [
        {
          "id": "531c907b5d80f1330c238757",
          "orgId": "533ef123310046187700007f",
          "connId": "578e3232a681fdc03520dfa66",
          "uuid": "534e49181c5bd5328cd57539",
          "esn": "",
          "from": "463191003136461",
          "to": "700092",
          "type": "mo",
          "message": "The message",
          "msisdn": "453291003336461",
          "dateSent": "2017-12-05T13:26:32.769Z",
          "status": "received",
          "statusRaw": "RECEIVED"
	   "validity": 1200							
        },
        ...
      ]
    }
  }
}

响应参数

名称	类型	描述
count	整数	匹配的记录的总数。
values	数组	历史记录的数组。

值数组对象

名称	类型	描述
id	字符串	id 是每条短信记录的唯一标识符。在共享连接和物的情况下，将为共享连接的每个帐户创建重复短信，并且每条短信将具有不同的 id
uuid	字符串	uuid 是通过 SMS 引擎发送的每条短信的标识符。在共享连接和物的情况下，连接共享的每个帐户都有重复的短信记录，并且每条记录将共享相同的 uuid。
msisdn	字符串	目标的 MSISDN。
user	字符串	发送消息的用户
dateSent	字符串	最初发送短信的日期
to	字符串	消息发送给的连接的 ID。
type	字符串	对于移动设备发起的消息，类型为 "mo"，对于移动设备终止的消息，类型为 "mt"
message	字符串	消息。
encoding	字符串	编码类型：SEVEN_BIT、EIGHT_BIT 和 UCS2 等
from	字符串	标识短信的发送者或来源的字符串。
preferredSmsc	字符串	首选短信服务中心：tele2、att等。
routingPlan	字符串
priority	整数	从 0（最高优先级）到 10 的整数。
delivery	布尔型	如果为 true，将生成发送消息。
status	字符串	消息状态的文字描述。
statusRaw	字符串	原始未优化的状态字符串。
validity	整数	尝试发送短信的时间量。
statusHistory	数组	包含短信在到达目标时的状态更改的数组。
deliveredTime	字符串	发送的日期/时间。
failedTime	字符串	发送失败的日期/时间。

StatusHistory 数组对象

名称	类型	描述
status	字符串	消息状态的文字描述。
statusRaw	字符串	原始未优化的状态字符串。
text	字符串	包含更多状态信息的字段。
ts	字符串	状态更新的日期/时间。