1. 概览

CTExcel物联网平台对外能力接口文档

1.1. 版本信息

版本 : 1.0

1.2. URI scheme

域名 : localhost:5555
基础路径 : /

1.3. 标签

  • IOT接口认证 : Iot Auth Controller

  • SIM卡信息 : Sim Card Info Controller

  • SIM卡管理 : Mts Sim Card Controller

  • 事件管理 : Event Manager Controller

  • 使用量信息 : Usage Data Controller

  • 卡信息查询(聚合) : Iot Api Controller

  • 流量控制规则 : Traffic Rule Controller

  • 消息处理 : Process Messages Controller

  • 触发器管理 : Trigger Package Controller

  • 诊断 : Diagnostics Controller

  • 运营商信息 : Operator Info Controller

  • 限制规则管理 : Restriction Rule Controller

2. 资源

2.1. IOT接口认证

Iot Auth Controller

2.1.1. IOT接口令牌获取

POST /getToken
说明

令牌认证方式方式:IOT接口令牌获取后,在调用后续接口时需要将返回的TOKEN以拼接方式至于请求头中的Authorization字段中,令牌有效时间为5分钟,示例:Authorization Bearer XXXXXXXXXX

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

systemUserDto
必填

systemUserDto

SystemUserDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«TokenInfo»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/getToken
请求 header
"string"
请求 body
{
  "pwd" : "Smhe#4Lg!V4e6k6i",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "username" : "F8zcAkfXl"
}
HTTP响应示例
响应 200
{
  "data" : {
    "token" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2. SIM卡信息

Sim Card Info Controller

2.2.1. SIM卡状态变更

POST /api/v3/changeSimStatus
说明

SIM卡状态变更

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

changeSimStatusDto
必填

changeSimStatusDto

sim卡状态变更dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«RequestSubscriptionStatusChangeData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/changeSimStatus
请求 header
"string"
请求 body
{
  "range" : 1,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resource" : {
    "id" : "454310900000001",
    "type" : "imsi"
  },
  "status" : "Deactivated"
}
HTTP响应示例
响应 200
{
  "data" : {
    "requestSubscriptionStatusChangeResponse" : {
      "serviceRequestId" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.2. 批量SIM卡状态变更

POST /api/v3/changeSimStatusBatch
说明

批量SIM卡状态变更

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

sim卡状态批量变更dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«RequestSubscriptionStatusChangeBatchData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/changeSimStatusBatch
请求 header
"string"
请求 body
{
  "additionalInfo" : "测试0614",
  "batchFile" : "测试batch",
  "customerNo" : "69000002",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resources" : {
    "id" : "454310900000193"
  },
  "subscriptionStatus" : "Activate"
}
HTTP响应示例
响应 200
{
  "data" : {
    "requestSubscriptionStatusChangeBatchResponse" : {
      "requestId" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.3. 清除批量SIM卡变更服务单

POST /api/v3/clearServiceChangeBatch
说明

清除批量SIM卡变更服务单

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

clearChangeServiceDto
必填

clearChangeServiceDto

ClearChangeServiceDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«RequestSubscriptionChangeBatchClearData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/clearServiceChangeBatch
请求 header
"string"
请求 body
{
  "batchNo" : "REQ200000193287",
  "customerNo" : "29000002",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "requestSubscriptionChangeBatchClearResponse" : {
      "requestId" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.4. 查询SIM卡状态变更结果

POST /api/v3/queryChangeSimStatus
说明

查询SIM卡状态变更结果

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

查询sim状态变更结果dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySubscriptionStatusChangeData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryChangeSimStatus
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "serviceRequestId" : "REQ200000091637"
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySubscriptionStatusChangeResponse" : {
      "completedDate" : "string",
      "serviceRequestId" : "string",
      "statusRequestResponse" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.5. 批量查询SIM卡状态变更结果

POST /api/v3/queryChangeSimStatusBatch
说明

批量查询SIM卡状态变更结果

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

批量查询SIM卡状态变更结果dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySubscriptionStatusChangeBatchData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryChangeSimStatusBatch
请求 header
"string"
请求 body
{
  "customerNo" : "29000002",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "request_id" : "REQ200000193287"
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySubscriptionStatusChangeBatchResponse" : {
      "changeBatchEntry" : {
        "errorCode" : "string",
        "imsi" : "string",
        "msisdn" : "string",
        "validationCode" : "string",
        "validationStatus" : "string"
      },
      "requestId" : "string",
      "requestStatus" : "string",
      "serviceRequestId" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.6. 查询企业订购包、订购包ID及合同ID

POST /api/v3/queryCompanyAllContract
说明

查询企业订购包、订购包ID及合同ID

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

companyAllContractDto
必填

companyAllContractDto

CompanyAllContractDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QueryAllContractSubscriptionPackagesData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryCompanyAllContract
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "queryAllContractSubscriptionPackagesResponse" : {
      "subscriptionPackage" : [ {
        "company" : "string",
        "description" : "string",
        "id" : "string",
        "serviceContractId" : "string",
        "triggerPackageNo" : "string"
      } ]
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.7. 查询企业订购包名称、描述及合同名称

POST /api/v3/queryCompanyPackageInfo
说明

查询企业订购包名称、描述及合同名称

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

companyPackageInfoDto
必填

companyPackageInfoDto

CompanyPackageInfoDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySubscriptionPackagesDataV2»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryCompanyPackageInfo
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySubscriptionPackagesResponse_v2" : {
      "subscriptionPackages" : {
        "serviceContract" : "string",
        "subscriptionPackageDescription" : "string",
        "subscriptionPackageName" : "string",
        "triggerPackageNo" : "string"
      }
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.8. 批量查询企业SIM卡及卡订购包信息

POST /api/v3/queryCompanyPackageInfoBatch
说明

批量查询企业SIM卡及卡订购包信息

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

companyPackageInfoBatchDto
必填

companyPackageInfoBatchDto

CompanyPackageInfoBatchDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySubscriptionsData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryCompanyPackageInfoBatch
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySubscriptionsResponse" : {
      "subscriptions" : {
        "subscription" : [ {
          "customerLabel" : "string",
          "imsi" : "string",
          "lastCountry" : "string",
          "lastData" : "string",
          "lastLocationUpdate" : "string",
          "lastNetworkActivity" : "string",
          "lastOperator" : "string",
          "lastPDPContext" : "string",
          "lastSMS" : "string",
          "msisdn" : "string",
          "subscriptionPackageName" : "string"
        } ]
      }
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.9. 查询企业历史SIM卡状态

POST /api/v3/queryEntHistorySimStatus
说明

企业所有SIM状态信息查询

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

查询企业历史SIM卡状态dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySubscriptionsStatusHistoryData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryEntHistorySimStatus
请求 header
"string"
请求 body
{
  "customerNo" : "69000002",
  "endDate" : "2021-06-26",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "startDate" : "2021-06-25"
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySubscriptionsStatusHistoryResponse" : {
      "aggregatedStatus" : [ {
        "aggregatedStatusVolume" : [ {
          "status" : "string",
          "statusVolume" : "string"
        } ],
        "aggregationDate" : "string"
      } ]
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.10. 查询批量订购包变更结果

POST /api/v3/queryPackageChangeBatch
说明

查询批量订购包变更结果

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

packageChangeDto
必填

packageChangeDto

PackageChangeDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySubscriptionPackageChangeBatchData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryPackageChangeBatch
请求 header
"string"
请求 body
{
  "batchNo" : "REQ200000193287",
  "customerNo" : "29000002",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySubscriptionPackageChangeBatchResponse" : {
      "changeBatchEntry" : {
        "errorCode" : "string",
        "imsi" : "string",
        "msisdn" : "string",
        "validationCode" : "string",
        "validationStatus" : "string"
      },
      "requestId" : "string",
      "requestStatus" : "string",
      "serviceRequestId" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.11. 查询批量SIM卡变更服务单状态

POST /api/v3/queryServiceChangeBatch
说明

查询批量SIM卡变更服务单状态

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

serviceChangeDto
必填

serviceChangeDto

ServiceChangeDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySubscriptionChangeBatchesData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryServiceChangeBatch
请求 header
"string"
请求 body
{
  "customerNo" : "69000004",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "requestType" : "changeSubscriptionStatus"
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySubscriptionChangeBatchesResponse" : {
      "pendingBatchRow" : [ {
        "additionalInfo" : "string",
        "batchFile" : "string",
        "detailedValidationStatus" : "string",
        "requestId" : "string",
        "requestStatus" : "string",
        "requestType" : "string",
        "serviceRequestId" : "string",
        "submitTime" : "string",
        "submitter" : "string",
        "validationStatus" : "string"
      } ]
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.12. SIM卡信息查询

POST /api/v3/querySimResource
说明

SIM卡信息查询

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simResourceDto
必填

simResourceDto

sim卡信息查询dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySimResourceData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/querySimResource
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resource" : {
    "id" : "8985231189450100000",
    "type" : "icc"
  }
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySimResourceResponse" : {
      "simResource" : { }
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.13. 批量SIM卡信息查询

POST /api/v3/querySimResourceBatch
说明

批量SIM卡信息查询

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simResourceBatchDto
必填

simResourceBatchDto

sim卡信息批量查询dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySimResourcesBatchData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/querySimResourceBatch
请求 header
"string"
请求 body
{
  "chunkSize" : 100,
  "range" : 3,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resource" : {
    "id" : "8985231189450100000",
    "type" : "icc"
  },
  "startNumber" : 0
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySimResourcesResponse" : {
      "simResource" : [ { } ]
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.14. SIM卡信息查询v2

POST /api/v3/querySimResourcev2
说明

SIM卡信息查询v2

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

unionSimInfoDto
必填

unionSimInfoDto

UnionSimInfoDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySimResourceV2Data»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/querySimResourcev2
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resource" : {
    "id" : "8985231189450100000",
    "type" : "icc"
  }
}
HTTP响应示例
响应 200
{
  "data" : {
    "querySimResourceResponse_v2" : {
      "simResource" : { }
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.15. SIM卡订购包切换

POST /api/v3/simOrderPackSwitch
说明

SIM卡订购包切换

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

sim卡订购包切换dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«RequestSubscriptionPackageChangeData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/simOrderPackSwitch
请求 header
"string"
请求 body
{
  "additionalInfo" : "41221321312",
  "batchFile" : "SI测试batch",
  "customerNo" : "69000004",
  "range" : "1",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resource" : {
    "id" : "454310900000191",
    "type" : "imsi"
  },
  "resources" : {
    "id" : "454310900000193"
  },
  "subscriptionPackage" : "CT_unique_ID_01_SP_20"
}
HTTP响应示例
响应 200
{
  "data" : {
    "requestSubscriptionPackageChangeResponse" : {
      "requestId" : "string",
      "serviceRequestId" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.16. 批量SIM卡订购包切换

POST /api/v3/simOrderPackSwitchBatch
说明

批量SIM卡订购包切换

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

sim卡订购包切换dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«RequestSubscriptionPackageChangeBatchData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/simOrderPackSwitchBatch
请求 header
"string"
请求 body
{
  "additionalInfo" : "41221321312",
  "batchFile" : "SI测试batch",
  "customerNo" : "69000004",
  "range" : "1",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resource" : {
    "id" : "454310900000191",
    "type" : "imsi"
  },
  "resources" : {
    "id" : "454310900000193"
  },
  "subscriptionPackage" : "CT_unique_ID_01_SP_20"
}
HTTP响应示例
响应 200
{
  "data" : {
    "requestSubscriptionPackageChangeBatchResponse" : {
      "requestId" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.2.17. SIM卡标签修改

POST /api/v3/updateCustomerLabel
说明

SIM卡标签修改

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

customerLabelDto
必填

customerLabelDto

CustomerLabelDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/updateCustomerLabel
请求 header
"string"
请求 body
{
  "customerLabel" : "SI Test",
  "range" : "1",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resource" : {
    "id" : "454310900000191",
    "type" : "imsi"
  }
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3. SIM卡管理

Mts Sim Card Controller

2.3.1. 添加属性值

POST /api/v2/addFieldValue
说明

添加属性值

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

fieldValueParam
必填

fieldValueParam

FieldValueParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CustomFieldResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/addFieldValue
请求 header
"string"
请求 body
{
  "id" : "[479]",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522,
  "value" : "[\"test\"]"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.2. 变更SIM卡状态

POST /api/v2/changeSimStatus
说明

变更SIM卡状态

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simStatusPamram
必填

simStatusPamram

SimStatusPamram

响应
HTTP代码 说明 类型

200

OK

通用返回对象«SimStatusResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/changeSimStatus
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522,
  "to_store" : true
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.3. 创建SIM卡属性

POST /api/v2/createSimField
说明

创建SIM卡属性

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

customFieldRequest
必填

customFieldRequest

CustomFieldRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CustomFieldResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/createSimField
请求 header
"string"
请求 body
{
  "custom_fields" : [ {
    "id" : 0,
    "name" : "test"
  } ],
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.4. 添加分组

POST /api/v2/createSimGroup
说明

添加分组

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simGroupParam
必填

simGroupParam

SimGroupParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CustomFieldResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/createSimGroup
请求 header
"string"
请求 body
{
  "action" : "add",
  "name" : "test",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "select_all" : true,
  "sim_file" : " ",
  "sim_items" : "[]",
  "type" : "list"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.5. 删除SIM卡属性

POST /api/v2/deleteSimField
说明

删除SIM卡属性

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

customFieldRequest
必填

customFieldRequest

CustomFieldRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CustomFieldResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/deleteSimField
请求 header
"string"
请求 body
{
  "custom_fields" : [ {
    "id" : 0,
    "name" : "test"
  } ],
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.6. 删除分组

POST /api/v2/deleteSimGroup
说明

删除分组

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

deleteSimGroupParam
必填

deleteSimGroupParam

DeleteSimGroupParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CustomFieldResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/deleteSimGroup
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_groups_id" : 1022
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.7. 停用SIM服务

POST /api/v2/disableSimService
说明

停用SIM服务

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

disableSimServiceParam
必填

disableSimServiceParam

DisableSimServiceParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«DisableSimServiceResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/disableSimService
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522,
  "sim_item_service_id" : 2345
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.8. 编辑SIM卡属性

POST /api/v2/editSimField
说明

编辑SIM卡属性

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

customFieldRequest
必填

customFieldRequest

CustomFieldRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CustomFieldResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/editSimField
请求 header
"string"
请求 body
{
  "custom_fields" : [ {
    "id" : 0,
    "name" : "test"
  } ],
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.9. 编辑分组

POST /api/v2/editSimGroup
说明

编辑分组

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

editSimGroupParam
必填

editSimGroupParam

EditSimGroupParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CustomFieldResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/editSimGroup
请求 header
"string"
请求 body
{
  "action" : "add",
  "name" : "test",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "select_all" : true,
  "sim_file" : " ",
  "sim_groups_id" : 1022,
  "sim_items" : "[]",
  "type" : "list"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.10. 启用SIM服务

POST /api/v2/enableSimService
说明

启用SIM服务

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

enableSimServiceParam
必填

enableSimServiceParam

EnableSimServiceParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«MtsEnableServicesData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/enableSimService
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "service_id" : 2345,
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "error" : {
      "message" : "string"
    },
    "sim_item_service_id" : "string",
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.11. 可用服务信息列表

POST /api/v2/getAvailableServices
说明

可用服务信息列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

avaliableServicesParam
必填

avaliableServicesParam

AvaliableServicesParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«MtsAvaliableServicesResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getAvailableServices
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "auto_attach" : true,
      "calendar_period" : true,
      "discount" : "string",
      "for_account" : "string",
      "id" : "string",
      "self_use" : true,
      "service" : {
        "agreement" : "string",
        "base_id" : "string",
        "base_service" : {
          "id" : "string",
          "key" : "string",
          "name" : "string",
          "parameters" : [ "string" ]
        },
        "billing_code" : "string",
        "charging_period" : "string",
        "charging_type" : "string",
        "client_name" : "string",
        "description" : "string",
        "duration" : "string",
        "ex_code" : "string",
        "id" : "string",
        "is_attached_to_regions" : true,
        "is_attached_to_roles" : true,
        "is_individual" : true,
        "name" : "string",
        "parameters" : {
          "cost_matrix" : {
            "string" : "string"
          },
          "session_rounding" : "string",
          "speed_limit" : "string",
          "volume" : "string"
        },
        "start_date" : "string",
        "tarif_object" : "string",
        "type" : "string"
      },
      "show_for_client" : true,
      "sim_count" : [ {
        "count" : "string",
        "status" : "string"
      } ]
    } ]
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.12. 通信平台信道列表

POST /api/v2/getChannels
说明

通信平台信道列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simGroupList
必填

simGroupList

SimGroupList

响应
HTTP代码 说明 类型

200

OK

通用返回对象«ChannelListResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getChannels
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "page" : 1,
  "per_page" : 3,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "id" : 0,
      "key" : "string",
      "name" : "string"
    } ],
    "paginator" : {
      "current_page" : 0,
      "from" : 0,
      "last_page" : 0,
      "per_page" : 0,
      "to" : 0,
      "total" : 0
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.13. 呼叫去向列表

POST /api/v2/getDirections
说明

呼叫去向列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simGroupList
必填

simGroupList

SimGroupList

响应
HTTP代码 说明 类型

200

OK

通用返回对象«DirectionListResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getDirections
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "page" : 1,
  "per_page" : 3,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "channel" : {
        "id" : 0,
        "key" : "string",
        "name" : "string"
      },
      "channel_id" : 0,
      "handler" : "string",
      "id" : 0,
      "name" : "string",
      "parent_id" : 0
    } ],
    "paginator" : {
      "current_page" : 0,
      "from" : 0,
      "last_page" : 0,
      "per_page" : 0,
      "to" : 0,
      "total" : 0
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.14. 获取分组列表

POST /api/v2/getGroupsList
说明

获取分组列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simGroupList
必填

simGroupList

SimGroupList

响应
HTTP代码 说明 类型

200

OK

通用返回对象«SimGroupListResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getGroupsList
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "page" : 1,
  "per_page" : 3,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "id" : "string",
      "name" : "string",
      "sim_count" : "string"
    } ],
    "paginator" : {
      "current_page" : 0,
      "from" : 0,
      "last_page" : 0,
      "per_page" : 0,
      "to" : 0,
      "total" : 0
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.15. SIM卡余额信息查询

POST /api/v2/getSimBalance
说明

SIM卡余额信息查询

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simBalanceParam
必填

simBalanceParam

SimBalanceParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«BalanceResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getSimBalance
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "amount" : "string",
    "amount_specified" : true,
    "unit_of_measure" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.16. 获取SIM卡设备名

POST /api/v2/getSimDevice
说明

获取SIM卡设备名

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simDeviceParam
必填

simDeviceParam

SimDeviceParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«MtsDeviceData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getSimDevice
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "sim" : {
      "apn" : "string",
      "device_name" : "string",
      "iccid" : "string",
      "id" : "string",
      "imei" : "string",
      "imsi" : "string",
      "mode" : "string",
      "msisdn" : "string",
      "pdp_context" : true,
      "tariff" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.17. 在SIM卡上启用的服务

POST /api/v2/getSimEnableServices
说明

在SIM卡上启用的服务

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simEnableServicesParam
必填

simEnableServicesParam

SimEnableServicesParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«MtsEnabledServiceData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getSimEnableServices
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "attach_time" : "string",
      "contract_service" : {
        "auto_attach" : true,
        "calendar_period" : true,
        "discount" : "string",
        "for_account" : "string",
        "id" : "string",
        "self_use" : true,
        "service" : {
          "agreement" : "string",
          "base_id" : "string",
          "base_service" : {
            "id" : "string",
            "key" : "string",
            "name" : "string",
            "parameters" : [ "string" ]
          },
          "billing_code" : "string",
          "charging_period" : "string",
          "charging_type" : "string",
          "client_name" : "string",
          "description" : "string",
          "duration" : "string",
          "ex_code" : "string",
          "id" : "string",
          "is_attached_to_regions" : true,
          "is_attached_to_roles" : true,
          "is_individual" : true,
          "name" : "string",
          "parameters" : {
            "cost_matrix" : {
              "string" : "string"
            },
            "session_rounding" : "string",
            "speed_limit" : "string",
            "volume" : "string"
          },
          "start_date" : "string",
          "tarif_object" : "string",
          "type" : "string"
        },
        "show_for_client" : true,
        "sim_count" : [ {
          "count" : "string",
          "status" : "string"
        } ]
      },
      "id" : "string",
      "period_end" : "string",
      "sim_count" : "string",
      "status" : "string",
      "value" : "string"
    } ]
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.18. 获取由SIM卡或平台生成的事件记录

POST /api/v2/getSimEvents
说明

获取由SIM卡或平台生成的事件记录

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simEventParam
必填

simEventParam

MtsSimEventParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«MtsSimEventData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getSimEvents
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "page" : 1,
  "per_page" : 3,
  "query" : {
    "event_time" : {
      "type" : "period_days",
      "value" : "7"
    },
    "type" : {
      "type" : "eq",
      "value" : "channel_block"
    },
    "user_id" : {
      "type" : "null",
      "value" : "not_processed"
    }
  },
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "description" : "string",
      "event_time" : "string",
      "id" : "string",
      "processed_by" : [ "string" ],
      "type" : "string",
      "updated_at" : "string"
    } ],
    "paginator" : {
      "current_page" : "string",
      "from" : "string",
      "last_page" : "string",
      "per_page" : "string",
      "to" : "string",
      "total" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.19. 获取自定义属性列表

POST /api/v2/getSimFields
说明

获取自定义属性列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

customerFieldParam
必填

customerFieldParam

CustomerFieldParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«GetCustmFields»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getSimFields
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "id" : 0,
      "name" : "test"
    } ]
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.20. 获取SIM卡位置信息

POST /api/v2/getSimLocation
说明

获取SIM卡位置信息

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simLocationParam
必填

simLocationParam

SimLocationParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«MtsLocation»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getSimLocation
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "date" : "string",
    "parameters" : {
      "dt" : "string",
      "latitude" : "string",
      "longitude" : "string",
      "precision" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.21. 获取SIM卡的套餐和服务的费用

POST /api/v2/getSimServices
说明

获取SIM卡的套餐和服务的费用

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simServiceParam
必填

simServiceParam

SimServiceParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«SimServiceResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getSimServices
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.22. SIM卡商城列表

POST /api/v2/getStoreSimList
说明

SIM卡商城列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

storeSimListParam
必填

storeSimListParam

StoreSimListParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«StoreSimListResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getStoreSimList
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "order" : {
    "created_at" : "desc"
  },
  "page" : 1,
  "per_page" : 3,
  "query" : {
    "search" : {
      "type" : "scoped",
      "value" : "89701010065090715184"
    },
    "state" : {
      "type" : "eq",
      "value" : "first_block"
    }
  },
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "activated_at" : "string",
      "attach_notify" : true,
      "contract_id" : "string",
      "control_name" : "string",
      "counters" : [ {
        "amount" : 0,
        "charge" : 0,
        "direction_id" : 0,
        "period_end" : "string",
        "rater_type" : "string"
      } ],
      "custom_fields" : [ {
        "custom_field_id" : 0,
        "value" : "string"
      } ],
      "group_names" : [ "string" ],
      "has_locked_directions" : true,
      "id" : 0,
      "imei_lock" : {
        "has_locked_directions" : true,
        "imei" : "string",
        "locked_directions" : [ "string" ],
        "status" : "string",
        "triggered" : true,
        "type" : "string"
      },
      "name" : "string",
      "net_check" : "string",
      "quote_names" : [ "string" ],
      "sim" : {
        "apn" : "string",
        "device_name" : "string",
        "ext_id" : "string",
        "iccid" : "string",
        "id" : 0,
        "imei" : "string",
        "imsi" : "string",
        "last_ip" : "string",
        "mode" : "string",
        "msisdn" : "string",
        "pdp_context" : true,
        "tariff" : 0
      },
      "state" : "string",
      "status" : "string",
      "type" : "string"
    } ],
    "paginator" : {
      "current_page" : 0,
      "from" : 0,
      "last_page" : 0,
      "per_page" : 0,
      "to" : 0,
      "total" : 0
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.23. 获取SIM卡详情

POST /api/v2/querySimDetail
说明

获取SIM卡详情

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simDetailParam
必填

simDetailParam

SimDetailParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«MtsSimDetail»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/querySimDetail
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "activated_at" : "string",
    "attach_notify" : true,
    "contract_id" : "string",
    "control_name" : "string",
    "counters" : [ {
      "amount" : "string",
      "charge" : "string",
      "direction_id" : "string",
      "period_end" : "string"
    } ],
    "created_at" : "string",
    "custom_fields" : [ {
      "custom_field_id" : "string",
      "value" : "string"
    } ],
    "group_packet" : {
      "attach_time" : "string",
      "contract_service" : {
        "auto_attach" : true,
        "calendar_period" : true,
        "discount" : "string",
        "for_account" : "string",
        "id" : "string",
        "self_use" : true,
        "service" : {
          "agreement" : "string",
          "base_id" : "string",
          "base_service" : {
            "id" : "string",
            "key" : "string",
            "name" : "string",
            "parameters" : [ "string" ]
          },
          "billing_code" : "string",
          "charging_period" : "string",
          "charging_type" : "string",
          "client_name" : "string",
          "description" : "string",
          "duration" : "string",
          "ex_code" : "string",
          "id" : "string",
          "is_attached_to_regions" : true,
          "is_attached_to_roles" : true,
          "is_individual" : true,
          "name" : "string",
          "parameters" : {
            "cost_matrix" : {
              "string" : "string"
            },
            "session_rounding" : "string",
            "speed_limit" : "string",
            "volume" : "string"
          },
          "start_date" : "string",
          "tarif_object" : "string",
          "type" : "string"
        },
        "show_for_client" : true,
        "sim_count" : [ {
          "count" : "string",
          "status" : "string"
        } ]
      },
      "id" : "string",
      "period_end" : "string",
      "sim_count" : "string",
      "status" : "string",
      "value" : "string"
    },
    "has_locked_directions" : true,
    "id" : "string",
    "locked_directions" : [ 0 ],
    "name" : "string",
    "net_check" : "string",
    "quote_names" : [ "string" ],
    "sim" : {
      "apn" : "string",
      "device_name" : "string",
      "iccid" : "string",
      "id" : "string",
      "imei" : "string",
      "imsi" : "string",
      "mode" : "string",
      "msisdn" : "string",
      "pdp_context" : true,
      "tariff" : "string"
    },
    "state" : "string",
    "status" : "string",
    "type" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.24. 获取SIM卡列表

POST /api/v2/querySimList
说明

获取SIM卡列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simsParam
必填

simsParam

SimCardsDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«SimsData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/querySimList
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "order" : {
    "id" : "asc"
  },
  "page" : 1,
  "per_page" : 3,
  "query" : {
    "search" : {
      "type" : "scoped",
      "value" : "89701010065090715184"
    },
    "state" : {
      "type" : "eq",
      "value" : "normal"
    },
    "status" : {
      "type" : "eq",
      "value" : "active"
    }
  },
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "attach_notify" : true,
      "contract_id" : "string",
      "control_name" : "string",
      "counters" : [ {
        "amount" : "string",
        "charge" : "string",
        "direction_id" : "string",
        "period_end" : "string"
      } ],
      "custom_fields" : [ {
        "custom_field_id" : "string",
        "value" : "string"
      } ],
      "has_locked_directions" : true,
      "id" : "string",
      "imei_lock" : {
        "control_name" : "string",
        "has_locked_directions" : true,
        "imei" : "string",
        "locked_directions" : [ 0 ],
        "status" : "string",
        "triggered" : true,
        "type" : "string"
      },
      "name" : "string",
      "net_check" : "string",
      "quote_names" : [ "string" ],
      "sim" : {
        "apn" : "string",
        "device_name" : "string",
        "iccid" : "string",
        "id" : "string",
        "imei" : "string",
        "imsi" : "string",
        "mode" : "string",
        "msisdn" : "string",
        "pdp_context" : true,
        "tariff" : "string"
      },
      "state" : "string",
      "status" : "string",
      "type" : "string"
    } ],
    "paginator" : {
      "current_page" : "string",
      "from" : "string",
      "last_page" : "string",
      "per_page" : "string",
      "to" : "string",
      "total" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.3.25. 限制SIM卡数据传递信道的呼叫去向

POST /api/v2/updateSimBlockage
说明

限制SIM卡数据传递信道的呼叫去向

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

simBlockageParam
必填

simBlockageParam

SimBlockageParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«SimBlockageReponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/updateSimBlockage
请求 header
"string"
请求 body
{
  "locked_directions" : "[]",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.4. 事件管理

Event Manager Controller

2.4.1. 创建短信/邮件通知订阅

POST /api/v2/createEmailSubscription
说明

创建短信/邮件通知订阅

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

CreateEmailSubscriptionDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CreateEmailSubscriptionData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/createEmailSubscription
请求 header
"string"
请求 body
{
  "email_send" : false,
  "email_send_adresses" : "[]",
  "email_send_days" : "weekdays",
  "email_send_periodicity" : "half_hour",
  "email_send_time_period" : "02:00-23:59",
  "events" : "[ \"info_limit\", \"block_limit\"]",
  "name" : "евв",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sms_send" : true,
  "sms_send_days" : "weekdays",
  "sms_send_numbers" : "[ \"76787687866\"]",
  "sms_send_periodicity" : "half_hour",
  "sms_send_time_period" : "04:00-23:59"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.4.2. 创建WebHook通知订阅

POST /api/v2/createWebSubscription
说明

创建WebHook通知订阅

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

CreateWebSubscriptionDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CreateWebSubscriptionData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/createWebSubscription
请求 header
"string"
请求 body
{
  "attempts" : "10",
  "events" : "[ \"info_limit\", \"block_limit\"]",
  "name" : "евв",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "url" : "http://www.baicu.com",
  "web_hook_key" : "ywuwwwwhwwhw"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.4.3. 删除短信/邮件通知订阅

POST /api/v2/deleteEmailSubscription
说明

删除短信/邮件通知订阅

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

DeleteEmailSubscriptionDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«DeleteEmailSubscriptionData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/deleteEmailSubscription
请求 header
"string"
请求 body
{
  "events_subscriptions_id" : 10,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.4.4. 删除WebHook通知订阅

POST /api/v2/deleteWebSubscription
说明

删除WebHook通知订阅

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

DeleteWeblSubscriptionDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«DeleteWebSubscriptionData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/deleteWebSubscription
请求 header
"string"
请求 body
{
  "events_subscriptions_id" : 100,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.4.5. 编辑短信/邮件通知订阅

POST /api/v2/editEmailSubscription
说明

编辑短信/邮件通知订阅

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

EditEmailSubscriptionDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«EditEmailSubscriptionData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/editEmailSubscription
请求 header
"string"
请求 body
{
  "email_send" : false,
  "email_send_adresses" : "[]",
  "email_send_days" : "weekdays",
  "email_send_periodicity" : "half_hour",
  "email_send_time_period" : "02:00-23:59",
  "events" : "[ \"info_limit\", \"block_limit\"]",
  "events_subscriptions_id" : 10,
  "name" : "евв",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sms_send" : true,
  "sms_send_days" : "weekdays",
  "sms_send_numbers" : "[ \"76787687866\"]",
  "sms_send_periodicity" : "half_hour",
  "sms_send_time_period" : "04:00-23:59"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.4.6. 编辑WebHook通知订阅

POST /api/v2/editWebSubscription
说明

编辑WebHook通知订阅

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

EditWebSubscriptionDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«EditWebSubscriptionData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/editWebSubscription
请求 header
"string"
请求 body
{
  "attempts" : "10",
  "events" : "[ \"info_limit\", \"block_limit\"]",
  "events_subscriptions_id" : 100,
  "name" : "евв",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "url" : "http://www.baicu.com",
  "web_hook_key" : "ywuwwwwhwwhw"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.4.7. 获取短信/邮件通知订阅列表

POST /api/v2/queryEmailSubscriptions
说明

获取短信/邮件通知订阅列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

QueryEmailSubscriptionsDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QueryEmailSubscriptionsData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/queryEmailSubscriptions
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "items" : [ {
        "email_send" : true,
        "email_send_days" : "string",
        "email_send_numbers" : [ "string" ],
        "email_send_periodicity" : "string",
        "email_send_time_period" : "string",
        "events" : [ "string" ],
        "id" : 0,
        "name" : "string",
        "sms_send" : true,
        "sms_send_days" : "string",
        "sms_send_numbers" : [ "string" ],
        "sms_send_periodicity" : "string",
        "sms_send_time_period" : "string",
        "user" : {
          "dashboard_id" : 0,
          "email" : "string",
          "id" : 0,
          "ip_rule_id" : 0,
          "is_admin" : true,
          "is_attached_to_regions" : true,
          "is_united" : true,
          "login" : "string",
          "name" : "string",
          "parent_id" : 0,
          "phone" : "string",
          "role_id" : "string",
          "should_password_change" : true,
          "user_type" : 0
        }
      } ]
    },
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.4.8. 获取事件列表

POST /api/v2/queryEvents
说明

获取事件列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

QueryEventsDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QueryEventsData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/queryEvents
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "page" : 1,
  "per_page" : 3,
  "query" : {
    "event_time" : {
      "type" : "period_days",
      "value" : "7"
    },
    "type" : {
      "type" : "eq",
      "value" : "channel_block"
    },
    "user_id" : {
      "type" : "null",
      "value" : "not_processed"
    }
  },
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "items" : [ {
        "description" : "string",
        "event_time" : "string",
        "id" : 0,
        "processed_by" : [ "string" ],
        "sim_item" : {
          "attach_notify" : true,
          "contract_id" : "string",
          "control_name" : "string",
          "counters" : [ {
            "amount" : "string",
            "charge" : "string",
            "direction_id" : "string",
            "period_end" : "string"
          } ],
          "custom_fields" : [ {
            "custom_field_id" : "string",
            "value" : "string"
          } ],
          "has_locked_directions" : true,
          "id" : "string",
          "imei_lock" : {
            "control_name" : "string",
            "has_locked_directions" : true,
            "imei" : "string",
            "locked_directions" : [ 0 ],
            "status" : "string",
            "triggered" : true,
            "type" : "string"
          },
          "name" : "string",
          "net_check" : "string",
          "quote_names" : [ "string" ],
          "sim" : {
            "apn" : "string",
            "device_name" : "string",
            "iccid" : "string",
            "id" : "string",
            "imei" : "string",
            "imsi" : "string",
            "mode" : "string",
            "msisdn" : "string",
            "pdp_context" : true,
            "tariff" : "string"
          },
          "state" : "string",
          "status" : "string",
          "type" : "string"
        },
        "type" : "string",
        "updated_at" : "string"
      } ],
      "paginator" : {
        "current_page" : "string",
        "from" : "string",
        "last_page" : "string",
        "per_page" : "string",
        "to" : "string",
        "total" : "string"
      }
    },
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.4.9. 获取WebHook通知订阅列表

POST /api/v2/queryWebSubscriptions
说明

获取WebHook通知订阅列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

QueryWebSubscriptionsDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QueryWebSubscriptionsData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/queryWebSubscriptions
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "items" : [ {
        "attempts" : "string",
        "events" : [ "string" ],
        "id" : 0,
        "name" : "string",
        "url" : "string",
        "user" : {
          "dashboard_id" : 0,
          "email" : "string",
          "id" : 0,
          "ip_rule_id" : 0,
          "is_admin" : true,
          "is_attached_to_regions" : true,
          "is_united" : true,
          "login" : "string",
          "name" : "string",
          "parent_id" : 0,
          "phone" : "string",
          "role_id" : "string",
          "should_password_change" : true,
          "user_type" : 0
        },
        "web_hook_key" : "string"
      } ]
    },
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.5. 使用量信息

Usage Data Controller

2.5.1. 企业历史累计每天使用量查询接口

POST /api/v3/averageTrafficUsageHistory
说明

企业过往最长距离当前366内每天的GRPS流量使用量情况以及当天的激活卡数量

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

trafficDto
必填

trafficDto

TrafficUsageHistoryParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/averageTrafficUsageHistory
请求 header
"string"
请求 body
{
  "customerNo" : "69000002",
  "endDate" : "2021-05-14",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "startDate" : "2021-05-20"
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.5.2. 企业当天累计使用量查询

POST /api/v3/queryFirmUsageInfo
说明

根据企业编号查询企业当天的累积使用量情况

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

trafficDto
必填

trafficDto

AggregatedTrafficParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryFirmUsageInfo
请求 header
"string"
请求 body
{
  "aggregateOn" : "APN",
  "customerNo" : "69000023",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.5.3. 企业当天累计使用量查询v2

POST /api/v3/queryFirmUsageInfoV2
说明

根据企业编号查询企业当天的累积使用量情况v2

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

trafficDto
必填

trafficDto

AggregatedTrafficParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/queryFirmUsageInfoV2
请求 header
"string"
请求 body
{
  "aggregateOn" : "APN",
  "customerNo" : "69000023",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.5.4. SIM卡使用量查询

POST /api/v3/querySimUsageInfo
说明

查询SIM卡当天的网络使用量情况

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

trafficDto
必填

trafficDto

SubscriptionTrafficDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/querySimUsageInfo
请求 header
"string"
请求 body
{
  "range" : "1",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resource" : {
    "id" : "454310900000495",
    "type" : "imsi"
  }
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.5.5. 历史累计所属国使用量查询接口

POST /api/v3/topCountryTrafficUsage
说明

根据企业编号和过往最长31天内的所属最多250个国家的产生的流量或短信使用量

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

trafficDto
必填

trafficDto

TopCountryTrafficUsageParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/topCountryTrafficUsage
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "endDate" : "2021-09-01",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resultLimit" : "3",
  "startDate" : "2021-09-01",
  "trafficType" : "SMS"
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.5.6. 企业历史累计最高使用量排行查询接口

POST /api/v3/topSubscriberTrafficUsage
说明

根据企业编号和过往最长31天内的最多使用量的93张卡的流量或短信使用量

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

trafficDto
必填

trafficDto

TopCountryTrafficUsageParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/topSubscriberTrafficUsage
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "endDate" : "2021-09-01",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "resultLimit" : "3",
  "startDate" : "2021-09-01",
  "trafficType" : "SMS"
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.5.7. 企业历史累计使用量查询

POST /api/v3/trafficUsageHistory
说明

根据企业编号和过往365天内每天的累积流量和短信使用情况

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

trafficDto
必填

trafficDto

TrafficUsageHistoryParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/trafficUsageHistory
请求 header
"string"
请求 body
{
  "customerNo" : "69000002",
  "endDate" : "2021-05-14",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "startDate" : "2021-05-20"
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.5.8. 使用量数据下载

POST /api/v3/usageDataDownload
说明

该企业的全部卡使用量文件大小和文件下载路径

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

trafficDto
必填

trafficDto

TrafficDto«TrafficUsageHistoryParam»

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/usageDataDownload
请求 header
"string"
请求 body
{
  "query" : {
    "customerNo" : "69000002",
    "endDate" : "2021-05-14",
    "requestId" : "20210712134068895456",
    "requestTime" : "2021-07-12 13:40:68",
    "startDate" : "2021-05-20"
  },
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.6. 卡信息查询(聚合)

Iot Api Controller

2.6.1. IOT聚合sim卡状态变更

POST /api/v0/changeStatus
说明

IOT聚合sim卡状态变更

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

unionChangeStatusRequest
必填

unionChangeStatusRequest

UnionChangeStatusRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v0/changeStatus
请求 header
"string"
请求 body
{
  "iccid" : "string",
  "requestId" : "string",
  "requestTime" : "string",
  "status" : "string"
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.6.2. IOT聚合sim卡余额查询

POST /api/v0/getBalance
说明

IOT聚合sim卡余额查询

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

UnionGetSimByIccidRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«UnionSimBalance»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v0/getBalance
请求 header
"string"
请求 body
{
  "iccid" : "string",
  "requestId" : "string",
  "requestTime" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "amount" : 0.0,
    "amount_specified" : true,
    "unit_of_measure" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.6.3. IOT聚合sim卡状态查询

POST /api/v0/getSimStatus
说明

IOT聚合sim卡状态查询

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

UnionGetSimByIccidRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«UnionSimStatus»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v0/getSimStatus
请求 header
"string"
请求 body
{
  "iccid" : "string",
  "requestId" : "string",
  "requestTime" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.6.4. IOT聚合单卡信息查询

POST /api/v0/iccidInfo
说明

IOT聚合单卡信息查询UnionGetSimByIccidRequest

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

UnionGetSimByIccidRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«UnionSimInfo»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v0/iccidInfo
请求 header
"string"
请求 body
{
  "iccid" : "string",
  "requestId" : "string",
  "requestTime" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "activation_date" : "string",
    "customerNo" : "string",
    "group_packet" : [ {
      "eff_date" : "string",
      "exp_date" : "string",
      "key" : "string",
      "package_code" : "string",
      "package_name" : "string",
      "status" : "string",
      "total_value" : "string",
      "value" : "string"
    } ],
    "iccid" : "string",
    "imei" : "string",
    "imsi" : "string",
    "ip_address" : "string",
    "msisdn" : "string",
    "productOfferName" : "string",
    "state" : "string",
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.6.5. IOT聚合sim卡位置信息查询

POST /api/v0/locationInfo
说明

IOT聚合sim卡位置信息查询

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

unionGetSimByIccidRequest
必填

unionGetSimByIccidRequest

UnionGetSimByIccidRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«UnionSimLocation»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v0/locationInfo
请求 header
"string"
请求 body
{
  "iccid" : "string",
  "requestId" : "string",
  "requestTime" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "latitude" : "string",
    "longitude" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.6.6. IOT聚合开启订购包

POST /api/v0/openPackge
说明

IOT聚合开启订购包

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

unionOpenPackgeRequest
必填

unionOpenPackgeRequest

UnionOpenPackgeRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v0/openPackge
请求 header
"string"
请求 body
{
  "iccid" : "string",
  "packageResource" : {
    "type" : "string",
    "value" : "string"
  },
  "requestId" : "string",
  "requestTime" : "string"
}
HTTP响应示例
响应 200
{
  "data" : "object",
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.6.7. 查询SIM卡可订购包列表

POST /api/v0/queryAllPackages
说明

查询SIM卡可订购包列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

UnionQueryAllPackagesRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«UnionPackages»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v0/queryAllPackages
请求 header
"string"
请求 body
{
  "customerNo" : "string",
  "iccid" : "string",
  "requestId" : "string",
  "requestTime" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "items" : [ {
        "description" : "string",
        "packageId" : "string"
      } ]
    },
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.6.8. IOT聚合单卡套餐查询

POST /api/v0/serviceInfo
说明

IOT聚合单卡套餐查询

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

UnionGetSimByIccidRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«UnionSimPlans»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v0/serviceInfo
请求 header
"string"
请求 body
{
  "iccid" : "string",
  "requestId" : "string",
  "requestTime" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "eff_date" : "string",
      "exp_date" : "string",
      "key" : "string",
      "package_code" : "string",
      "package_name" : "string",
      "status" : "string",
      "total_value" : "string",
      "value" : "string"
    } ]
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.6.9. IOT聚合单卡用量查询

POST /api/v0/usageInfo
说明

IOT聚合单卡用量查询

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

request
必填

request

UnionGetSimByIccidRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«UnionSimUsage»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v0/usageInfo
请求 header
"string"
请求 body
{
  "iccid" : "string",
  "requestId" : "string",
  "requestTime" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "expiry_date" : "string",
      "total_volume" : "string",
      "volume" : "string"
    },
    "sms" : {
      "expiry_date" : "string",
      "total_volume" : "string",
      "volume" : "string"
    },
    "voice" : {
      "expiry_date" : "string",
      "total_volume" : "string",
      "volume" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.7. 流量控制规则

Traffic Rule Controller

2.7.1. 创建流量控制规则

POST /api/v2/createTrafficRule
说明

创建流量控制规则

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

createTrafficRequest
必填

createTrafficRequest

CreateTrafficRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«TrafficResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/createTrafficRule
请求 header
"string"
请求 body
{
  "control_channels" : [ {
    "channel_id" : 1,
    "directions" : "incoming",
    "parameters" : {
      "ips" : "[]",
      "phone" : "[\"75675686867\"]",
      "ports" : "[]"
    },
    "type" : "allow"
  } ],
  "name" : "test 2",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.7.2. 删除流量控制规则

POST /api/v2/deleteTrafficRule
说明

删除流量控制规则

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

deleteTrafficRequest
必填

deleteTrafficRequest

DeleteTrafficRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«TrafficResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/deleteTrafficRule
请求 header
"string"
请求 body
{
  "control_rules_id" : 100,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.7.3. 编辑流量控制规则

POST /api/v2/editTrafficRule
说明

编辑流量控制规则

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

editTRafficParam
必填

editTRafficParam

EditTRafficParam

响应
HTTP代码 说明 类型

200

OK

通用返回对象«TrafficResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/editTrafficRule
请求 header
"string"
请求 body
{
  "control_channels" : [ {
    "channel_id" : 1,
    "directions" : "incoming",
    "parameters" : {
      "ips" : "[]",
      "phone" : "[\"75675686867\"]",
      "ports" : "[]"
    },
    "type" : "allow"
  } ],
  "control_rules_id" : 0,
  "name" : "test 2",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.7.4. 流量控制规则列表

POST /api/v2/getTrafficRule
说明

流量控制规则列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

queryTrafficRequest
必填

queryTrafficRequest

QueryTrafficRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QueryTrafficResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/getTrafficRule
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "page" : 1,
  "per_page" : 3,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "items" : [ {
      "id" : 0,
      "name" : "string",
      "sim_count" : 0
    } ],
    "paginator" : {
      "current_page" : "string",
      "from" : "string",
      "last_page" : "string",
      "per_page" : "string",
      "to" : "string",
      "total" : "string"
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.7.5. 设置流量控制规则

POST /api/v2/setTrafficRule
说明

设置流量控制规则

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

setTrafficRequest
必填

setTrafficRequest

SetTrafficRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«TrafficResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/setTrafficRule
请求 header
"string"
请求 body
{
  "control_rule_id" : 100,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.7.6. SIM卡上的流量控制的可用性

POST /api/v2/trfficAvalibiRule
说明

SIM卡上的流量控制的可用性

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

trafficAvailabiRequest
必填

trafficAvailabiRequest

TrafficAvailabiRequest

响应
HTTP代码 说明 类型

200

OK

通用返回对象«TrafficAvailabiResponse»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/trfficAvalibiRule
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : 0,
    "name" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8. 消息处理

Process Messages Controller

2.8.1. 取消发送

POST /api/v2/cancelSending
说明

取消发送

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

CancelSendingDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CancelSendingData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/cancelSending
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "schedule_id" : 101
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.2. 创建发送

POST /api/v2/createSending
说明

创建发送

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

CreateSendingDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CreateSendingData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/createSending
请求 header
"string"
请求 body
{
  "dispatch_name" : "test",
  "how_many" : 10,
  "is_binary" : true,
  "message_text" : "10",
  "parameters" : {
    "data_coding" : "0x04",
    "protocol" : "0x23"
  },
  "period" : {
    "days" : 2,
    "hours" : 1,
    "mins" : 10,
    "months" : 1
  },
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_group_id" : 10,
  "start_dttm" : 20210210
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.3. 创建模板

POST /api/v2/createTemplate
说明

创建模板

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

CreateTemplateDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«CreateTemplateData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/createTemplate
请求 header
"string"
请求 body
{
  "message_text" : "test_message",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "template_name" : "test_template"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.4. 删除模板

POST /api/v2/deleteTemplate
说明

删除模板

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

DeleteTemplateDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«DeleteTemplateData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/deleteTemplate
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "template_id" : 100
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.5. 编辑发送

POST /api/v2/editSending
说明

编辑发送

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

EditSendingDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«EditSendingData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/editSending
请求 header
"string"
请求 body
{
  "dispatch_name" : "test",
  "how_many" : 10,
  "is_binary" : true,
  "message_text" : "10",
  "parameters" : {
    "data_coding" : "0x04",
    "protocol" : "0x23"
  },
  "period" : {
    "days" : 2,
    "hours" : 1,
    "mins" : 10,
    "months" : 1
  },
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "schedule_id" : 100,
  "sim_group_id" : 10,
  "start_dttm" : 20210210
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.6. 编辑模板

POST /api/v2/editTemplate
说明

编辑模板

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

EditTemplateDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«EditTemplateData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/editTemplate
请求 header
"string"
请求 body
{
  "message_text" : "test_message",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "template_id" : 100,
  "template_name" : "test_template"
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.7. 查询设备上的进程消息列表

POST /api/v2/queryMessages
说明

查询设备上的进程消息列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

QueryMessagesDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QueryMessagesData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/queryMessages
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "order" : {
    "created_at" : "desc"
  },
  "page" : 1,
  "per_page" : 3,
  "query" : {
    "created_at" : {
      "type" : "period_days",
      "value" : "0"
    },
    "is_incoming" : {
      "type" : "eq",
      "value" : "0"
    },
    "message_text" : {
      "type" : "search",
      "value" : "ere4"
    },
    "server_sync_status" : {
      "type" : "eq",
      "value" : "0"
    }
  },
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "items" : [ {
        "chunks" : 0,
        "create_at" : {
          "date" : "string",
          "timezone" : "string",
          "timezone_type" : 0
        },
        "id" : 0,
        "is_binary" : true,
        "is_incoming" : true,
        "message_text" : "string",
        "parameters" : {
          "data_coding" : "0x04",
          "protocol" : "0x23"
        },
        "received_from" : "string",
        "send_to" : "string",
        "server_status" : 0,
        "server_sync_status" : 0,
        "sms_ext_id" : 0,
        "status" : 0,
        "ttl" : 0
      } ],
      "paginator" : {
        "current_page" : "string",
        "from" : "string",
        "last_page" : "string",
        "per_page" : "string",
        "to" : "string",
        "total" : "string"
      }
    },
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.8. 来自联系人的消息列表

POST /api/v2/queryMessagesOnContact
说明

来自联系人的消息列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

SendMessagesOnDeviceDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QueryMessagesOnContactData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/queryMessagesOnContact
请求 header
"string"
请求 body
{
  "is_binary" : false,
  "message_text" : "test",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522,
  "ttl" : 259200
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "items" : [ {
        "chunks" : 0,
        "create_at" : {
          "date" : "string",
          "timezone" : "string",
          "timezone_type" : 0
        },
        "id" : 0,
        "is_binary" : true,
        "is_incoming" : true,
        "message_text" : "string",
        "parameters" : {
          "data_coding" : "0x04",
          "protocol" : "0x23"
        },
        "received_from" : "string",
        "send_to" : "string",
        "server_status" : 0,
        "server_sync_status" : 0,
        "sms_ext_id" : 0,
        "status" : 0,
        "ttl" : 0
      } ],
      "paginator" : {
        "current_page" : "string",
        "from" : "string",
        "last_page" : "string",
        "per_page" : "string",
        "to" : "string",
        "total" : "string"
      }
    },
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.9. 发送清单

POST /api/v2/querySendingList
说明

发送清单

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

QuerySendingListDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySendingListData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/querySendingList
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "order" : {
    "id" : "desc"
  },
  "page" : 1,
  "per_page" : 3,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "items" : [ {
        "created_at" : "string",
        "id" : 0,
        "is_binary" : true,
        "is_incoming" : true,
        "message_text" : "string",
        "messages_processed" : 0,
        "messages_queued" : 0,
        "parameters" : {
          "data_coding" : "0x04",
          "protocol" : "0x23"
        },
        "schedule" : {
          "count" : 0,
          "created_at" : "string",
          "dispatch_name" : "string",
          "how_many" : 0,
          "id" : 0,
          "is_active" : true,
          "message_text" : "string",
          "period" : {
            "days" : 2,
            "hours" : 1,
            "mins" : 10,
            "months" : 1
          },
          "sim_group_id" : 0,
          "start_dttm" : "string",
          "status" : "string"
        },
        "status" : 0,
        "updated_at" : "string"
      } ],
      "paginator" : {
        "current_page" : "string",
        "from" : "string",
        "last_page" : "string",
        "per_page" : "string",
        "to" : "string",
        "total" : "string"
      }
    },
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.10. 发送消息列表

POST /api/v2/querySendingMessages
说明

发送消息列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

QuerySendingMessagesDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QuerySendingMessagesData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/querySendingMessages
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "order" : {
    "id" : "desc"
  },
  "page" : 1,
  "per_page" : 3,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "items" : [ {
        "created_at" : "string",
        "id" : 0,
        "is_binary" : true,
        "is_incoming" : true,
        "message_text" : "string",
        "messages_processed" : 0,
        "messages_queued" : 0,
        "parameters" : {
          "data_coding" : "0x04",
          "protocol" : "0x23"
        },
        "schedule" : {
          "count" : 0,
          "created_at" : "string",
          "dispatch_name" : "string",
          "how_many" : 0,
          "id" : 0,
          "is_active" : true,
          "message_text" : "string",
          "period" : {
            "days" : 2,
            "hours" : 1,
            "mins" : 10,
            "months" : 1
          },
          "sim_group_id" : 0,
          "start_dttm" : "string",
          "status" : "string"
        },
        "status" : 0,
        "updated_at" : "string"
      } ],
      "paginator" : {
        "current_page" : "string",
        "from" : "string",
        "last_page" : "string",
        "per_page" : "string",
        "to" : "string",
        "total" : "string"
      }
    },
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.11. 模板列表

POST /api/v2/queryTemplates
说明

模板列表

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

QueryTemplatesDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QueryTemplatesData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/queryTemplates
请求 header
"string"
请求 body
{
  "last_page" : 1,
  "page" : 1,
  "per_page" : 3,
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "data" : {
      "items" : [ {
        "id" : 0,
        "name" : "string",
        "sim_count" : 0
      } ],
      "paginator" : {
        "current_page" : "string",
        "from" : "string",
        "last_page" : "string",
        "per_page" : "string",
        "to" : "string",
        "total" : "string"
      }
    },
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.12. 在设备上发送进程消息

POST /api/v2/sendMessagesOnDevice
说明

在设备上发送进程消息

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

SendMessagesOnDeviceDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«SendMessagesOnDeviceData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/sendMessagesOnDevice
请求 header
"string"
请求 body
{
  "is_binary" : false,
  "message_text" : "test",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "sim_id" : 2463522,
  "ttl" : 259200
}
HTTP响应示例
响应 200
{
  "data" : {
    "message" : "string",
    "sme" : "string",
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.13. 开始发送

POST /api/v2/startSending
说明

开始发送

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

StartSendingDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«StartSendingData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/startSending
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "schedule_id" : 101
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.8.14. 停止发送

POST /api/v2/stopSending
说明

停止发送

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

StopSendingDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«StopSendingData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v2/stopSending
请求 header
"string"
请求 body
{
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "schedule_id" : 101
}
HTTP响应示例
响应 200
{
  "data" : {
    "status" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.9. 触发器管理

Trigger Package Controller

2.9.1. 解除订购包绑定到触发器接口

POST /api/v3/DeleteTriggerPackageFromSubscriptionPackages
说明

通过企业ID及订购包ID删除订购包上绑定的触发器。

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

DelTriPackFromSubPackDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«DeleteTriggerPackageFromSubscriptionPackageData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/DeleteTriggerPackageFromSubscriptionPackages
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "subscriptionPackageNameList" : [ {
    "subscriptionPackageName" : "SI trigger test 1"
  } ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "deleteTriggerPackageFromSubscriptionPackageResponse" : {
      "subscriptionPackageTriggerPackageLinkResult" : {
        "requestId" : "string",
        "resultCode" : "string",
        "serviceRequestId" : "string",
        "subscriptionPackageName" : "string"
      }
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.9.2. 绑定订购包到触发器接口

POST /api/v3/addTriggerPackageToSubscriptionPackages
说明

通过企业ID触发器ID及订购包ID进行触发器和订购包的绑定,成功后返回服务请求ID。

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

AddTriggerPackageDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«AddTriggerPackageToSubscriptionPackagesData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/addTriggerPackageToSubscriptionPackages
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "packageNo" : "1050502",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "subscriptionPackageNameList" : [ {
    "subscriptionPackageName" : "SI trigger test 1"
  } ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "addTriggerPackageToSubscriptionPackagesResponse" : {
      "subscriptionPackageTriggerPackageLinkResult" : {
        "requestId" : "string",
        "resultCode" : "string",
        "serviceRequestId" : "string",
        "subscriptionPackageName" : "string"
      }
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.9.3. 更改客户电子邮件地址接口

POST /api/v3/changeCustomerEmailAddress
说明

通过企业ID进行触发器邮箱设置,可以同时设置多个字符不超过300个。

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

ChangeCustomerEmailAddressDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«ChangeCustomerEmailAddressData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/changeCustomerEmailAddress
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "emailAddress" : "63373626@qq.com",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68"
}
HTTP响应示例
响应 200
{
  "data" : {
    "changeCustomerEmailAddressResponse" : "string"
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.9.4. 更改触发器包v1接口

POST /api/v3/changeTriggerPackage
说明

用于短周期的触发器包更新。

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

ChangeTriggerPackageDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«QueryTriggerPackagesData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/changeTriggerPackage
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "description" : "CT  SI trigger test",
  "lastChange" : "2021-07-22",
  "name" : "SI trigger test 1",
  "packageNo" : "1050502",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "triggerMetrics" : {
    "triggerMetric" : [ {
      "actionActive" : true,
      "actionValue" : "10",
      "alertActive" : true,
      "alertValue" : "1",
      "lastChange" : "2018-06-14",
      "timeFrame" : "1",
      "timeFrameUnit" : "hour",
      "triggerName" : "SI 触发器测试",
      "triggerNumber" : "6"
    } ]
  }
}
HTTP响应示例
响应 200
{
  "data" : {
    "queryTriggerPackagesResponse" : {
      "triggerPackages" : {
        "triggerPackage" : [ {
          "customerNo" : "string",
          "description" : "string",
          "name" : "string",
          "packageNo" : "string",
          "triggerMetrics" : {
            "triggerMetric" : [ {
              "actionActive" : true,
              "actionValue" : "10",
              "alertActive" : true,
              "alertValue" : "1",
              "lastChange" : "2018-06-14",
              "timeFrame" : "1",
              "timeFrameUnit" : "hour",
              "triggerName" : "SI 触发器测试",
              "triggerNumber" : "6"
            } ]
          }
        } ]
      }
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.9.5. 更改触发器包v2接口

POST /api/v3/changeTriggerPackage_v2
说明

用于长短周期的触发器包更新

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

ChangeTriggerPackageV2Dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«TriggerPackageChangeDataV2»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/changeTriggerPackage_v2
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "description" : "CT  SI trigger test",
  "lastChange" : "2021-07-22",
  "name" : "SI trigger test 1",
  "packageNo" : "1050502",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "triggerMetrics" : {
    "triggerMetric" : [ {
      "actionActive" : true,
      "actionValue" : "10",
      "alertActive" : true,
      "alertValue" : "1",
      "lastChange" : "2018-06-14",
      "timeFrame" : "1",
      "timeFrameUnit" : "hour",
      "triggerName" : "SI 触发器测试",
      "triggerNumber" : "6"
    } ]
  }
}
HTTP响应示例
响应 200
{
  "data" : {
    "triggerPackageChangeResponse_v2" : {
      "triggerPackage" : {
        "customerNo" : "string",
        "description" : "string",
        "name" : "string",
        "packageNo" : "string",
        "triggerMetrics" : {
          "triggerMetric" : [ {
            "actionActive" : true,
            "actionValue" : "10",
            "alertActive" : true,
            "alertValue" : "1",
            "lastChange" : "2018-06-14",
            "timeFrame" : "1",
            "timeFrameUnit" : "hour",
            "triggerName" : "SI 触发器测试",
            "triggerNumber" : "6"
          } ]
        }
      }
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.9.6. 创建触发器包v1接口

POST /api/v3/createTriggerPackage
说明

根据企业ID及相关触发器参数新建短周期的触发器包

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

CreateTriggerPackageDto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«TriggerPackageCreateData»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/createTriggerPackage
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "description" : "CT  SI trigger test",
  "name" : "SI trigger test 1",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "triggerMetrics" : {
    "triggerMetric" : [ {
      "actionActive" : true,
      "actionValue" : "10",
      "alertActive" : true,
      "alertValue" : "1",
      "lastChange" : "2018-06-14",
      "timeFrame" : "1",
      "timeFrameUnit" : "hour",
      "triggerName" : "SI 触发器测试",
      "triggerNumber" : "6"
    } ]
  }
}
HTTP响应示例
响应 200
{
  "data" : {
    "triggerPackageCreateResponse" : {
      "triggerPackage" : {
        "customerNo" : "string",
        "description" : "string",
        "name" : "string",
        "packageNo" : "string",
        "triggerMetrics" : {
          "triggerMetric" : [ {
            "actionActive" : true,
            "actionValue" : "10",
            "alertActive" : true,
            "alertValue" : "1",
            "lastChange" : "2018-06-14",
            "timeFrame" : "1",
            "timeFrameUnit" : "hour",
            "triggerName" : "SI 触发器测试",
            "triggerNumber" : "6"
          } ]
        }
      }
    }
  },
  "requestId" : "string",
  "responseTime" : "string",
  "status" : "string"
}

2.9.7. 创建触发器包v2接口

POST /api/v3/createTriggerPackage_v2
说明

根据企业ID及相关触发器参数新建长短周期的触发器包。

参数
类型 名称 说明 类型

Header

Authorization
可选

令牌

string

Body

dto
必填

dto

CreateTriggerPackageV2Dto

响应
HTTP代码 说明 类型

200

OK

通用返回对象«TriggerPackageCreateDataV2»

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • /

HTTP请求示例
请求 path
/api/v3/createTriggerPackage_v2
请求 header
"string"
请求 body
{
  "customerNo" : "69000023",
  "description" : "CT  SI trigger test",
  "name" : "SI trigger test 1",
  "requestId" : "20210712134068895456",
  "requestTime" : "2021-07-12 13:40:68",
  "triggerMetrics" : {
    "triggerMetric" : [ {
      "actionActive" : true,
      "actionValue" : "10",
      "alertActive" : true,
      "alertValue" : "1",
      "lastChange" : "2018-06-14",
      "timeFrame" : "1",
      "timeFrameUnit" : "hour",
      "triggerName" : "SI 触发器测试",
      "triggerNumber" : "6"
    } ]
  }
}
HTTP响应示例
响应 200
{
  "data" : {
    "triggerPackageCreateResponse_v2" : {
      "triggerPackage" : {
        "customerNo" : "string",
        "description" : "string",
        "name" : "string",
        "packageNo" : "string",
        "triggerMetrics" : {
          "triggerMetric