API docs by Redocly

docomo business SIGN Advanced 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 Advanced APIリファレンス

sim-group

SIMグループ

SIMグループ取得

AdvancedのSIMグループ情報を全件取得する。

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
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed",
  • "groupinfo": [
    ]
}

SIMグループ更新

SIMグループ情報を更新する

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Request Body schema: application/json
simGroupName
required
string (simGroupName) [ 1 .. 30 ] characters ^[\x21-\x7E]+$

SIMグループ名（半角英数字、記号）

Responses

Request samples

Content type
application/json
{
  • "simGroupName": "新IoT_JP9_NSA1"
}

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed"
}

SIMグループ削除

SIMグループ情報を削除する。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed"
}

APNDNN名取得

APN/DNN名を取得する。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed",
  • "apndnnName": "mec-xxxxx.mobile.d-oic.com"
}

SIMグループ作成中件数取得

対象テナントのSIMグループ作成中件数を取得する。

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
{
  • "processingCount": 3
}

SIMグループへのカスタムDNS紐付け登録

SIMグループへのカスタムDNS紐づけを行う。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Request Body schema: application/json
primaryDNS
required
string (primaryDNS) ^(([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])...

プライマリDNS

secondaryDNS
string (secondaryDNS) ^(([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])...

セカンダリDNS

Responses

Request samples

Content type
application/json
{
  • "primaryDNS": "255.255.255.0",
  • "secondaryDNS": "255.255.255.0"
}

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed"
}

SIMグループへのカスタムDNS紐付け削除

SIMグループへのカスタムDNS紐づけ削除を行う。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed"
}

SIMグループへのカスタムDNS紐付け変更

SIMグループへのカスタムDNS紐づけ変更を行う。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Request Body schema: application/json
primaryDNS
required
string (primaryDNS) ^(([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])...

プライマリDNS

secondaryDNS
string (secondaryDNS) ^(([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])...

セカンダリDNS

Responses

Request samples

Content type
application/json
{
  • "primaryDNS": "255.255.255.0",
  • "secondaryDNS": "255.255.255.0"
}

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed"
}

カスタムDNS取得

カスタムDNS取得を行う。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed",
  • "simGroupId": "25001757",
  • "primaryDNS": "255.255.255.0",
  • "secondaryDNS": "255.255.255.0"
}

sim

SIM

SIM一覧取得

SIMグループに属するSIM情報を取得する。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed",
  • "simGroupId": "25001757",
  • "simGroupName": "新IoT_JP9_NSA1",
  • "sims": [
    ],
  • "vgwId": "45000692",
  • "ipaddressNumber": 0,
  • "simuseStartOperation": "0"
}

SIM廃止

SIM廃止を行う。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Request Body schema: application/json
msisdnList
required
Array of strings (msisdn) [ items[0-9]{1-15} ]
required
object

SIM廃止連絡メール送信内容

Responses

Request samples

Content type
application/json
{
  • "msisdnList": [
    ],
  • "mailSendInformation": {
    }
}

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed"
}

SIMステータス変更

AdvancedのSIMに対して移動、開通、利用休止、利用再開を一括で行う。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Request Body schema: application/json
One of
msisdnList
required
Array of strings (msisdn) [ items[0-9]{1-15} ]
processPattern
required
string
Value: "move"

処理パターン
move: グループ移動
activate: 開通
suspend: 利用休止
resume: 利用再開

simGroupName
required
string (simGroupName) [ 1 .. 30 ] characters ^[\x21-\x7E]+$

SIMグループ名（半角英数字、記号）

Responses

Request samples

Content type
application/json
Example
{
  • "msisdnList": [
    ],
  • "processPattern": "move",
  • "simGroupName": "新IoT_JP9_NSA1"
}

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed"
}

SIMグループ作成・SIM発注

AdvancedのSIMグループ作成、SIM発注、vGW発注を行う。

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
mailAddress
required
string <email> (mailAddress)

お問い合わせ先メールアドレス

required
object
object

SIM発注時には指定必須

Responses

Request samples

Content type
application/json
{
  • "mailAddress": "test@example.com",
  • "orders": {
    },
  • "verification": {
    }
}

Response samples

Content type
application/json
{
  • "mecOrderId": "550e8400-e29b-41d4-a716-446655440000"
}

SIM情報取得(全件取得)CSVファイル出力

SIM情報を全件取得し、CSVファイルに出力する。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

SIM詳細取得

SIMの詳細情報を取得する

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

msisdn
required
string (msisdn) [0-9]{1-15}
Example: 819000000002

電話番号

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

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

Responses

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed",
  • "msisdn": "819000000002",
  • "name": "SIGN_SIM1",
  • "session": true,
  • "msisdnState": true,
  • "speed": "d1.minimum",
  • "simProcess": "3",
  • "needsIpAddrMod": true,
  • "vrfId": "2256",
  • "location": "up7tkd01-02ce",
  • "ipAddress": "172.16.125.126"
}

SIM情報変更

Advancedで作成済みのSIMの情報を変更する

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

msisdn
required
string (msisdn) [0-9]{1-15}
Example: 819000000002

電話番号

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

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

Request Body schema: application/json
name
required
string (simName)

SIM名

Responses

Request samples

Content type
application/json
{
  • "name": "SIGN_SIM1"
}

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed"
}

vgw-mecgw

VGW/MECGW詳細

MECGWサービス取得

MECGWサービス取得を行う。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed",
  • "mecgwServiceId": 99999,
  • "sdpfTenantId": "d4c22088caab4a8d98e8804a4f0b4943",
  • "sdpfResourceId": "138",
  • "sdpfTenantList": [
    ],
  • "process": false,
  • "errorMessage": "設定内容の反映に失敗しました。サービス利用をONにして、改めて設定してください。再度エラーになった場合はシステム管理者にお問い合わせください。",
  • "isModifyMecgw": true,
  • "isProcessing": true
}

MECGWサービス登録

MECGWサービス登録及び統合VGWへのMECGW紐づけ登録をする。(SA/NSA共通)

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

Content type
application/json
{
  • "isProcessing": true
}

MECGWサービス削除

MECGWサービス削除 を行う。(5gc/ph2共通)

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

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

MECGWサービス削除可否確認

MECGWサービスの削除が可能かどうかを確認する

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

Content type
application/json
{
  • "isDeletable": true
}

統合VGWサービス取得

統合VGWサービス取得を行う。

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

テナントID

simGroupId
required
string[0-9]*
Example: 25001757

SIMグループID

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

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

Responses

Response samples

Content type
application/json
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed",
  • "location": "up7tkd01-02ce",
  • "locationName": "東京(JP9)",
  • "computeeVlan0Id": "2100",
  • "computeeVlan1Id": "3100",
  • "operatorId": "mec-11111",
  • "saUeAddressPool": "10.127.128.0/24",
  • "saUeAddressPoolOption": null,
  • "nsaUeAddressPool": "20.127.128.0/24",
  • "nsaUeAddressPoolOption": "172.16.0.0/17",
  • "univgwNsaEnabled": true,
  • "univgwSaEnabled": false,
  • "saVgwId": "45000692",
  • "nsaVgwId": "45000002",
  • "edgeArea": "up6tkd01-01ce",
  • "vlanId": "2000",
  • "univgwType": "NSA",
  • "ueHairpinEnabled": true,
  • "simGroupId": "25001757",
  • "simGroupName": "新IoT_JP9_NSA1",
  • "process": false,
  • "errorMessage": "設定内容の反映に失敗しました。サービス利用をONにして、改めて設定してください。再度エラーになった場合はシステム管理者にお問い合わせください。",
  • "isModifyVgw": true,
  • "univgwOperationFlg": "1",
  • "useSlicing": true,
  • "sliceId": "1410001",
  • "apndnnName": "mec-xxxxx.mobile.d-oic.com"
}

usage

利用料情報

利用量取得(ファイル出力用)

利用料情報の取得を行う

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

テナントID

query Parameters
from
required
string
Example: from=2025/10

検索年月日(from)
YYYY/MM形式
検索年月日(to)以前であること。

to
required
string
Example: to=2025/12

検索年月日(to)
YYYY/MM形式
検索年月日(from)以降であること。

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

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

Responses

location

ロケーション情報

ロケーション情報取得

ロケーション情報を取得する

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
{
  • "code": "N00001",
  • "message": "正常終了",
  • "state": "Completed",
  • "locationList": [
    ]
}

mec-account

MECアカウント紐付け情報取得

docomo business SIGNに紐づけたMECアカウント情報を取得する。

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
{
  • "tenantId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "econId": "econXXX",
  • "pjId": "XXX",
  • "mecDirectId": "XXX",
  • "eclWorkspaceId": "wsXXX",
  • "eclWorkspaceName": "SIGN_XXX_YYY",
  • "regions": [
    ]
}