cdp.usage.sms.highest

This is not supported for shared connections

The cdp.usage.sms.highest command is used to acquire and return the connections that have the highest SMS usage. The connections will be sorted by number of SMS (value field) in descending order.

TR50 Request

// Definite time period request
{
  "cmd" : {
    "command": "cdp.usage.sms.highest",
    "params": {
      "start": "2014-01-01T00:00:00Z",
      "end": "2014-01-31T23:59:59Z",
      "limit": 20
    }
  }
}

// Last period of time request
{
  "cmd" : {
    "command": "cdp.usage.sms.highest",
    "params": {
      "last": "30d",
      "limit": 20
    }
  }
}

Request Parameters

Name	Type	Required	Description
connectionId	String	Yes*	The identifier of the connection.
thingId	String		The identifier of the thing that the connection is related to.
thingKey	String		The identifier of the thing that the connection is related to.
esn	String		ESN of the connection.
iccid	String		ICCID of the connection.
imsi	String		IMSI of the connection.
imei	String		IMEI of the connection.
meid	String		MEID of the connection.
msisdn	String		MSISDN of the connection.
terminalId	String		The Terminal ID of the connection
start	String		This is the timestamp for the start of the reporting time window.
end	String		This is the timestamp for the end of the reporting time window.
last	Integer		When doing a last period of time request this specifies the last X amount of time in seconds (s), minutes (m), hours (h), or days (d).
split	Boolean		Set to true if you want the timestamp and value fields to be split into two arrays.
*Any of these parameters can be specified to get aggregate data for a single connection. None of these parameter should be specified if aggregating data usage for all connections.

TR50 Response

If the command is sent successfully a success message and the highest connection SMS usage records are returned. Otherwise, an error and error message will be returned.

{
  "cmd": {
    "success": true,
    "params": {
      "values": [
        {
          "id": "5e00c48b400001b5914c7c77",
          "value": 298
        },
        {
          "id": "5e001b59100c48b4004c7c74",
          "value": 202
        },
        {
          "id": "5001b5914c7e00c48b400c76",
          "value": 198
        }
      ]
    }
  }
}

Response Parameters

Name	Type	Description
id	Integer	The identifier of the connection.
value	Array	The number of SMS during the period requested.