Documentation Powered by ReDoc

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

Download OpenAPI specification:Download

URL: https://developer.ntt.com/ License: (c) 2020 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

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

Profile

Profileに関連する API

料金プラン/上限値参照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

200

OK

400

Bad Request

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

Response samples

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

料金プラン/上限値変更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

202

Accepted

400

Bad Request

409

Conflict

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

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 ^[\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

200

OK

400

Bad Request

get/tenants/{tenantId}/profiles/{imsi}
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/profiles/{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
}

プロファイル削除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

202

Accepted

400

Bad Request

409

Conflict

delete/tenants/{tenantId}/profiles/{imsi}
https://api.ntt.com/icms-esim/v2/tenants/{tenantId}/profiles/{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-00006",
  • "requestBody":
    {
    }
}

プロファイル開通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

202

Accepted

400

Bad Request

409

Conflict

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

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"
}

Response samples

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

プロファイル切替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

202

Accepted

400

Bad Request

409

Conflict

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

Request samples

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