说明

SIM卡配置的字段请查看字段说明

列表查询

接口说明

根据查询条件查询SIM卡配置列表。

接口版本

v1

接口地址

/api-web-v1/phoneConfigs

请求方法

GET

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述	默认	示例
query	label	string	false	模糊查询字段		phone
query	search	string	false	模糊查询值		15258284638
query	time	string	false	时间范围查询字段,必须是SIM卡配置字段中的时间或时间戳字段名，例如createdAt,updatedAt		createdAt
query	range	string[] or string	false	时间范围，开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳		2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z
query	page	number	false	分页第几页	1
query	limit	number	false	单页几条数据	10
query	sort	string	false	根据哪个字段排序	_id	-createdAt
query	select	string	false	只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加-
query	autopopulate	boolean	false	自动关联数据，部分字段自动关联关系表查询，设置这个值可开关自动联表查询	true	false
query	populate	string	false	指定关联表查询,查询多个关联表用逗号分隔		control

请求参数举例

注意

GET请求所有参数类型都会变成string拼接在url上面，文档为了表述清晰，将示例结构以json格式编写

{
  "page":"1",
  "limit":"10",
  "sort":"-createdAt",
  "autopopulate":"false"
}

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	True	返回数据
-total	number	False	SIM卡配置总条数
-rows	array	False	当前返回的SIM卡配置对象列表

返回参数举例

{
  "code": 0,
  "data": {
    "total": 1,
    "rows": [
      {
        "smsType": false,
        "_id": "62ce96078c0c73bab42aaa49",
        "simType": 0,
        "phoneType": "86",
        "control": "5dc90d293e60a7001c3eedb9",
        "icCid": "22",
        "phone": "15258284638",
        "activationTime": "2022-07-12T16:00:00.000Z",
        "expirationTime": "2022-08-30T16:00:00.000Z",
        "creator": {
          "_id": "5da855b71816bc001be72f4b",
          "trueName": "王宾宾",
          "username": "15258284638"
        },
        "createdAt": "2022-07-13T09:53:11.697Z",
        "updatedAt": "2022-07-13T09:53:11.697Z",
        "__v": 0
      }
    ]
  }
}

在线调试 (opens new window)

查询SIM卡配置ID

接口说明

根据SIM卡配置ID查询SIM卡配置

接口版本

v1

接口地址

/api-v1/phoneConfigs/:id

请求方法

GET

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
params	id	string	True	SIM卡配置ID

请求参数举例

注意

GET请求所有参数类型都会拼接在url上面，文档为了表述清晰，将示例结构以json格式编写

{
  "_id": "62ce96078c0c73bab42aaa49"
}

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	false	返回SIM卡配置信息

返回参数举例

{
  "code": 0,
  "data": {
    "smsType": false,
    "_id": "62ce96078c0c73bab42aaa49",
    "simType": 0,
    "phoneType": "86",
    "control": "5dc90d293e60a7001c3eedb9",
    "icCid": "22",
    "phone": "15258284638",
    "activationTime": "2022-07-12T16:00:00.000Z",
    "expirationTime": "2022-08-30T16:00:00.000Z",
    "creator": {
      "_id": "5da855b71816bc001be72f4b",
      "trueName": "王宾宾",
      "username": "15258284638"
    },
    "createdAt": "2022-07-13T09:53:11.697Z",
    "updatedAt": "2022-07-13T09:53:11.697Z",
    "__v": 0
  }
}

在线调试 (opens new window)

新建

接口说明

新建一个SIM卡配置。

接口版本

v1

接口地址

/api-v1/phoneConfigs

请求方法

POST

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
body	-	Object	True	SIM卡配置对象字段说明

请求参数举例

{
  "smsType": false,
  "simType": 0,
  "phoneType": "86",
  "control": "5dc90d293e60a7001c3eedb9",
  "icCid": "22",
  "phone": "15258284638",
  "activationTime": "2022-07-12T16:00:00.000Z",
  "expirationTime": "2022-08-30T16:00:00.000Z",
  "creator": "5da855b71816bc001be72f4b"
}

// Make sure to add code blocks to your code group

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	True	返回创建的对象

返回参数举例

  {
    "smsType": false,
    "_id": "62ce96078c0c73bab42aaa49",
    "simType": 0,
    "phoneType": "86",
    "control": "5dc90d293e60a7001c3eedb9",
    "icCid": "22",
    "phone": "15258284638",
    "activationTime": "2022-07-12T16:00:00.000Z",
    "expirationTime": "2022-08-30T16:00:00.000Z",
    "creator": {
      "_id": "5da855b71816bc001be72f4b",
      "trueName": "王宾宾",
      "username": "15258284638"
    },
    "createdAt": "2022-07-13T09:53:11.697Z",
    "updatedAt": "2022-07-13T09:53:11.697Z",
    "__v": 0
  }

编辑

接口说明

修改SIM卡配置

接口版本

v1

接口地址

/api-v1/phoneConfigs/:id

请求方法

PUT

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
params	id	string	True	修改的SIM卡配置ID
body	-	Object	True	SIM卡配置对象字段说明

请求参数举例

{
  "phone": "15258284638",
}

// Make sure to add code blocks to your code group

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	True	返回创建的对象

返回参数举例

{
  "code": 0,
  "data": {
    "smsType": false,
    "_id": "62ce96078c0c73bab42aaa49",
    "simType": 0,
    "phoneType": "86",
    "control": "5dc90d293e60a7001c3eedb9",
    "icCid": "22",
    "phone": "15258284638",
    "activationTime": "2022-07-12T16:00:00.000Z",
    "expirationTime": "2022-08-30T16:00:00.000Z",
    "creator": {
      "_id": "5da855b71816bc001be72f4b",
      "trueName": "王宾宾",
      "username": "15258284638"
    },
    "createdAt": "2022-07-13T09:53:11.697Z",
    "updatedAt": "2022-07-13T09:53:11.697Z",
    "__v": 0
  }
}

删除

接口说明

删除一个SIM卡配置。

接口版本

v1

接口地址

/api-v1/phoneConfigs/:id

请求方法

DELETE

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
params	id	string	True	删除的SIM卡配置ID

请求参数举例

只需发送删除SIM卡配置的ID

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
message	string	false	成功删除返回complete

返回参数举例

{
    "code": 0,
    "message": "complete"
}

此接口需实际SIM卡配置。文档不提供删除在线调试