# 单卡信息查询

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v3/card/getCardsInfo:
    post:
      summary: 单卡信息查询
      deprecated: false
      description: 根据卡号，获取单卡信息及流量使用信息
      tags:
        - API接口/卡业务接口
        - 通用
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              title: ''
              type: object
              properties:
                appkey:
                  type: string
                  default: '{{APPKEY}}'
                  description: >-
                    appkey平台用以确定客户端应用的身份。应用键对应一个密钥 secret。要基于服务平台开发应用，必须事先通过申请获取
                    appkey/secret 后，才能进行应用的开发。
                  x-apifox-mock: '{{APPKEY}}'
                timestamp:
                  type: integer
                  description: 当前时间戳，10位数字
                  x-apifox-mock: '{{TIMESTAMP}}'
                nonce:
                  type: integer
                  minimum: 10000
                  maximum: 99999
                  description: 5位随机正整数
                sign:
                  type: string
                  description: 签名串，请求参数的签名，服务平台通过它验证请求数据的合法性。
                  x-apifox-mock: '{{SIGN}}'
                iccid:
                  type: string
                  description: 卡片的ICCID
              x-apifox-orders:
                - appkey
                - timestamp
                - nonce
                - sign
                - iccid
              required:
                - appkey
                - timestamp
                - nonce
                - sign
                - iccid
            example:
              appkey: '{{APPKEY}}'
              timestamp: '{{TIMESTAMP}}'
              nonce: 67958
              sign: '{{SIGN}}'
              iccid: '89000123456789013802'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: 200：表示成功其他失败
                  message:
                    type: string
                    description: 成功或失败原因
                  data:
                    type: object
                    properties:
                      iccid:
                        type: string
                        description: iccid卡号
                      imsi:
                        type: string
                        description: IMSI号
                      activateDate:
                        type: string
                        description: 卡片激活时间
                      cardStatus:
                        type: string
                        description: >-
                          ACTIVATION_READY_NAME 可激活 NON_ACTIVATED_NAME 待激活
                          ACTIVATED_NAME 已激活 DEACTIVATED_NAME 已停用 
                      isRealName:
                        type: integer
                        description: 是否实名 0:未实名 1:已实名
                      monthRemainFlow:
                        type: number
                        description: 当前套餐剩余可用流量，单位MB
                        format: float64
                      monthUseFlow:
                        type: number
                        description: 当前套餐已用流量，单位MB
                        format: float64
                      remainFlowType:
                        type: number
                        description: 剩余流量类型 0 套餐流量 1池剩余流量
                        format: float64
                      productCode:
                        type: string
                        description: 产品编码
                      packageEndDate:
                        type: string
                        description: 当前套餐到期时间
                      dataFlow:
                        type: number
                        description: 卡片总流量（包括未使用套餐），单位MB
                        format: float64
                      remainFlow:
                        type: number
                        description: 卡片总剩余可用流量（包括未使用套餐），单位MB
                        format: float64
                      expectedEndDate:
                        type: string
                        description: 卡片预计到期时间（包括未使用套餐的有效期）
                      imeiPoolStatus:
                        type: integer
                        description: 'IMEI池锁状态 0 没有锁住 1 锁住暂停卡 '
                      imeiPoolUnlockCount:
                        type: integer
                        description: IMEI池已解锁次数
                      isIMEIPool:
                        type: integer
                        description: 是否归属池 0 卡未归属池 1 卡归属池 2 卡临时归属池
                      network:
                        type: string
                        description: 当前网络，同“切换卡片的运营商”接口network字段
                      totalUseFlow:
                        type: number
                        description: 卡片已使用总流量（包括已达量的套餐及当前套餐的用量） - 暂时不精准
                        format: float64
                      packageCode:
                        type: string
                        description: 卡片当前使用的系统套餐简码
                      packageKind:
                        type: integer
                        description: 套餐类型 0-限量套餐 1-限时套餐 2-限时限速套餐
                      eid:
                        type: string
                        description: eSIM 卡号
                      remark:
                        type: string
                        description: 当前客户的备注
                      imei:
                        type: string
                        description: IMEI
                    description: 返回数据
                    x-apifox-orders:
                      - iccid
                      - eid
                      - imsi
                      - imei
                      - activateDate
                      - cardStatus
                      - isRealName
                      - monthRemainFlow
                      - monthUseFlow
                      - remainFlowType
                      - productCode
                      - packageEndDate
                      - dataFlow
                      - remainFlow
                      - expectedEndDate
                      - imeiPoolStatus
                      - imeiPoolUnlockCount
                      - isIMEIPool
                      - network
                      - totalUseFlow
                      - packageCode
                      - packageKind
                      - remark
                    required:
                      - iccid
                      - imsi
                      - activateDate
                      - cardStatus
                      - isRealName
                      - monthRemainFlow
                      - monthUseFlow
                      - remainFlowType
                      - productCode
                      - dataFlow
                      - remainFlow
                      - expectedEndDate
                      - imeiPoolStatus
                      - imeiPoolUnlockCount
                      - isIMEIPool
                      - network
                      - totalUseFlow
                      - packageCode
                      - packageKind
                      - eid
                      - remark
                      - imei
                    nullable: true
                required:
                  - code
                  - message
                  - data
                x-apifox-orders:
                  - code
                  - message
                  - data
              example:
                code: '200'
                data:
                  activateDate: '2024-01-08 15:05:19'
                  cardStatus: NON_ACTIVATED_NAME
                  dataFlow: 410
                  eid: ''
                  iccid: '89852240400014306175'
                  imei: '356731102212126'
                  imeiPoolStatus: 0
                  imeiPoolUnlockCount: 0
                  imsi: '454030226105036'
                  isIMEIPool: 0
                  isRealName: 1
                  memo: abc
                  monthRemainFlow: 20
                  monthUseFlow: 0
                  network: ''
                  packageCode: GJ-LLB-20M-360D-LTCSCP-2022102899F1E1EF
                  packageKind: 0
                  productCode: 1GJDXLLBCP20210204105313
                  remainFlow: 410
                  remainFlowType: 0
                  totalUseFlow: 402.77
                message: success
          headers: {}
          x-apifox-name: 成功
      security: []
      x-apifox-folder: API接口/卡业务接口
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/2330898/apis/api-63600559-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://oapi.eiotclub.com
    description: 生产环境
security: []

```