json

{
  "PhoneNumbers": [
    { "Number": "+17064491796" }
  ]
}

{
  "PhoneNumbers": [
    {
      "Number": "+17064491796",
      "Status": "ACTIVE",
      "StatusMessage": "",
      "Used": "0 B",
      "Remaining": "20 MB",
      "CurrentBehavior": "Active"
    }
  ],
  "Status": "Complete"
}

Numbers

Data Usage Info

Retrieve real-time data usage information for one or more phone numbers, including amount used, remaining data, and current behavior (active, throttled, etc.).

What this does: Returns current consumed data and remaining data for each number in the batch. Values are in the unit specified by ValueUnit (MB). Use this for real-time monitoring dashboards or to decide whether to adjust a number’s data limit.

Next steps:

Update data limits — POST /v1.0/numbers/data-usage
View current limit settings — POST /v1.0/numbers/data-usage/settings

POST

v1.0

numbers

data-usage

info

json

{
  "PhoneNumbers": [
    { "Number": "+17064491796" }
  ]
}

{
  "PhoneNumbers": [
    {
      "Number": "+17064491796",
      "Status": "ACTIVE",
      "StatusMessage": "",
      "Used": "0 B",
      "Remaining": "20 MB",
      "CurrentBehavior": "Active"
    }
  ],
  "Status": "Complete"
}

Authorizations

Authorization

string

header

required

Enter the token obtained from the Authentication endpoint

Body

application/json

PhoneNumbers

object[]

required

Array of phone numbers to retrieve real-time data usage for

Show child attributes

Response

200 - application/json

Data Usage Info Retrieved

The response is of type object.

Data Usage Settings Device Details

⌘I

Documentation Index

Authorizations

Body

Response