PROFILES - IoT Connect Mobile Type S リファレンス (3.0.0)
Download OpenAPI specification:Download
料金プラン/上限値参照API
料金プラン参照API
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "policies": [
- {
- "plan": "payg",
- "limit": [
- 0,
- 1024,
- 10240,
- 30720,
- 51200,
- 102400,
- 307200,
- 512000,
- 1048576,
- 3145728,
- 5242880,
- 10485760,
- 31457280
], - "dedicatedPlan": false
}, - {
- "plan": "fixed",
- "limit": [
- 3072,
- 10240,
- 30720,
- 51200,
- 102400,
- 512000,
- 1048576,
- 3145728,
- 7340032,
- 10485760,
- 15728640,
- 20971520,
- 31457280,
- 52428800
], - "dedicatedPlan": false
}, - {
- "plan": "upStream",
- "limit": [
- {
- "up": 3145728,
- "down": 512000
}, - {
- "up": 3145728,
- "down": 1048576
}, - {
- "up": 52428800,
- "down": 512000
}, - {
- "up": 52428800,
- "down": 1048576
}, - {
- "up": 104857600,
- "down": 512000
}, - {
- "up": 104857600,
- "down": 1048576
}, - {
- "up": 157286400,
- "down": 512000
}, - {
- "up": 157286400,
- "down": 1048576
}, - {
- "up": 314572800,
- "down": 512000
}, - {
- "up": 314572800,
- "down": 1048576
}, - {
- "up": 524288000,
- "down": 512000
}, - {
- "up": 524288000,
- "down": 1048576
}
], - "dedicatedPlan": false
}, - {
- "plan": "payg",
- "limit": [
- 0,
- 1024,
- 10240,
- 30720,
- 51200,
- 102400,
- 307200,
- 512000,
- 1048576,
- 3145728,
- 5242880,
- 10485760,
- 31457280
], - "dedicatedPlan": true
}
]
}
料金プラン/上限値変更API
料金プラン/上限値変更API
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID |
imsi required | string International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
Request Body
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
imsi required | string <= 16 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
plan required | string Enum: "payg" "fixed" プラン種別 payg:従量プラン, fixed:定額プラン |
limit | integer KB単位(payg, fixedプランで必須) |
upStream | boolean 上り特価プランかどうか |
upLimit | integer KB単位(上り特価プランで必須) |
downLimit | integer KB単位(上り特価プランで必須) |
dedicatedPlan | boolean 専用プランかどうか |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025",
- "imsi": "440130000096015",
- "plan": "fixed",
- "limit": 1048576
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00007",
- "requestBody": {
- "hsn": "013AAA0025",
- "imsi": "440130000096015",
- "plan": "fixed",
- "limit": 1048576
}
}
プロファイル情報参照API
プロファイル情報参照API
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID |
imsi required | string International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "iccid": "8981120000000830180",
- "msisdn": "812023284118111",
- "provider": "nttc",
- "profileStatus": "active",
- "esimStatus": "enabled",
- "plan": "payg",
- "limit": 0,
- "upLimit": null,
- "downLimit": null,
- "puk1": "53946058",
- "puk2": "53946058",
- "cn": true,
- "cnActIpAddress": "10.0.1.5",
- "cnSbyIpAddress": "10.0.2.5",
- "upStream": false,
- "icgw": false,
- "icgwInProgress": false,
- "icgwEastIpAddress": null,
- "icgwWestIpAddress": null,
- "shareId": null,
- "billingSpan": null,
- "expDate": null,
- "multiAccess": false
}
プロファイル削除API
プロファイル削除API
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID |
imsi required | string International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
Request Body
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
imsi required | string <= 16 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025",
- "imsi": "440130000096015"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00006",
- "requestBody": {
- "hsn": "013AAA0025",
- "imsi": "440130000096015"
}
}
プロファイル開通API
SIMの中にあるプロファイルを初めて利用するときに使用するAPI
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
Request Body
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
imsi required | string <= 16 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
plan required | string Enum: "payg" "fixed" プラン種別 payg:従量プラン, fixed:定額プラン |
limit | integer 制限容量(KB単位) |
cn required | boolean 閉域接続の有無 |
cnActIpAddress | string 閉域接続の場合は必須。Internet接続の場合は空欄 |
cnSbyIpAddress | string 閉域接続POI冗長構成の場合は必須。Internet接続の場合は空欄 |
upStream | boolean 上り特価プランかどうか |
upLimit | integer KB単位(上り特価プランで必須) |
downLimit | integer KB単位(上り特価プランで必須) |
dedicatedPlan | boolean 専用プランかどうか |
testMode | boolean テストモードかどうか |
globalStaticIpAddressOption | boolean グローバル固定IPアドレスの有無 |
billingSpan | string Value: "1year" 支払期間 |
icgw | boolean ICGWを申し込むかどうか |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025",
- "imsi": "440130000096015",
- "plan": "fixed",
- "limit": 1048576,
- "cn": true,
- "cnActIpAddress": "10.0.1.5",
- "cnSbyIpAddress": "10.0.2.5"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00003",
- "requestBody": {
- "hsn": "013AAA0025",
- "imsi": "440130000096015",
- "plan": "fixed",
- "limit": 1048576,
- "cn": true,
- "cnActIpAddress": "10.0.1.5",
- "cnSbyIpAddress": "10.0.2.5"
}
}
プロファイル切替API
SIMで使用するプロファイルを切り替えるAPI
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
Request Body
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
imsi required | string <= 16 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025",
- "imsi": "440130000096015"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00003",
- "requestBody": {
- "hsn": "013AAA0025",
- "imsi": "440130000096015"
}
}
プロファイル利用休止API
プロファイル利用休止API
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
Request Body
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
imsi required | string <= 16 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025",
- "imsi": "440130000096015"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00005",
- "requestBody": {
- "hsn": "013AAA0025",
- "imsi": "440130000096015"
}
}
プロファイル利用再開API
プロファイル利用再開API
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
Request Body
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
imsi required | string <= 16 characters International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025",
- "imsi": "440130000096015"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00005",
- "requestBody": {
- "hsn": "013AAA0025",
- "imsi": "440130000096015"
}
}
在庫プロファイル数参照API
在庫プロファイル数参照API
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "profiles": {
- "nttcProfiles": 1,
- "tslProfiles": 0,
- "cslProfiles": 0
}
}
在庫プロファイル一覧参照API
未ダウンロードプロファイル一覧参照API
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "stockProfiles": [
- {
- "imsi": "440130000096020",
- "msisdn": "812023284115111",
- "provider": "nttc"
}
]
}
プロファイル新規発注API
プロファイル新規発注API
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
Request Body
provider required | string Enum: "nttc" "tsl" HPLMN(Home Public Land Mobile Network)を提供する事業者。 |
quantity required | integer [ 1 .. 20000 ] SIM枚数 |
Responses
Accepted
Bad Request
Request samples
- Payload
{- "provider": "tsl",
- "quantity": 5
}
Response samples
- 202
- 400
{- "orderId": "ORDER-202XXXXX-XXXX",
- "requestBody": {
- "provider": "tsl",
- "quantity": 5
}
}
閉域接続用アドレス変更API
閉域接続用アドレス変更API
path Parameters
imsi required | string International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
header Parameters
X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
cnActIpAddress required | string ^(\d{1,3}\.){3}\d{1,3}$ cnがfalseの場合は空欄。subnet maskの記載なし |
cnSbyIpAddress | string ^(\d{1,3}\.){3}\d{1,3}$ cnがfalseまたは、poi冗長構成がsingleの場合は空欄 |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "cnActIpAddress": "10.0.0.2",
- "cnSbyIpAddress": "10.0.1.2"
}
Response samples
- 202
- 400
- 409
ICGW利用申込みAPI
SIMの中にあるプロファイルのICGW利用申込みをするAPI
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
Request Body
hsn required | string 10 characters ハードウェアシリアル番号(HSN) |
Responses
Accepted
Bad Request
Conflict
Request samples
- Payload
{- "hsn": "013AAA0025"
}
Response samples
- 202
- 400
- 409
{- "tid": "tran-20200807-00003",
- "requestBody": {
- "hsn": "013AAA0025"
}
}
プロファイル使用量 (年月日指定) 一覧取得
プロファイルの日別使用量を参照するAPI
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string 15 characters Example: 440130000096017 International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
query Parameters
startDate required | string ^\d{4}-\d{2}-\d{2}$ Example: startDate=2021-02-04 yyyy-MM-dd形式で開始年月日を指定 |
endDate required | string ^\d{4}-\d{2}-\d{2}$ Example: endDate=2021-02-06 yyyy-MM-dd形式で終了年月日を指定 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "dailyProfileUsage": [
- {
- "date": "2021-01-01",
- "dailyUsage": 1000,
- "dailyUpUsage": null,
- "dailyDownUsage": null,
- "userCountry": "Japan",
- "userNetwork": "NTT DoCoMo, Inc."
}, - {
- "date": "2021-01-02",
- "dailyUsage": 1000,
- "dailyUpUsage": null,
- "dailyDownUsage": null,
- "userCountry": "Japan",
- "userNetwork": "NTT DoCoMo, Inc."
}, - {
- "date": "2021-01-03",
- "dailyUsage": 1000,
- "dailyUpUsage": null,
- "dailyDownUsage": null,
- "userCountry": "Japan",
- "userNetwork": "NTT DoCoMo, Inc."
}
]
}
プロファイル使用量 (年月指定) 一覧取得
プロファイルの月別使用量を参照するAPI
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string 15 characters Example: 440130000096017 International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
query Parameters
startMonth required | string ^\d{4}-\d{2}$ Example: startMonth=2021-01 yyyy-MM形式で開始年月を指定 |
endMonth required | string ^\d{4}-\d{2}$ Example: endMonth=2021-03 yyyy-MM形式で終了年月を指定 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "monthlyProfileUsage": [
- {
- "date": "2021-01",
- "monthlyUsage": 1000,
- "monthlyUpUsage": null,
- "monthlyDownUsage": null,
- "userCountry": "Japan",
- "userNetwork": "NTT DoCoMo, Inc."
}, - {
- "date": "2021-02",
- "monthlyUsage": 1000,
- "monthlyUpUsage": null,
- "monthlyDownUsage": null,
- "userCountry": "Japan",
- "userNetwork": "NTT DoCoMo, Inc."
}, - {
- "date": "2021-03",
- "monthlyUsage": 1000,
- "monthlyUpUsage": null,
- "monthlyDownUsage": null,
- "userCountry": "Japan",
- "userNetwork": "NTT DoCoMo, Inc."
}
]
}
追加容量一覧取得
可能な追加容量の一覧を参照するAPI
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
{- "limitPattern": [
- {
- "plan": "fixed",
- "limit": [
- 102400,
- 1048576,
- 5242880
]
}
]
}
容量追加
プロファイルに容量を追加するAPI
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string 15 characters Example: 440130000096017 International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
Request Body
limit required | integer 追加する容量(KB単位) |
Responses
OK
Bad Request
Request samples
- Payload
{- "limit": 102400
}
Response samples
- 200
- 400
{- "tid": "tran-sdp-20230215-004900-0040",
- "requestBody": {
- "limit": 102400
}
}
マルチアクセス接続状況
マルチアクアセスSIMの接続状況を取得するAPI
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string 15 characters Example: 440130000096017 International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Not Found
Response samples
- 200
- 400
- 404
{- "hsn": "013AAA0028",
- "iccid": "8981120000000402899F",
- "imsi": "440130000096019",
- "imsi_2": "901370001418959",
- "last_connected_carrier": "nttc",
- "imei": "A355927115114020",
- "updated_at": "2023-11-02T00:00:00"
}
マルチアクセスSIM接続履歴
マルチアクアセスSIMの直近100件までの接続履歴を取得するAPI
path Parameters
tenantId required | string ^[\da-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPFのテナントに一意に与えられる ID. |
imsi required | string 15 characters Example: 440130000096017 International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。 |
header Parameters
X-Auth-Token required | string ^[\da-f]{32}$ Example: b41715e07684453abbe8a83eb93fde80 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Response samples
- 200
- 400
[- {
- "created_at": "2023-10-19T10:13:21",
- "ef_iccid": "8981120000002260832F",
- "ef_imsi": "440130000236084",
- "imei": "A355927115114020",
- "applet_state": "01"
}, - {
- "created_at": "2023-10-19T10:13:05",
- "ef_iccid": "8981120000002260832F",
- "ef_imsi": "440130000236084",
- "imei": "A355927115114020",
- "applet_state": "01"
}
]