SIM Tools API

The SIM Tools API executes SIM or connectivity commands for a known device MSISDN. All endpoints require a valid Bearer token: Authorization: Bearer ...

Path Structure

/[SCOPE]/simtools/[COMMAND]/[MSISDN]

• SCOPE is live or sandbox.
• COMMAND is the action to execute.
• MSISDN is the phone number assigned to the target device SIM.
• The request body can be empty.

GET /[SCOPE]/simtools/sms/[MSISDN]

Sends a test SMS to the target device SIM.

Parameters

None besides MSISDN in the path.

Response

{
  "status": {
    "code": "200",
    "apiTimeConsumed": "0.120s"
  },
  "data": {
    "command": "sms",
    "status": "ok"
  }
}

GET /[SCOPE]/simtools/reset/[MSISDN]

Requests a connectivity reset for the target device SIM or endpoint.

Parameters

None besides MSISDN in the path.

Response

{
  "status": {
    "code": "200",
    "apiTimeConsumed": "0.180s"
  },
  "data": {
    "command": "reset",
    "status": "ok"
  }
}

GET /[SCOPE]/simtools/enable/[MSISDN]

Enables the SIM and endpoint for the target device.

Parameters

None besides MSISDN in the path.

Response

{
  "status": {
    "code": "200",
    "apiTimeConsumed": "0.220s"
  },
  "data": {
    "command": "enable",
    "status": "ok"
  }
}

GET /[SCOPE]/simtools/disable/[MSISDN]

Disables the SIM and endpoint for the target device.

Parameters

None besides MSISDN in the path.

Response

{
  "status": {
    "code": "200",
    "apiTimeConsumed": "0.220s"
  },
  "data": {
    "command": "disable",
    "status": "ok"
  }
}

Errors

Errors are returned as JSON responses with an ErrorMessage field.