Get network information for a connectivity subscription.

Fetches network information of a connectivity subscription. Note that the available data differs between CMPs, and some data is only accessible if the subscription has had recent network activity.

Path Parameters

• imsi string required

  Possible values: Value must match regular expression ^[0-9]{6,15}$

  IMSI to perform request on.

Responses

• 200
• 400
• 401
• 404
• 429
• 500

---

Contains the requested network information for a connectivity subscription.

application/json

• Schema
• Example (from schema)

---

Schema

• attributes object

  lastActivityAt date-time

  An ISO formatted string representing the time of the last activity of the subscription.

  lastLocationUpdateAt date-time

  An ISO formatted string representing the time of the last location update.

  lastLocationUpdateCountryCode string

  ISO 3166 two-letter Country Code of the last location update.

  data object

  isConnected boolean

  Indicates if the subscription is currently connected.

  apn string

  The APN used by the subscription for the current session.

  ipv4 string

  Last IPv4 address of the SIM in the mobile network for the previous 60 days.

  ipv6 string

  Last IPv6 address of the SIM in the mobile network for the previous 60 days.

  uploadedBytes integer

  Accumulated transmitted bytes for the current day.

  downloadedBytes integer

  Accumulated received bytes for the current day.

  latestUploadedAt date-time

  An ISO formatted string representing the time of the last uploaded data for the current day.

  latestDownloadedAt date-time

  An ISO formatted string representing the time of the last received data for the current day.

  sms object

  sent object

  count integer

  The number of mobile originated SMS sent for the current day.

  lastSmsSentAt date-time

  An ISO formatted string representing the time of the latest SMS sent for the current day.

  errorCount integer

  The number of SMS send errors for the current day.

  received object

  count integer

  The number of mobile terminated SMS for the current day.

  lastSmsSentAt date-time

  An ISO formatted string representing the time of the latest SMS received for the current day.

  errorCount integer

  The number of SMS receive errors for the current day.

{
  "attributes": {
    "lastActivityAt": "2024-10-17",
    "lastLocationUpdateAt": "2024-10-17",
    "lastLocationUpdateCountryCode": "string",
    "data": {
      "isConnected": true,
      "apn": "string",
      "ipv4": "string",
      "ipv6": "string",
      "uploadedBytes": 0,
      "downloadedBytes": 0,
      "latestUploadedAt": "2024-10-17",
      "latestDownloadedAt": "2024-10-17"
    },
    "sms": {
      "sent": {
        "count": 0,
        "lastSmsSentAt": "2024-10-17",
        "errorCount": 0
      },
      "received": {
        "count": 0,
        "lastSmsSentAt": "2024-10-17",
        "errorCount": 0
      }
    }
  }
}

BadRequest

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Unauthorized. Your token is not valid.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

The specified resource was not found

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

RateLimitError. Too Many Requests.

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Internal Server Error

Response Headers

• Access-Control-Allow-Origin string
• Access-Control-Allow-Methods string
• Access-Control-Allow-Headers string

application/json

• Schema
• Example (from schema)

---

Schema

• name string
• message string
• errors object[]

  message string

  errorCode string

  path string

  Optional path, usually used to describe which incoming parameters are not valid.

{
  "name": "string",
  "message": "string",
  "errors": [
    {
      "message": "string",
      "errorCode": "string",
      "path": "string"
    }
  ]
}

Loading...