Skip to main content

Get Cellular Module Status (v2.0)

GET 

/sdwan/v2.0/api/machines/:machine_id/cellular_modules/:cellular_module_id/status

Get the cellular module status.

Request

Path Parameters

    machine_id stringrequired

    The ID of the device.

    cellular_module_id stringrequired

    ID of the cellular module.

Responses

Successful Operation

Schema
    activation_state string

    The activation state of the cellular module.

    active_sim integer

    The active SIM of the cellular module.

    carrier string

    The name of the carrier.

    firmware FirmwareState[]

    The firmware of the cellular module.

  • Array [
  • active boolean

    Active

    carrier string

    Carrier

    fw_version string

    Fw Version

    pri_version string

    Pri Version

    storage_location string

    Storage Location

  • ]
  • gps GPSState

    The GPS, if enabled for the cellular module.

    latitude double

    Latitude

    longitude double

    Longitude

    state string

    State

    id string

    The ID of the cellular module.

    imei string

    The IMEI number.

    last_state_change int64

    Lists the last state change of the firmware.

    manufacturer string

    The manufacturer of the firmware.

    model_name string

    The model name.

    modem_error_reason string

    The reason for a modem error.

    modem_state string

    The modem state.

    network_registration_state string

    The network registration state.

    network_state NetworkState

    The network state.

    cell_id integer

    Cell Id

    frequency_band string

    Frequency Band

    mcc integer

    Mcc

    mnc integer

    Mnc

    roaming boolean

    Roaming

    packet_service_state string

    The packet service state.

    serial_number string

    The serial number.

    signal_strength_indicator string

    The signal strength indicator.

    sim SimState[]

    Details of the SIM.

  • Array [
  • carrier string

    Carrier

    iccid string

    Iccid

    imsi string

    Imsi

    pin_state string

    Pin State

    present boolean

    Present

    remaining_attempts_pin_verify integer

    Remaining Attempts Pin Verify

    remaining_attempts_puk_unblock integer

    Remaining Attempts Puk Unblock

    slot_number integer

    Slot Number

  • ]
  • technology string

    The technology of the cellular module.

Loading...