1. API Interface
EIOTCLUB API
  • API Interface
    • Interface Description
    • Signature algorithm
    • Error Code
    • Card service interfaces
      • Query all cards under account (Deprecated)
      • Single Card Information Query (Deprecated)
      • Query Batch Card
      • Query Card Package Order Records
      • Query available packages for a card
      • Single Card Refresh (Deprecated)
      • Query international card warning information under the account
      • Card total statistics
      • Query profit sharing information at the current level
      • Query the list of operators that the card can switch to
      • Switch the operator of the card
      • Unlock the IMEI pool of the card
      • Add IMEI to the IMEI card pool
      • Send SMS
      • Query the refundable amount
      • Query customer account balance
      • Query the status of a package subscription order
      • Query the product to which the card belongs
      • Query the orderable packages under the specified product
      • Query orderable eSIM products
      • Purchase eSIM
      • Refund an eSIM order
      • Query eSIM order details
      • Query the refundable amount of an eSIM order
      • Query the details of the package corresponding to the order
      • Card bind device
      • Card unbind device
      • Card Transfer Package
      • Refresh package usage
      • Cancel current session
      • Query the seed number list of the eUICC card
      • Deliver eSIM remotely
      • Query all profiles under eUICC
      • Query Switchable Products for the Card
      • Switch Card Product
    • Card package subscription interfaces
      • Package subscription interface
      • Package refund interface
    • Asynchronous notification
      • Traffic alert
      • Unlock notification
      • Card locking notification
      • Subscription notification
      • Subscription notification - detailed version
      • Package activation notice
      • Product switching
      • Refund notification
      • Notification of package expiration upon reaching usage limit
      • Notification of card network disconnection
      • Notification of card being removed from the IMEI pool
      • Notification of card being moved into the IMEI pool
      • Notification of agent pool deact pkg
      • Notification of agent pool pkg activate
      • Notification of agent pool pkg traffic alert
      • EIM remote operation result notification
    • Cloud eSIM
      • Query all cloud eSIM cards under account
      • Single Cloud eSIM Card Details
      • Query Available Packages for Cloud eSIM Card
      • Query cloud eSIM card subscription records
      • Refresh eSIM card under account
      • Purchase eSIM card plan under account
      • Cloud eSIM card order status under account
      • Refund for Cloud eSIM Card Orders Under the Account
      • Query Refundable Amount for Cloud eSIM Card Orders Under the Account
      • Cloud eSIM Transfer Package
      • Cloud eSIM unlock
      • Query Switchable Products for the Cloud eSIM Card
      • Switch Cloud eSIM Card Product
      • Batch Add Cloud eSIM EIDs to IMEI Pool
    • Cloud eSIM Asynchronous notification
      • Traffic alert
      • Subscription notification
      • Package activation notice
      • Refund notification
      • Notification of package expiration upon reaching usage limit
      • Notification of card network disconnection
      • Product switching
      • Card locked notification
      • Card unlocked notification
    • Pool
      • Get pool package list
      • Create pool
      • Get pool list
      • Delete empty pool
      • Subscribe pool package
      • Get pool record list
      • Unsubscribe pool package
      • Get pool's can add card
      • Add pool's card
      • Get pool's card list
      • Remove pool's card
      • Get pool by iccid
    • CDR
      • Batch Query ICCID Traffic
  1. API Interface

Error Code

Error Codes
Error CodeDescription
200Success
403You don't have permission to access.
500Operation failed, try again later.
501Too many requests.
502IP whitelist error.
41001Invalid iccids parameter.
41002Invalid iccid format.
41003Iccid is empty or format is wrong.
41013Imsi is empty or format is wrong.
41014Network param is empty or wrong.
41015Imei is empty or format is wrong.
41040Email is empty or format is wrong.
41041Url is empty or format is wrong.
41004Invalid startDate parameter.
41005Invalid endDate parameter.
41006Invalid date parameter.
41007Batch card numbers exceed limit.
41008Card number doesn't match operator.
41050Package product attributes don't match card.
41009Invalid startYearMonth parameter.
41010Invalid endYearMonth parameter.
41011Phone number is empty.
41012Code is empty.
41018Invalid package code for order.
41028Card has no such package.
41029Invalid package activation type param.
41030Username {} not found when verifying sign, contact tech support.
41031You don't have this package.
41032This operator is not supported currently.
41033Please complete real - name verification first.
41034Phone number already exists in address book.
41035Reached API config limit of 10, configure in official account.
41036Ordering is abnormal.
41037Card has no monthly package.
41103Activation failed.
41102Invalid operation type (1: activate, 2: deactivate).
41104Deactivation failed.
41019Package activation type is empty or abnormal.
41020Operator type param is empty or abnormal.
42022Package ID cannot be empty.
42401Signature string is empty.
42402Invalid signature, check encryption method.
42403PageNum is empty or format is wrong.
42407Invalid pageSize value.
42404Invalid card pool number.
42405Account has no such iccid card.
42408Account has no such IMEI pool.
42406User has no available packages for iccid.
42409Invalid time format.
41998API customer info is abnormal, contact tech support.
42000SMS content is empty or exceeds limit.
42001outTradeNo is empty or format is wrong (max 32 digits).
42002outTradeNo already exists.
42003OrderId is empty or format is wrong.
42004Order does not exist.
42005This payment method is not supported.
42006Order status is abnormal.
42007Package does not exist.
42008Package status does not allow refund.
42009Max 50 items can be queried.
42101Appkey is empty.
42102Appkey does not exist.
42104ip:{} is not authorized, configure ip whitelist.
42201Timestamp is empty.
42203Timestamp is inaccurate.
42204Invalid time format.
42301Nonce is empty.
43331Server exception.
43332Parameter error.
43333Missing error hint.
44001Operation too frequent, refresh once every 5 mins.
44002Refresh failed.
503016Duplicate order number.
50001Package configuration is abnormal.
900910No operation permission.
900911Card not found.
45101Invalid SMS parameters.
45102Too frequent card unlocking.
45103Exceeded card unlocking limit.
45104Card doesn't need unlocking.
45105Card status doesn't allow network switching.
45106Remark cannot be empty.
45107Switching to this network is not supported.
45108Card product not found.
45109eSIM product not found.
45110eSIM out of stock.
45111eSIM order not found.
45112Insufficient balance.
45113Refund not allowed at current status.
Modified at 2025-04-01 07:36:11
Previous
Signature algorithm
Next
Query all cards under account (Deprecated)
Built with