Smarthub Api En
  1. SIM Card Management
  • Overview
    • Global Description
  • SIM Card Management
    • Retrieve SIM detail information
      GET
    • Retrieve list of SIMs detail information
      GET
    • Retrieve state change history of SIMs
      GET
    • Retreive custom field of SIM
      GET
    • Edit custom field of SIM
      PUT
    • Activate SIM
      POST
    • Suspend SIM
      POST
    • Retire SIM
      POST
    • SIM subscribe to supplimentary rate plan
      POST
    • Change SIM basic rate plan
      PUT
    • Change SIM apn status
      PUT
  • SIM Card Batch Operation
    • Batch SIM activate
      POST
    • Batch SIM suspend
      POST
    • Batch SIM retire
      POST
    • Batch change SIM basic rate plan
      POST
    • Retrieve batch job information
      GET
  • Sms Service
    • Send SMS to terminal
      POST
    • Query SMS delivery status
      GET
    • MO SMS Push
      POST
    • Push MT SMS Status Report
      POST
  • Subscription Notification
    • Push Cycle Usage Tracking Event Notification
      POST
    • Push Imei Change Event Notification
      POST
    • Push No Session Connection Event Notification
      POST
    • Push Prepaid Service Package Expired Event Notification
      POST
    • Push Prepaid Service Package Traffic Tracking Event Notification
      POST
    • Push Sim Status Change Event Notification
      POST
    • Push Sim Apn Status Change Event Notification
      POST
  • Share Pool
    • Get share pool information
  • Enterprise Information
    • Get enterprise information
    • Get account information
    • Get servicePackages information
  • SIM Card Statistics
    • Get the country code traffic and number of cards for SIM card statistics
  1. SIM Card Management

Retire SIM

POST
/global-sims/{giccid}/retire
SIM in Suspended can be retired using this API
Error code is defined as follow
codedescription
illegal_statusIllegal SIM state, current SIM state cannot be retired

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/global-sims//retire' \
--header 'X-API-Key;'

Responses

🟢200OK
application/json
Retired
Body

Example
{}
🟠422Parameter Error
Modified at 2024-11-06 08:54:48
Previous
Suspend SIM
Next
SIM subscribe to supplimentary rate plan
Built with