API docs by Redocly

docomo business SIGN Value(閉域) APIリファレンス (1.0.0)

Download OpenAPI specification:

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

docomo business SIGN Value(閉域) APIリファレンス

Value(閉域)回線

Value(閉域)回線に関する API

SIM一覧(SIMグループ別)表示用API

SIM一覧(SIMグループ別)表示用API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters
esimStatus
string
Enum: "enabled" "disabled" "deleted"

指定したeSIMステータスでプロファイルを絞り込む

profileStatus
string
Enum: "inactive" "active" "suspend" "sleeping" "delete"

指定したプロファイルステータスでプロファイルを絞り込む

hsn
string
Example: hsn=013AAA0026

検索に使うHSN（部分一致）

imsi
string
Example: imsi=440130000096015

検索に使うIMSI（部分一致）

iccid
string
Example: iccid=2234567890000002071

iccidに指定した文字を含むかでプロファイルを絞り込む（部分一致）

msisdn
string
Example: msisdn=812023284118111

検索に使うMSISDN（部分一致）

cnActIpAddress
string
Example: cnActIpAddress=NA

cnActIpAddressに指定した文字を含むかでプロファイルを絞り込む（部分一致）

comment
string
Example: comment=コメント

commentに指定した文字を含むかでプロファイルを絞り込む

page
integer >= 1
Example: page=3

ページ数. デフォルトは1

pageSize
integer [ 1 .. 10000 ]
Example: pageSize=30

1ページ中のアイテム数. デフォルトは20

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
Example
{
  • "sims": [
    ],
  • "total": 4,
  • "totalPages": 2,
  • "page": 1,
  • "pageSize": 2
}

SIM発注API

SIM発注API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
simType
required
string
Enum: "chip" "hard"

SIM種別 chip:チップSIM, hard:ハードSIM
アプレット搭載SIMの場合hardのみを許可

simGrade
required
string
Enum: "industrial" "normal"

SIMグレード(Industrial:インダストリアル normal:ノーマル)
アプレット搭載SIMの場合はnormalのみを許可

quantity
required
integer [ 1 .. 20000 ]

SIM枚数(simTypeが"chipSim"の場合は500-20000, simTypeがhardSimの場合は1-20000)

shippingAddressId
required
string = 32 characters 0-9a-f

送付先ID

additionalService
string
Value: "eSimAppletOta"

SIM付加サービス（アプレット搭載SIMの場合、"eSimAppletOta"を指定）

Responses

Request samples

Content type
application/json
{
  • "simType": "chip",
  • "simGrade": "industrial",
  • "quantity": 20,
  • "shippingAddressId": "fbfd5c9c6718320e7fdec080b74a7abd",
  • "additionalService": "eSimAppletOta"
}

Response samples

Content type
application/json
{
  • "orderId": "ORDER-20200807-0919",
  • "requestBody": {
    }
}

SIM情報参照API

SIM情報参照API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "eid": "89033024063202496400000008151710",
  • "simGrade": "industrial",
  • "simType": "chip",
  • "simOrderNo": "ORDER-20200807-0913",
  • "profileSwitching": true
}

SIM廃止API

SIM廃止API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "tid": "tran-sdp-20230215-004900-0040"
}

SIMに紐付くProfile一覧参照API

SIMに紐付くProfile一覧参照API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "profiles": [
    ]
}

SIMを中断するAPI

SIMを中断状態にするAPI

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

imsi
required
string [ 1 .. 15 ] characters 0-9
Example: 440130000096015

IMSI

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

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

SIMを再開するAPI

中断状態のSIMを再開させるAPI

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

imsi
required
string [ 1 .. 15 ] characters 0-9
Example: 440130000096015

IMSI

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

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

料金プラン上限値変更API

料金プラン上限値変更API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

imsi
required
string [ 1 .. 15 ] characters 0-9
Example: 440130000096015

IMSI

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
limit
required
integer

制限容量（KB単位）

Responses

Request samples

Content type
application/json
{
  • "plan": "fixed",
  • "limit": 1048576
}

Response samples

Content type
application/json
Example
{
  • "tid": "tran-20200807-00007",
  • "requestBody": {
    }
}

プロファイル情報参照API

プロファイル情報参照API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

imsi
required
string [ 1 .. 15 ] characters 0-9
Example: 440130000096015

IMSI

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
Example
{
  • "iccid": "8981120000000830180",
  • "msisdn": "812023284118111",
  • "provider": "nttc",
  • "profileStatus": "active",
  • "esimStatus": "enabled",
  • "plan": "fixed",
  • "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

プロファイル開通API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

imsi
required
string [ 1 .. 15 ] characters 0-9
Example: 440130000096015

IMSI

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
limit
required
integer

制限容量（KB単位）

cnActIpAddress
required
string

NTTC閉域接続の場合は必須

Responses

Request samples

Content type
application/json
{
  • "limit": 1048576,
  • "cnActIpAddress": "10.0.1.5"
}

Response samples

Content type
application/json
Example
{
  • "tid": "tran-20200807-00003",
  • "requestBody": {
    }
}

プロファイル利用中断API

プロファイル利用中断API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

imsi
required
string [ 1 .. 15 ] characters 0-9
Example: 440130000096015

IMSI

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

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

プロファイル利用再開API

プロファイル利用再開API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

imsi
required
string [ 1 .. 15 ] characters 0-9
Example: 440130000096015

IMSI

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

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

容量追加

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

imsi
required
string [ 1 .. 15 ] characters 0-9
Example: 440130000096015

IMSI

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
limit
required
integer

追加する容量（KB単位）

Responses

Request samples

Content type
application/json
{
  • "limit": 102400
}

Response samples

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

上限値参照API

料金プラン "fixed" の上限値参照API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "limits": [
    ]
}

追加容量一覧取得

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

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "limits": [
    ]
}

NTTC閉域接続情報参照API

NTTC閉域接続情報参照API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "cnId": "xxxx",
  • "sellerKey": "xxxx",
  • "ficVlanPrimary": 1111,
  • "ficVlanSecondary": 2222,
  • "ficLocation": "tokyo",
  • "poiRedundant": true,
  • "ficRouterConnection": "paired",
  • "ficRouterPrimarySegment": "192.168.0.0/30",
  • "ficRouterSecondarySegment": "192.168.0.4/30",
  • "ficRouterPrimaryAS": 65001,
  • "ficRouterSecondaryAS": 65002,
  • "profileActSegment": [
    ],
  • "profileSbySegment": [
    ],
  • "ping": "OK",
  • "createdAt": "string"
}

NTTC閉域接続新規申し込みAPI

NTTC閉域接続新規申し込みAPI

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "profileActSegment": [
    ]
}

Response samples

Content type
application/json
{
  • "cnOrderId": "cnOrder_xxxx",
  • "sellerKey": "xxxx",
  • "requestBody": {
    }
}

NTTC閉域接続削除API

NTTC閉域接続削除API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
Example
{
  • "errorCode": 10104,
  • "errorMessages": [
    ]
}

NTTC閉域接続開通確認API

NTTC閉域接続開通確認API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "ficRouterPrimary": "OK",
  • "ficRouterSecondary": "OK"
}

Profile Segment参照API

当該テナントが獲得したプロファイル用IPセグメントを一覧参照するAPI

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters
status
required
string
Example: status=available

availableを指定

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "segments": [
    ]
}

Profile Segment利用可能IPアドレス取得

NTTC閉域接続新規申し込みにて割り当てられたプロファイル用IPセグメントの中の利用可能なIPアドレスを参照するAPI

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
Example
{
  • "segments": [
    ]
}

コメント編集API

コメント編集API

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

hsn
required
string = 10 characters 0-9A-Z
Example: 013AAA0025

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

imsi
required
string [ 1 .. 15 ] characters 0-9
Example: 440130000096015

IMSI

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
comment
required
string or null <characters> <= 50 characters ^[^"']*$

コメント

Responses

Request samples

Content type
application/json
{
  • "comment": "コメント"
}

Response samples

Content type
application/json
{
  • "comment": "コメント"
}