Documentation Powered by ReDoc

PROFILES - IoT Connect Mobile Type S リファレンス (3.0.0)

Download OpenAPI specification:Download

URL: https://developer.ntt.com/ License: © 2020 NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

概要

本APIでは、IoT Connect Mobile Type S に関するリソースの参照・操作が可能です。

Profile

Profileに関連する API

料金プラン/上限値参照API

料金プラン参照API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/policies
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/policies

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "policies":
    [
    ]
}

料金プラン/上限値変更API

料金プラン/上限値変更API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

Request Body

hsn
required
string ^[0-9A-F]{10}$

ハードウェアシリアル番号(HSN)

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

plan
required
any
Enum: "payg" "fixed"

プラン種別 payg:従量プラン, fixed:定額プラン

limit
integer

KB単位（payg, fixedプランで必須）

upStream
boolean

上り特価プランかどうか

upLimit
integer

KB単位（上り特価プランで必須）

downLimit
integer

KB単位（上り特価プランで必須）

dedicatedPlan
boolean

専用プランかどうか

Responses

202

Accepted

400

Bad Request

409

Conflict

put/tenants/{tenantId}/profiles/policy/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/policy/{imsi}

Request samples

Content type
application/json
Example
example
Copy
 Expand all Collapse all
{
  • "hsn": "013AAA0025",
  • "imsi": "440130000096015",
  • "plan": "fixed",
  • "limit": 1048576
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tid": "tran-20200807-00007",
  • "requestBody":
    {
    }
}

プロファイル情報参照API

プロファイル情報参照API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/profiles/self-add/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/self-add/{imsi}

Response samples

Content type
application/json
Example
example
Copy
 Expand all Collapse all
{
  • "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,
  • "unoTsl": false,
  • "unoTslPoi1IpAddress": null,
  • "unoTslPoi2IpAddress": null,
  • "simGroupId": "dfec0e39-3edf-4a39-bcb3-aab8e627a0ee"
}

プロファイル開通API

SIMの中にあるプロファイルを初めて利用するときに使用するAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

Request Body

hsn
required
string ^[0-9A-F]{10}$

ハードウェアシリアル番号(HSN)

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

plan
required
any
Enum: "payg" "fixed"

プラン種別 payg:従量プラン, fixed:定額プラン

limit
integer

制限容量（KB単位）

cn
required
boolean

NTTC閉域接続の有無

cnActIpAddress
string

NTTC閉域接続の場合は必須。Internet接続の場合は空欄

cnSbyIpAddress
string

NTTC閉域接続POI冗長構成の場合は必須。Internet接続の場合は空欄

upStream
boolean

上り特価プランかどうか

upLimit
integer

KB単位（上り特価プランで必須）

downLimit
integer

KB単位（上り特価プランで必須）

dedicatedPlan
boolean

専用プランかどうか

testMode
boolean

テストモードかどうか

globalStaticIpAddressOption
boolean

グローバル固定IPアドレスの有無

billingSpan
any
Value: "1year"

支払期間

icgw
boolean

ICGWを申し込むかどうか

unoTsl
required
boolean

TSL閉域接続の有無

unoTslPoi1IpAddress
string

プロファイル用IPセグメント

unoTslPoi2IpAddress
string

プロファイル用IPセグメント

Responses

202

Accepted

400

Bad Request

409

Conflict

put/tenants/{tenantId}/profiles/enableProfile/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/enableProfile/{imsi}

Request samples

Content type
application/json
Example
example
Copy
 Expand all Collapse all
{
  • "hsn": "013AAA0025",
  • "imsi": "440130000096015",
  • "plan": "fixed",
  • "limit": 1048576,
  • "cn": true,
  • "cnActIpAddress": "10.0.1.5",
  • "cnSbyIpAddress": "10.0.2.5",
  • "unoTsl": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tid": "tran-20200807-00003",
  • "requestBody":
    {
    }
}

プロファイル利用休止API

プロファイル利用休止API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

Request Body

hsn
required
string ^[0-9A-F]{10}$

ハードウェアシリアル番号(HSN)

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

Responses

202

Accepted

400

Bad Request

409

Conflict

put/tenants/{tenantId}/profiles/sleepProfile/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/sleepProfile/{imsi}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "hsn": "013AAA0025",
  • "imsi": "440130000096015"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tid": "tran-20200807-00005",
  • "requestBody":
    {
    }
}

プロファイル利用再開API

プロファイル利用再開API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

Request Body

hsn
required
string ^[0-9A-F]{10}$

ハードウェアシリアル番号(HSN)

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

Responses

202

Accepted

400

Bad Request

409

Conflict

put/tenants/{tenantId}/profiles/wakeProfile/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/wakeProfile/{imsi}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "hsn": "013AAA0025",
  • "imsi": "440130000096015"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tid": "tran-20200807-00005",
  • "requestBody":
    {
    }
}

NTTC閉域接続用アドレス変更API

NTTC閉域接続用アドレス変更API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
cnActIpAddress
required
string <ipv4>

cnがfalseの場合は空欄。subnet maskの記載なし

cnSbyIpAddress
string <ipv4>

cnがfalseまたは、poi冗長構成がsingleの場合は空欄

Responses

202

Accepted

400

Bad Request

409

Conflict

put/tenants/{tenantId}/profiles/cnProfileAddress/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/cnProfileAddress/{imsi}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "cnActIpAddress": "10.0.0.2",
  • "cnSbyIpAddress": "10.0.1.2"
}

Response samples

Content type
application/json
No sample

ICGW利用申込みAPI

SIMの中にあるプロファイルのICGW利用申込みをするAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

Request Body

hsn
required
string ^[0-9A-F]{10}$

ハードウェアシリアル番号(HSN)

Responses

202

Accepted

400

Bad Request

409

Conflict

put/tenants/{tenantId}/profiles/enableIcgwProfile/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/enableIcgwProfile/{imsi}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "hsn": "013AAA0025"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tid": "tran-20200807-00003",
  • "requestBody":
    {
    }
}

プロファイル使用量 (年月日指定) 一覧取得

プロファイルの日別使用量を参照するAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$
Example: 440130000096017

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

query Parameters
startDate
required
string <date>
Example: startDate=2021-02-04

yyyy-MM-dd形式で開始年月日を指定

endDate
required
string <date>
Example: endDate=2021-02-06

yyyy-MM-dd形式で終了年月日を指定

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/profiles/dailyUsage/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/dailyUsage/{imsi}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "dailyProfileUsage":
    [
    ]
}

プロファイル使用量 (年月指定) 一覧取得

プロファイルの月別使用量を参照するAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$
Example: 440130000096017

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

query Parameters
startMonth
required
string ^[0-9]{4}-[0-9]{2}$
Example: startMonth=2021-01

yyyy-MM形式で開始年月を指定

endMonth
required
string ^[0-9]{4}-[0-9]{2}$
Example: endMonth=2021-03

yyyy-MM形式で終了年月を指定

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/profiles/monthlyUsage/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/monthlyUsage/{imsi}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "monthlyProfileUsage":
    [
    ]
}

コメント編集API

プロファイルのコメントを編集するAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

Request Body schema: application/json
imsis
required
Array of objects

imsiの一覧

comment
required
string <= 50 characters Nullable ^[^"']*$

コメント

Responses

204

Accepted

400

Bad Request

put/tenants/{tenantId}/profiles/comments
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/comments

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "imsis":
    [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
Example
pathに含まれる値が存在しない場合
Copy
 Expand all Collapse all
{
  • "message": "Bad Request",
  • "detail": "path parameter 'imsi' is invalid"
}

Additional Limit

容量追加に関連する API

追加容量一覧取得

可能な追加容量の一覧を参照するAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/additionallimit
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/additionallimit

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "limitPattern":
    [
    ]
}

容量追加

プロファイルに容量を追加するAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$
Example: 440130000096017

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

Request Body

limit
required
integer

追加する容量（KB単位）

Responses

200

OK

400

Bad Request

post/tenants/{tenantId}/profiles/additionalLimit/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/additionalLimit/{imsi}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "limit": 102400
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tid": "tran-sdp-20230215-004900-0040",
  • "requestBody":
    {
    }
}

Multiaccess

マルチアクセスSIMに関連する API

マルチアクセス接続状況

マルチアクアセスSIMの接続状況を取得するAPI

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$
Example: 440130000096017

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

404

Not Found

get/tenants/{tenantId}/profiles/multiaccess-info/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/multiaccess-info/{imsi}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "hsn": "013AAA0028",
  • "iccid": "8981120000000402899",
  • "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 ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPFのテナントに一意に与えられる ID

imsi
required
string ^[0-9]{1,15}$
Example: 440130000096017

International Mobile Subscriber Identity。世界でユニークとなる携帯電話ユーザの識別子。

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: b41715e07684453abbe8a83eb93fde80

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

400

Bad Request

get/tenants/{tenantId}/profiles/multiaccess-log/{imsi}
https://api.ntt.com/icms-esim/v3/tenants/{tenantId}/profiles/multiaccess-log/{imsi}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]