Get Device Usage
Description
Returns cycle-to-date usage information for a specified device.
Resource URL
GET rws/api/v{apiVersion}/devices/{iccid}/ctdUsages
Request Parameters
Parameter | Description |
---|---|
apiVersion |
The version number for this API. The current version for all functions is 1. |
iccid | The ICCID of the device you want information about. |
Response Parameters
Return Value | Description |
---|---|
iccid | The ICCID of the device. |
imsi | The device IMSI. |
msisdn | The device MSISDN or phone number. |
imei | The device IMEI. |
status | The device SIM status. For a list of valid values, see SIM Status Values. |
ratePlan | The name of the rate plan associated with the device. |
communicationPlan | The name of the communication plan associated with the device. |
ctdDataUsage |
The amount of data used (in bytes) since the beginning of the billing cycle. |
ctdSMSUsage |
A count of the mobile-originated and mobile-terminated messages since the beginning of the billing cycle. |
ctdVoiceUsage |
The number of voice seconds used since the beginning of the billing cycle. |
ctdSessionCount | The number of data sessions since the beginning of the billing cycle. |
overageLimitReached | A true/false value indicating whether the device has reached the data limit set in the rate plan. |
overageLimitOverride |
Indicates whether the device can exceed the data limit specified in the rate plan. The possible values are: • DEFAULT. The device cannot exceed the data limit. • TEMPORARY_OVERRIDE. The device can use any amount of data until the end of the current billing cycle, at which point Control Center will begin enforcing the data limit set in the rate plan. • PERMANENT_OVERRIDE. The device can use any amount of data, regardless of the data limit defined in the rate plan. |
Request Example
Make sure to use your own user credentials. See Authentication for information about creating an authorization header.
Response Example
Code Samples
Make sure to use the Control Center sandbox URL and your own user credentials.
Errors
Error Code | HTTP Code | Error Message |
---|---|---|
10000001 | 401 |
Invalid credentials. Description: Control Center uses this error message when the API credentials are invalid or when the IP address is not within the allowed range. |
10000024 | 400 | Invalid apiVersion. |
10000031 | 400 | Invalid Zone. |
20000001 | 404 | Resource not found - Invalid ICCID. |
30000001 | 500 | Unknown server error. |