API docs by Redocly

MEEQ API仕様書 (v1.1)

Download OpenAPI specification:Download

URL: https://www.sonynetworksmartplatform.co.jp/meeq/

MEEQ ユーザが利用可能なAPIの仕様書です。リクエスト送信時にAPIライセンスキーを x-api-key ヘッダーに指定して送信してください。

common/account

アカウント検索

アカウント情報を検索する。

query Parameters
accountId
string = 10 characters

アカウント情報ID：半角英数字10桁

staffLastName
string [ 1 .. 32 ] characters

姓（漢字）：全角文字1～32桁

staffFirstName
string [ 1 .. 32 ] characters

名（漢字）：全角文字1～32桁

departmentName
string [ 1 .. 64 ] characters

部署名（漢字）：全角文字1～64桁

email
string <email> [ 1 .. 256 ] characters

メールアドレス：メールアドレス形式かつ1～256桁

accountRole
Array of strings
Items Enum: "parent" "manager" "ope" "viewer"

アカウントロール：parent:代表権限、manager:管理権限、ope:オペレーター権限、viewer:閲覧権限

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 ：asc:昇順、desc：降順

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 0
}

アカウント削除

アカウント情報を削除する。

path Parameters
accountId
required
string = 10 characters

アカウント情報ID：半角英数字10桁

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

アカウント作成

アカウント情報を追加する。

Request Body schema: application/json

アカウント変更情報

staffLastNameKana
required
string [ 1 .. 32 ] characters

姓（カナ）：全角カナ1～32桁

staffFirstNameKana
required
string [ 1 .. 32 ] characters

名（カナ）：全角カナ1～32桁

staffLastName
required
string [ 1 .. 32 ] characters

姓（漢字）：全角文字1～32桁

staffFirstName
required
string [ 1 .. 32 ] characters

名（漢字）：全角文字1～32桁

departmentNameKana
string [ 1 .. 64 ] characters

部署名（カナ）：全角カナ1～64桁

departmentName
string [ 1 .. 64 ] characters

部署名（漢字）：全角文字1～64桁

email
required
string <email> [ 1 .. 256 ] characters

メールアドレス：メールアドレス形式かつ1～256桁

password
required
string

パスワード：8文字以上、複雑なパスワード（大文字、小文字、数字、特殊文字（アルファベット以外）のうち少なくとも3つを含むパスワードまたはパスフレーズ）

accountRole
required
string
Enum: "manager" "ope" "viewer"

アカウントロール：manager:管理権限、ope:オペレーター権限、viewer:閲覧権限（parent:代表権限は選べない）

required
object (Notification)

メール通知情報

Responses

Request samples

Content type
application/json
{
  • "staffLastNameKana": "string",
  • "staffFirstNameKana": "string",
  • "staffLastName": "string",
  • "staffFirstName": "string",
  • "departmentNameKana": "string",
  • "departmentName": "string",
  • "email": "user@example.com",
  • "password": "string",
  • "accountRole": "manager",
  • "notificationConfig": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

common/device/lock

デバイスロック設定

デバイスロックを設定するAPIです。

Request Body schema: application/json

デバイスロック設定情報

deviceLockRule
string [ 1 .. 253 ] characters

デバイスロックルール

currentDeviceLockImeiFlag
required
boolean

現在IMEIデバイスロック設定 (true:設定、false:非設定)

required
Array of objects (targetDeviceList)

対象SIM回線リスト

Responses

Request samples

Content type
application/json
{
  • "deviceLockRule": "string",
  • "currentDeviceLockImeiFlag": true,
  • "targetDeviceList": [
    ]
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

デバイスロック解除

デバイスロックを解除するAPIです。

Request Body schema: application/json

デバイスロック解除情報

required
Array of objects (targetDeviceList)

対象SIM回線リスト

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

common/group

グループ検索

グループ情報を検索する

query Parameters
groupName
string [ 1 .. 64 ] characters

グループ名：全角文字1～64桁

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

billingId
string = 10 characters

請求先情報ID

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 3
}

グループ詳細取得

グループ詳細を取得する

path Parameters
groupId
required
string = 10 characters

グループ情報ID

Responses

Response samples

Content type
application/json
{
  • "groupName": "回線グループA",
  • "simGroupList": [
    ]
}

グループ編集

グループを編集する。グループ名の変更と、所属するSIMの付け替えが可能。

path Parameters
groupId
required
string = 10 characters

グループ情報ID

Request Body schema: application/json

グループ編集情報

groupName
string [ 1 .. 64 ] characters

グループ名：全角文字1～64桁

Array of objects (simDeviceId)

グループ内SIM機器情報リスト　（SIM機器情報ID）

Responses

Request samples

Content type
application/json
{
  • "groupName": "string",
  • "simDeviceIdList": [
    ]
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

グループ削除

グループを削除する

path Parameters
groupId
required
string = 10 characters

SIM回線グループ情報ID

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

グループ追加

グループを追加する。

Request Body schema: application/json

グループ追加情報

groupName
required
string [ 1 .. 64 ] characters

グループ名：全角文字1～64桁

Array of objects (simDeviceId)

SIM機器情報ID：半角英数字10桁

Responses

Request samples

Content type
application/json
{
  • "groupName": "string",
  • "simDeviceIdList": [
    ]
}

Response samples

Content type
application/json
{
  • "groupId": "stringstri"
}

アラート設定詳細取得

アラート設定詳細を取得する。アラート設定はグループと1対1になる。グループの追加時にアラート設定をすべてoffで登録する。そのため、リリース時には、既存のグループに対になるアラート設定を追加しなければならない。を想定しています。

path Parameters
groupId
required
string = 10 characters

SIM回線グループ情報ID

Responses

Response samples

Content type
application/json
{
  • "usageRemainAlert": {
    },
  • "activationLimitAlertInfo": {
    }
}

アラート設定編集

アラート設定を編集する。アラート設定はグループと1対1になる。グループの追加時にアラート設定をすべてoffで登録する。そのため、リリース時には、既存のグループに対になるアラート設定を追加しなければならない。を想定していたため、編集実行時にはすでにレコードが存在していると考え、PUTにしています。

path Parameters
groupId
required
string = 10 characters

グループ情報ID

Request Body schema: application/json

アラート設定編集情報

object (UsageRemainAlert)

利用量残量アラート通知情報

object (UsageRemainAlert)

アクティベーション期限アラート通知情報

Responses

Request samples

Content type
application/json
{
  • "usageRemainAlertInfo": {
    },
  • "activationLimitAlertInfo": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

common/group/globalsim

グローバルSIMグループ検索

グローバルSIMグループ情報を検索する

query Parameters
groupName
string [ 1 .. 64 ] characters

グループ名：全角文字1～64桁

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

billingId
string = 10 characters

請求先情報ID

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 3
}

グローバルSIMグループ詳細取得

グローバルSIMグループ詳細を取得する

path Parameters
globalsimGroupId
required
string = 10 characters

グローバルSIM回線グループ情報ID

Responses

Response samples

Content type
application/json
{
  • "groupName": "回線グループA",
  • "usageAlertLineCount": 0,
  • "activationAlertLineCount": 0,
  • "globalsimGroupList": [
    ]
}

グローバルSIMグループ編集

グローバルSIMグループを編集する。グループ名の変更と、所属するSIMの付け替えが可能。

path Parameters
globalsimGroupId
required
string = 10 characters

グローバルSIMグループ情報ID

Request Body schema: application/json

グローバルSIMグループ編集情報

groupName
string [ 1 .. 64 ] characters

グループ名：全角文字1～64桁

Array of objects (globalsimLineId)

グループ内グローバルSIM回線情報リスト　（グローバルSIM回線情報ID）

Responses

Request samples

Content type
application/json
{
  • "groupName": "string",
  • "globalsimLineIdList": [
    ]
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

グローバルSIMグループ削除

グローバルSIMグループを削除する

path Parameters
globalsimGroupId
required
string = 10 characters

グローバルSIM回線グループ情報ID

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

グローバルSIMグループ追加

グローバルSIMグループを追加する。

Request Body schema: application/json

グローバルSIMグループ追加情報

groupName
required
string [ 1 .. 64 ] characters

グループ名：全角文字1～64桁

Array of objects (globalsimLineId)

グループ内グローバルSIM回線情報リスト　（グローバルSIM回線情報ID）

Responses

Request samples

Content type
application/json
{
  • "groupName": "string",
  • "globalsimLineIdList": [
    ]
}

Response samples

Content type
application/json
{
  • "globalsimGroupId": "GR00000001"
}

グローバルSIMアラート設定詳細取得

アラート設定詳細を取得する。アラート設定はグループと1対1になる。グループの追加時にアラート設定をすべてoffで登録する。そのため、リリース時には、既存のグループに対になるアラート設定を追加しなければならない。を想定しています。

path Parameters
globalsimGroupId
required
string = 10 characters

グローバルSIM回線グループ情報ID

Responses

Response samples

Content type
application/json
{
  • "usageAlert": {
    },
  • "activationAlert": {
    }
}

グローバルSIMグループアラート設定編集

アラート設定を編集する。アラート設定はグループと1対1になる。グループの追加時にアラート設定をすべてoffで登録する。そのため、リリース時には、既存のグループに対になるアラート設定を追加しなければならない。を想定していたため、編集実行時にはすでにレコードが存在していると考え、PUTにしています。

path Parameters
globalsimGroupId
required
string = 10 characters

グローバルSIMグループ情報ID

Request Body schema: application/json

グローバルSIMグループアラート設定編集情報

object (UsageRemainAlert)

利用量アラート通知情報

object (UsageRemainAlert)

アクティベーション期限アラート通知情報

Responses

Request samples

Content type
application/json
{
  • "usageAlertInfo": {
    },
  • "activationAlertInfo": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

common/master/globalsim

利用者グローバルSIM種別取得

利用者のグローバルSIMのSIM種別を取得する

Responses

Response samples

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

グローバルSIMプランマスタ検索

使用可能なグローバルSIMプランマスタの一覧を表示する。

query Parameters
globalsimPlanId
string = 10 characters

グローバルSIMプランID：半角英数字10桁

globalsimPlanCode
string [ 1 .. 11 ] characters

グローバルSIMプランコード：半角英数1～11桁

globalsimPlanName
string [ 1 .. 128 ] characters

グローバルSIMプラン名：全角文字1～128桁

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合 「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 0
}

common/master/plan

SIMプランマスタ検索

プランマスタの一覧を表示する。

query Parameters
simPlanId
string = 10 characters

SIMプランID：半角英数字10桁

simPlanCode
string [ 1 .. 11 ] characters

SIMプランコード：半角英数1～11桁

simPlanName
string [ 1 .. 128 ] characters

SIMプラン名：全角文字1～128桁

simCarrier
string
Enum: "docomo" "kddi" "softbank"

キャリア（docomo:DoCoMo、kddi:KDDI、softbank:SoftBank）

apnName
string [ 1 .. 13 ] characters

APN名：半角文字1～13桁

simType
string
Enum: "prePaid" "postPaid"

SIM種別（prePaid:プリペイド、postPaid：ポストペイド）

useClosed
string
Enum: "off" "on"

閉域利用有無（off：利用しない、on：利用する）

originalFlag
string
Enum: "on" "off"

独自プラン選択フラグ (on:独自プランのみ、off:絞り込みなし)

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 0
}

選択可能チャージプラン一覧取得

指定したSIMプランIDが選択可能なチャージプランを一覧取得する

path Parameters
simPlanId
required
string = 10 characters

SIMプランID：半角英数字10桁

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 1
}

common/master/option

SIMプランオプションマスター検索

SIMプランオプションマスター一覧を取得する。

query Parameters
simPlanOptionId
string = 10 characters

SIMプランオプションID：半角英数字10桁

simPlanOptionCode
string [ 1 .. 11 ] characters

SIMプランオプションコード：半角英数字1～11桁

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 2
}

common/packet/share

パケットシェア情報取得

パケットシェア情報を表示する。

path Parameters
packetShareId
required
string = 10 characters

パケットシェアID：半角英数字10桁

Responses

Response samples

Content type
application/json
{
  • "packetShareId": "string",
  • "packetShareName": "string",
  • "limitScale": "B",
  • "usedScale": "B",
  • "dataLimit": 0,
  • "totalUsedData": 0,
  • "networkType": "internet"
}

パケットシェア名更新

パケットシェア名の更新をする。

path Parameters
packetShareId
required
string = 10 characters

パケットシェアID：半角英数字10桁

Request Body schema: application/json

パケットシェアマスタ変更情報

packetShareName
required
string

パケットシェア名：全角文字1～128桁

Responses

Request samples

Content type
application/json
{
  • "packetShareName": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

パケットシェア解約

パケットシェアを解約する

path Parameters
packetShareId
required
string = 10 characters

パケットシェアID：半角英数字10桁

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

パケットシェア情報検索

パケットシェアマスタ情報を検索するAPIです。

query Parameters
packetShareName
string [ 1 .. 128 ] characters

パケットシェア名：全角文字1～128桁

packetShareStatus
string
Enum: "using" "canceled"

ステータス　(using:利用中、canceled:解約済)

networkType
string
Enum: "internet" "closed"

NETWORK種別　(internet:インターネット、closed:閉域)

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 2
}

common/payment/sales/detail

売上明細検索

売上明細一覧を取得する

query Parameters
departmentName
string [ 1 .. 64 ] characters

部署名（漢字）：全角文字1～64桁

staffLastName
string [ 1 .. 32 ] characters

担当者姓（漢字）：全角文字1～32桁

staffFirstName
string [ 1 .. 32 ] characters

担当者名（漢字）：全角文字1～32桁

salesDateFrom
string <yyyy-MM-dd>

売上年月日（from）

salesDateTo
string <yyyy-MM-dd>

売上年月日 （To）

billingStatus
string
Enum: "unclaimed" "billed" "none"

請求状態（unclaimed:未請求、billed:請求済、none:請求なし）

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 2
}

globalsim

グローバルSIMサービス申請検索

グローバルSIMサービス申請一覧を取得する。リクエスト、レスポンスパラメータとして、申請顧客アカウント名が利用可能である。

query Parameters
entryId
string = 10 characters

申請ID：半角英数字10桁

accountId
string = 10 characters

申請顧客アカウント情報ID：半角英数字10桁

accountName
string [ 0 .. 65 ] characters

申請顧客アカウント名：全角文字3～65桁

globalsimOrderType
string
Enum: "globalsimOrderActivation" "globalsimOrderAutoActivation" "globalsimOrderLimitOverActivation" "globalsimOrderEntry" "globalsimOrderQuit" "globalsimOrderSleepAwake" "globalsimOrderStopRestart" "globalsimPlanEdit"

グローバルSIM申請種別 （globalsimOrderActivation:グローバルSIM手動アクティベーション、globalsimOrderAutoActivation:グローバルSIM自動アクティベーション、globalsimOrderLimitOverActivation:グローバルSIM期間経過アクティベーション、globalsimOrderEntry:グローバルSIM新規発注、globalsimOrderQuit:グローバルSIM解約、globalsimOrderSleepAwake:グローバルSIM利用休止・利用再開、globalsimOrderStopRestart:グローバルSIM一時停止・一時停止再開、globalsimPlanEdit:グローバルSIMプラン変更）

requestStatus
string
Enum: "end" "reject" "partialEnd" "waiting"

申請ステータス （end:完了、reject:却下、partialEnd:部分完了、waiting:申請依頼中）

createDateFrom
string <yyyy-MM-dd>

申請日（from）

createDateTo
string <yyyy-MM-dd>

申請日（to）

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 8
}

グローバルSIM回線検索

グローバルSIM回線情報を検索する。通信量は「等しい」選択時はFrom、Toの両方、「以上」選択時はFrom、「以下」選択時はToに値を入れてリクエストを想定

query Parameters
iccId
string [ 1 .. 64 ] characters

製造番号/ICCID ：半角英数字1～64桁

globalsimStatus
string
Enum: "reserved" "uninitialized" "using" "stoped" "sleep" "quitAccepted" "quitted" "cancel" "forceQuitted"

グローバルSIMステータス：（reserved:発注済、uninitialized:未アクティベーション、using:利用中、stoped:停止中、sleep:休止中、quitAccepted:解約登録済み、quitted:解約、cancel:キャンセル、forceQuitted:強制解約

msisdn
string [ 1 .. 15 ] characters

MSISDN：半角数字1～15桁

lineName
string [ 1 .. 64 ] characters

グローバルSIM回線名：全角文字1～64桁

globalsimGroupId
string = 10 characters

グローバルSIM回線グループID：半角英数字10桁

groupName
string [ 1 .. 64 ] characters

グローバルSIM回線グループ名：全角文字1～64桁

globalsimPlanId
string = 10 characters

グローバルSIMプランID：半角英数字10桁

globalsimPlanName
string [ 1 .. 128 ] characters

グローバルSIMプラン名：全角文字1～128桁

globalsimTypeId
string = 10 characters

グローバルSIM種別ID

accountId
string = 10 characters

アカウント情報ID：半角英数字10桁

staffLastName
string [ 1 .. 32 ] characters

姓（漢字）：全角文字1～32桁

staffFirstName
string [ 1 .. 32 ] characters

名（漢字）：全角文字1～32桁

globalsimLineId
string = 10 characters

グローバルSIM回線情報ID：半角英数字10桁

globalsimDeviceId
string = 10 characters

グローバルSIM機器情報ID：半角英数字10桁

simEntryDateFrom
string <yyyy-MM-dd>

SIM発注日（from）

simEntryDateTo
string <yyyy-MM-dd>

SIM発注日（to）

quittedRecordHidden
string
Enum: "off" "on"

解約レコード非表示（off:表示（省略時表示）on：非表示）。30日超過した解約済SIMは表示対象としません。

trackNO
string

伝票番号

imsi
string [ 1 .. 16 ] characters

imsi：半角数字16桁

trafficUsedFrom
number

通信量（From）：単位はKB

trafficUsedTo
number

通信量（To）：単位はKB

activationLimitDateFrom
string <yyyy-MM-dd>

アクティベーション期限（From）

activationLimitDateTo
string <yyyy-MM-dd>

アクティベーション期限（To）

usageAlert
string

利用量アラート (on:警告、off:－)

activationAlert
string

アクティベーション期限アラート (on:警告、off:－)

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 1
}

グローバルSIM回線詳細表示

グローバルSIM回線の詳細情報を取得する

path Parameters
globalsimLineId
required
string = 10 characters

グローバルSIM回線情報ID：半角英数字10桁

Responses

Response samples

Content type
application/json
{
  • "customerId": "CU00000001",
  • "accountId": "ID00000001",
  • "simEntryDate": "2021-01-01",
  • "activationLimitDate": "2022-01-05",
  • "activationDate": "2021-01-05",
  • "lineName": "回線名称",
  • "groupName": "回線グループA",
  • "iccId": "ICCID00000000000001",
  • "msisdn": 9001234567890,
  • "globalsimPlanName": "SIMプランA",
  • "globalsimType": {
    },
  • "globalsimStatus": "reserved",
  • "orderStatus": "string",
  • "entryId": "stringstri",
  • "globalsimLineId": "L000000001",
  • "globalsimDeviceId": "SD00000001",
  • "trackNO": 33333333,
  • "imsi": 53232
}

globalsim/order

グローバルSIM新規発注申請

グローバルSIMを発注申込する。

Request Body schema: application/json

グローバルSIM新規発注申請

zipCode
required
string = 7 characters

郵便番号:半角数字7桁

addressPrefectures
required
string [ 1 .. 8 ] characters

住所（都道府県）：全角文字1～8桁

addressCity
required
string [ 1 .. 64 ] characters

住所（市区町村）：全角文字1～64桁

addressTown
required
string [ 1 .. 128 ] characters

住所（町名／番地）：全角文字1～128桁

addressOptional
string [ 1 .. 96 ] characters

マンション／ビル名・部屋番号：全角文字1～96桁

contactTel
required
string [ 10 .. 11 ] characters

連絡先電話番号：半角数字10～11桁

daytimeContactTel
string [ 10 .. 11 ] characters

日中連絡先電話番号：半角数字10～11桁

companyName
required
string [ 1 .. 64 ] characters

配送先会社名：全角文字1～64桁

departmentName
required
string [ 1 .. 52 ] characters

配送先部署名：全角文字1～52桁

staffLastName
required
string [ 1 .. 32 ] characters

配送先担当者姓（漢字）：全角文字1～32桁

staffFirstName
required
string [ 1 .. 32 ] characters

配送先担当者名（漢字）：全角文字1～32桁

preferredDeliveryDate
string <yyyy-MM-dd>

配送希望日

actualDeliveryTimezone
string
Enum: "00" "08" "12" "14" "16" "18" "19"

配送時間帯（00：指定なし、08：午前中、12：12:00～14:00、14：14:00～16:00（午後）、16：16:00～18:00、18：18:00～20:00、19：19:00～21:00） （配送希望日がある場合必須，ない場合はなし）

deliveryBoxFlg
required
string
Enum: "off" "on"

宅配ボックス利用可否（off：利用しない、on：利用する）

simNumber
required
integer [ 1 .. 999 ]

SIM枚数 （1000未満の値が設定可能）

amount
integer [ 1 .. 999 ]

数量 （1000未満の値が設定可能。グローバルSIM種別によって上限が異なる）

simCarrier
string
Value: "jt"

キャリア（jt:JT）

globalsimTypeId
required
string = 10 characters

グローバルSIM種別ID

globalsimPlanId
required
string = 10 characters

グローバルSIMプランID：半角英数字10桁

belongGroupId
string = 10 characters

属するグループID。既存のグループに属する場合に設定する。新規の場合は未設定。「新規グループ名」とどちらかの設定が必要。：半角英数字10桁

newGroupName
string [ 1 .. 64 ] characters

新規グループ名。新規のグループに属する場合に設定する。既存の場合は未設定。「属するグループID」とどちらかの設定が必要。：全角文字1～64桁

Responses

Request samples

Content type
application/json
{
  • "zipCode": "strings",
  • "addressPrefectures": "string",
  • "addressCity": "string",
  • "addressTown": "string",
  • "addressOptional": "string",
  • "contactTel": "stringstri",
  • "daytimeContactTel": "stringstri",
  • "companyName": "string",
  • "departmentName": "string",
  • "staffLastName": "string",
  • "staffFirstName": "string",
  • "preferredDeliveryDate": "string",
  • "actualDeliveryTimezone": "00",
  • "deliveryBoxFlg": "off",
  • "simNumber": 1,
  • "amount": 1,
  • "simCarrier": "jt",
  • "globalsimTypeId": "stringstri",
  • "globalsimPlanId": "stringstri",
  • "belongGroupId": "stringstri",
  • "newGroupName": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

グローバルSIM利用休止・利用再開申請

グローバルSIMの利用休止・利用再開をする

Request Body schema: application/json

グローバルSIM利用休止・利用再開申請情報

required
Array of objects (globalsimLineId) = 10 characters

グローバルSIM回線情報ID：半角英数字10桁

operationType
required
string
Enum: "sleep" "awake"

オペレーション区分（sleep：利用休止，awake：利用再開）

sleepReason
required
string
Enum: "waitingStart" "season" "longStop" "other" "resumed"

利用休止理由 （waitingStart：利用開始待ち、season：季節要因による一時休止、longStop：長期休止、other：その他 利用再開の場合、resumed：ユーザ申請）

globalsimPlanId
string = 10 characters

グローバルSIMプランID。利用再開時は設定が必要。利用休止の場合は未設定：半角英数字10桁

Responses

Request samples

Content type
application/json
{
  • "globalsimLineIdList": [
    ],
  • "operationType": "sleep",
  • "sleepReason": "waitingStart",
  • "globalsimPlanId": "stringstri"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

グローバルSIM一時停止・一時停止再開申請

グローバルSIMの一時停止・一時停止再開申請をする

Request Body schema: application/json

グローバルSIM一時停止・一時停止再開申請情報

required
Array of objects (globalsimLineId) = 10 characters

グローバルSIM回線情報ID：半角英数字10桁

operationType
required
string
Enum: "stop" "restart"

オペレーション区分（stop：一時停止，restart：一時停止再開）

stopRestartReason
required
string
Enum: "losted" "paused" "resumed"

一時停止・一時停止再開（利用停止の場合、losted：ユーザ申請（紛失等）、paused：ユーザ申請（休止） 利用再開の場合、resumed：ユーザ申請）

Responses

Request samples

Content type
application/json
{
  • "globalsimLineIdList": [
    ],
  • "operationType": "stop",
  • "stopRestartReason": "losted"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

グローバルSIM解約申請

グローバルSIMの解約申請をする

Request Body schema: application/json

グローバルSIM解約申請情報

required
Array of objects (globalsimLineId) = 10 characters

グローバルSIM回線情報ID：半角英数字10桁

estimatedQuitDate
required
string <yyyy-MM-dd>

解約予定日

quitReasonType
required
string
Enum: "sideGrade" "price" "qualityService" "qualitySupport" "serviceEnd" "other"

解約理由区分（sideGrade：他社乗り換え、price：料金不満、qualityService：品質不満（サービス・通信）、qualitySupport：品質不満（サポート）、serviceEnd：サービス終了、other：その他）

Responses

Request samples

Content type
application/json
{
  • "globalsimLineIdList": [
    ],
  • "estimatedQuitDate": "string",
  • "quitReasonType": "sideGrade"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

グローバルSIMプラン変更申請

グローバルSIMのプランを変更申請する。プラン変更希望日は翌月1日をシステムで自動設定する。

Request Body schema: application/json

グローバルSIMプラン変更申請情報

required
Array of objects (globalsimLineId) = 10 characters

グローバルSIM回線情報ID：半角英数字10桁

globalsimPlanId
required
string = 10 characters

グローバルSIMプランID

Responses

Request samples

Content type
application/json
{
  • "globalsimLineIdList": [
    ],
  • "globalsimPlanId": "stringstri"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

sim

SIM回線検索

SIM回線情報を検索する。通信量・データ残量は「等しい」選択時はFrom、Toの両方、「以上」選択時はFrom、「以下」選択時はToに値を入れてリクエストを想定

query Parameters
iccId
string [ 1 .. 64 ] characters

製造番号/ICCID ：半角英数字1～64桁

status
string
Enum: "reserved" "uninitialized" "using" "stoped" "quitAccepted" "quitted" "cancel" "forceQuitted" "limitedQuitted"

SIMステータス：（reserved:発注済、uninitialized:未アクティベーション、using:利用中、stoped:停止中、quitAccepted:解約登録済み、quitted:解約、cancel:キャンセル、forceQuitted:強制解約、limitedQuitted:有効期限切れ解約）

tel
string [ 11 .. 14 ] characters

電話番号：半角数字11～14桁

lineName
string [ 1 .. 64 ] characters

SIM回線名：全角文字1～64桁

simClosedPlanName
string [ 1 .. 128 ] characters

SIM閉域プラン名：全角文字1～128桁

bandName
string [ 1 .. 128 ] characters

帯域名：全角文字1～128桁

groupId
string = 10 characters

SIM回線グループID：半角英数字10桁

groupName
string [ 1 .. 64 ] characters

SIM回線グループ名：全角文字1～64桁

simPlanId
string = 10 characters

SIMプランID：半角英数字10桁

simPlanName
string [ 1 .. 128 ] characters

SIMプラン名：全角文字1～128桁

simCarrier
string
Enum: "docomo" "kddi" "softbank"

キャリア（docomo:DoCoMo、kddi:KDDI、softbank:SoftBank）

accountId
string = 10 characters

アカウント情報ID：半角英数字10桁

staffLastName
string [ 1 .. 32 ] characters

姓（漢字）：全角文字1～32桁

staffFirstName
string [ 1 .. 32 ] characters

名（漢字）：全角文字1～32桁

simLineId
string [ 9 .. 10 ] characters

SIM回線情報ID：半角英数字9～10桁

simDeviceId
string = 10 characters

SIM機器情報ID：半角英数字10桁

simEntryDateFrom
string <yyyy-MM-dd>

SIM発注日（from）

simEntryDateTo
string <yyyy-MM-dd>

SIM発注日（to）

simType
string
Enum: "prePaid" "postPaid"

SIM種別（prePaid:プリペイド、postPaid：ポストペイド）

activationLimitDateFrom
string <yyyy-MM-dd>

アクティベーション有効期限日（From）

activationLimitDateTo
string <yyyy-MM-dd>

アクティベーション有効期限日（To）

useClosed
string
Enum: "off" "on"

閉域利用有無（off：利用しない、on：利用する）

ipAddress
string <ipv4>

IPアドレス

privateIpAddress
string <ipv4>

プライベート固定IPアドレス（閉域用）

dateLimitStatus
string
Enum: "normal" "dateLimit" "totalLimit" "timer" "charge" "unknown"

通信制御ステータス：(normal:通常、dateLimit:n日間規制中、totalLimit:総量規制中、timer:タイマー起動中、charge:チャージ利用中、unknown:不明)

quittedRecordHidden
string
Enum: "off" "on"

解約レコード非表示（off:表示（省略時表示）on：非表示）。30日超過した解約済SIMは表示対象としません。

trackNO
string

伝票番号

packetShareId
string

パケットシェアID：半角英数字10桁

imei
string [ 1 .. 50 ] characters

imei：半角数字16桁(念のため最大桁数50とする。)

imsi
string [ 1 .. 50 ] characters

imsi：半角数字16桁(念のため最大桁数50とする。)

deviceLockFlag
boolean

デバイスロック設定 (true:あり、false:なし)

deviceLockRule
string [ 1 .. 253 ] characters

デバイスロックルール

trafficUsedFrom
number

通信量（from）単位はB

trafficUsedTo
number

通信量（to）単位はB

dataRemainFrom
number

データ残量（from）単位はB

dataRemainTo
number

データ残量（to）単位はB

usageAlert
string

利用量アラート (on:警告、off:－)

remainAlert
string

残量アラート (on:警告、off:－)

activationLimitAlert
string

アクティベーション期限アラート (on:警告、off:－)

yearlyPaymentId
string = 10 characters

年払い情報ID：半角英数字10桁

yearlyPaymentName
string [ 1 .. 128 ] characters

年払い名：- ※仕様変更により本パラメータの指定はご利用できません。次期バージョンで本パラメータは削除される予定です。

fiveGOptionStatus
string
Enum: "on" "off"

5Gオプション有無：（on:○、off:×)

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 3,
  • "simChargedCount": 0
}

SIM回線詳細表示

SIM回線の詳細情報を取得する

path Parameters
simDeviceId
required
string = 10 characters

SIM機器情報ID：半角英数字10桁

Responses

Response samples

Content type
application/json
{
  • "customerId": "CU00000001",
  • "accountId": "ID00000001",
  • "simEntryDate": "2021-01-01",
  • "activationDate": "2021-01-05",
  • "activationLimitDate": "2022-01-05",
  • "lineName": "回線名称",
  • "groupName": "回線グループA",
  • "iccId": "ICCID00000000000001",
  • "simTel": "09001234567890",
  • "simPlanName": "SIMプランA",
  • "simCarrier": "softbank",
  • "simSize": "nano",
  • "apnName": "APN_閉域",
  • "connectionId": "connectionId",
  • "password": "password",
  • "ipAddress": "192.168.0.1",
  • "privateIpAddress": "192.168.0.1",
  • "simStatus": "reserved",
  • "dateLimitStatus": "normal",
  • "orderStatus": "string",
  • "entryId": "stringstri",
  • "simLineId": "L000000001",
  • "simDeviceId": "SD00000001",
  • "fiveGOptionStatus": "off",
  • "simType": "prePaid",
  • "useClosed": "off",
  • "trackNO": "33333333",
  • "imei": 53232,
  • "imsi": 532532,
  • "deviceLockFlag": true,
  • "deviceLockRule": 53232,
  • "activationExpirationExtendCount": 1
}

SIMサービス申請詳細

SIMサービス申請詳細を取得する。レスポンスパラメータとして、申請顧客アカウント名が利用可能である。

path Parameters
entryId
required
string = 10 characters

申請ID：半角英数字10桁

Responses

Response samples

Content type
application/json
{
  • "simOrder": {
    },
  • "simOrderEntry": {
    },
  • "simOrderActivation": {
    },
  • "simOrderCharge": {
    },
  • "simOrderQuit": {
    },
  • "simOrderStopRestart": {
    },
  • "simOrderDeviceChange": {
    },
  • "simPlanEdit": {
    },
  • "simIpAddresChange": {
    },
  • "simGlobalIpOptionEntry": {
    },
  • "simFiveGOptionEntry": {
    },
  • "packetShareQuitEntry": {
    },
  • "deviceLockEntry": {
    },
  • "deviceUnLockEntry": {
    }
}

SIMサービス申請検索

SIMサービス申請一覧を取得する。リクエスト、レスポンスパラメータとして、申請顧客アカウント名が利用可能である。

query Parameters
entryId
string = 10 characters

申請ID：半角英数字10桁

accountId
string = 10 characters

申請顧客アカウント情報ID：半角英数字10桁

accountName
string [ 0 .. 65 ] characters

申請顧客アカウント名：全角文字3～65桁

simOrderType
string
Enum: "simOrderEntry" "simOrderActivation" "simOrderAutoActivation" "simOrderCharge" "simOrderQuit" "simOrderStopRestart" "simOrderDeviceChange" "simIpAddresChange" "simGlobalIpOptionEntry" "simFiveGOptionEntry" "simPlanEdit" "quitPacketShare" "deviceLock" "deviceUnLock" "dataPlatformEntry"

SIM申請種別 （simOrderEntry:SIM新規発注、simOrderActivation:SIM回線手動アクティベーション、simOrderAutoActivation:SIM回線自動アクティベーション、simOrderCharge:SIMチャージ、simOrderQuit:SIM解約、simOrderStopRestart:SIM利用停止再開、simOrderDeviceChange:SIM交換、simIpAddresChange:IPアドレス変更、simGlobalIpOptionEntry:グローバル固定IPアドレスオプション追加、simFiveGOptionEntry:5Gオプション追加、simPlanEdit:SIMプラン変更 、quitPacketShare:パケットシェア解約、deviceLock:デバイスロック設定申請、deviceUnLock:デバイスロック解除申請）

requestStatus
string
Enum: "end" "reject" "partialEnd" "waiting" "constructionWaiting"

申請ステータス （end:完了、reject:却下、partialEnd:部分完了、waiting:申請依頼中、constructionWaiting:工事待機中）

createDateFrom
string <yyyy-MM-dd>

申請日（from）

createDateTo
string <yyyy-MM-dd>

申請日（to）

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 8
}

SIM回線位置セッション情報取得

SIM回線位置セッション情報を取得する。

query Parameters
simDeviceId
required
string = 10 characters

SIM機器情報ID：半角英数字10桁

sortKey
string

ソートキー：ソートしたい返却項目の変数名を設定する。 例 以下の項目を設定した場合のSQLの例。 ソートキー（sortKey）に'XXXX'（カラム名）、ソート順（sortOrder）に'asc'、一覧取得開始ページ（page）に'3'、一覧取得件数（listSize）に'30'を設定した場合

「ORDER BY XXXX asc LIMIT 30 OFFSET （3 - 1） * 30 -1」

sortOrder
string
Enum: "asc" "desc"

ソート順 （asc:昇順、desc：降順）

page
integer

一覧取得開始ページ

listSize
integer

一覧取得件数

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "totalSize": 2
}

sim/order

SIMチャージ申請

SIMのチャージ申請をする

Request Body schema: application/json

SIMチャージ申請情報

required
Array of objects (simDeviceId) = 10 characters

SIM機器情報ID：半角英数字10桁

chargePlanCode
required
string [ 1 .. 11 ] characters

チャージプランコード：半角英数字1～11桁

Responses

Request samples

Content type
application/json
{
  • "simDeviceIdList": [
    ],
  • "chargePlanCode": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

SIM新規発注申請

SIMを発注申込する。

Request Body schema: application/json

SIM新規発注申請

zipCode
required
string = 7 characters

郵便番号:半角数字7桁

addressPrefectures
required
string [ 1 .. 8 ] characters

住所（都道府県）：全角文字1～8桁

addressCity
required
string [ 1 .. 64 ] characters

住所（市区町村）：全角文字1～64桁

addressTown
required
string [ 1 .. 128 ] characters

住所（町名／番地）：全角文字1～128桁

addressOptional
string [ 1 .. 96 ] characters

マンション／ビル名・部屋番号：全角文字1～96桁

contactTel
required
string [ 10 .. 11 ] characters

連絡先電話番号：半角数字10～11桁

daytimeContactTel
string [ 10 .. 11 ] characters

日中連絡先電話番号：半角数字10～11桁

companyName
required
string [ 1 .. 64 ] characters

配送先会社名：全角文字1～64桁

departmentName
required
string [ 1 .. 52 ] characters

配送先部署名：全角文字1～52桁

staffLastName
required
string [ 1 .. 32 ] characters

配送先担当者姓（漢字）：全角文字1～32桁

staffFirstName
required
string [ 1 .. 32 ] characters

配送先担当者名（漢字）：全角文字1～32桁

preferredDeliveryDate
string <yyyy-MM-dd>

配送希望日

actualDeliveryTimezone
string
Enum: "00" "08" "12" "14" "16" "18" "19"

配送時間帯（00：指定なし、08：午前中、12：12:00～14:00、14：14:00～16:00（午後）、16：16:00～18:00、18：18:00～20:00、19：19:00～21:00） （配送希望日がある場合必須，ない場合はなし）

deliveryBoxFlg
required
string
Enum: "off" "on"

宅配ボックス利用可否（off：利用しない、on：利用する）

simNumber
required
integer [ 1 .. 999 ]

SIM枚数 （1000未満の値が設定可能）

simCarrier
required
string
Enum: "docomo" "kddi" "softbank"

キャリア（docomo:DoCoMo、kddi:KDDI、softbank:SoftBank）

simPlanId
required
string = 10 characters

SIMプランID：半角英数字10桁

belongGroupId
string = 10 characters

属するグループID。既存のグループに属する場合に設定する。新規の場合は未設定。「新規グループ名」とどちらかの設定が必要。：半角英数字10桁

newGroupName
string [ 1 .. 64 ] characters

新規グループ名。新規のグループに属する場合に設定する。既存の場合は未設定。「属するグループID」とどちらかの設定が必要。：全角文字1～64桁

useGlobalIpOption
string
Enum: "off" "on"

グローバル固定IPアドレスオプション利用有無（off：利用しない、on：利用する）

Responses

Request samples

Content type
application/json
{
  • "zipCode": "strings",
  • "addressPrefectures": "string",
  • "addressCity": "string",
  • "addressTown": "string",
  • "addressOptional": "string",
  • "contactTel": "stringstri",
  • "daytimeContactTel": "stringstri",
  • "companyName": "string",
  • "departmentName": "string",
  • "staffLastName": "string",
  • "staffFirstName": "string",
  • "preferredDeliveryDate": "string",
  • "actualDeliveryTimezone": "00",
  • "deliveryBoxFlg": "off",
  • "simNumber": 1,
  • "simCarrier": "docomo",
  • "simPlanId": "stringstri",
  • "belongGroupId": "stringstri",
  • "newGroupName": "string",
  • "useGlobalIpOption": "off"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

SIM交換申請

SIMの交換を申請する

Request Body schema: application/json

SIM交換申請情報

required
Array of objects (simDeviceId) = 10 characters

SIM機器情報ID：半角英数字10桁

zipCode
required
string = 7 characters

郵便番号:半角数字7桁

addressPrefectures
required
string [ 1 .. 8 ] characters

住所（都道府県）：全角文字1～8桁

addressCity
required
string [ 1 .. 64 ] characters

住所（市区町村）：全角文字1～64桁

addressTown
required
string [ 1 .. 128 ] characters

住所（町名／番地）：全角文字1～128桁

addressOptional
string [ 1 .. 96 ] characters

マンション／ビル名・部屋番号：全角文字1～96桁

contactTel
required
string [ 10 .. 11 ] characters

連絡先電話番号：半角数字10～11桁

daytimeContactTel
string [ 10 .. 11 ] characters

日中連絡先電話番号：半角数字10～11桁

companyName
required
string [ 1 .. 64 ] characters

配送先会社名：全角文字1～64桁

departmentName
required
string [ 1 .. 52 ] characters

配送先部署名：全角文字1～52桁

staffLastName
required
string [ 1 .. 32 ] characters

配送先担当者姓（漢字）：全角文字1～32桁

staffFirstName
required
string [ 1 .. 32 ] characters

配送先担当者名（漢字）：全角文字1～32桁

preferredDeliveryDate
string <yyyy-MM-dd>

配送希望日

actualDeliveryTimezone
string
Enum: "00" "08" "12" "14" "16" "18" "19"

配送時間帯（00：指定なし、08：午前中、12：12:00～14:00、14：14:00～16:00（午後）、16：16:00～18:00、18：18:00～20:00、19：19:00～21:00） 配送希望日がある場合必須，ない場合はなし

deliveryBoxFlg
required
string
Enum: "off" "on"

宅配ボックス利用可否（off：利用しない、on：利用する）

changeReason
required
string
Enum: "lost" "sizeSwitched" "other"

交換理由（lost：紛失交換（SIMサイズ切り替えを行わない場合）。sizeSwitched：SIMサイズ切替（SIMサイズ切り替えを行う場合）、other：その他）

Responses

Request samples

Content type
application/json
{
  • "simDeviceIdList": [
    ],
  • "zipCode": "strings",
  • "addressPrefectures": "string",
  • "addressCity": "string",
  • "addressTown": "string",
  • "addressOptional": "string",
  • "contactTel": "stringstri",
  • "daytimeContactTel": "stringstri",
  • "companyName": "string",
  • "departmentName": "string",
  • "staffLastName": "string",
  • "staffFirstName": "string",
  • "preferredDeliveryDate": "string",
  • "actualDeliveryTimezone": "00",
  • "deliveryBoxFlg": "off",
  • "changeReason": "lost"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

SIM回線グローバル固定IPアドレスオプション変更申請(リアルタイム)

SIM回線のグローバル固定IPアドレスオプションを変更する。本APIはリアルタイムにグローバル固定IPのON、OFFの制御を行い、払い出したIPをレスポンスとして返却する。レスポンスのIPリストは、simPlanOptionUseListのoptionをonにしたもののIPリストを返却する。確保に成功した場合はIPを、失敗した場合をnullで返す。simPlanOptionUseListのoptionをoffにするなどの場合は返却しない。

Request Body schema: application/json

グローバル固定IPアドレスオプション変更有無

required
Array of objects (SimPlanOptionUseEditRequest)

SIMプランオプション利用情報リスト

Responses

Request samples

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

Response samples

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

SIM回線IPアドレス変更申請

SIM回線のIPアドレスを変更する

Request Body schema: application/json

SIM回線IPアドレス変更

simDeviceId
required
string = 10 characters

SIM機器情報ID：半角英数字10桁

ipAddress
required
string <ipv4>

IPアドレス

Responses

Request samples

Content type
application/json
{
  • "simDeviceId": "stringstri",
  • "ipAddress": "192.168.0.1"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

SIMプラン変更申請

SIMのプランを変更申請する。プラン変更希望日は翌月1日をシステムで自動設定する。

Request Body schema: application/json

SIMプラン変更申請情報

required
Array of objects (simDeviceId) = 10 characters

SIM機器情報ID：半角英数字10桁

simPlanId
required
string = 10 characters

SIMプランID

Responses

Request samples

Content type
application/json
{
  • "simDeviceIdList": [
    ],
  • "simPlanId": "stringstri"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

SIM解約申請

SIMの解約申請をする

Request Body schema: application/json

SIM解約申請情報

required
Array of objects (simDeviceId) = 10 characters

SIM機器情報ID：半角英数字10桁

estimatedQuitDate
required
string <yyyy-MM-dd>

解約予定日

quitReasonType
required
string
Enum: "sideGrade" "price" "qualityService" "qualitySupport" "serviceEnd" "other"

解約理由区分（sideGrade：他社乗り換え、price：料金不満、qualityService：品質不満（サービス・通信）、qualitySupport：品質不満（サポート）、serviceEnd：サービス終了、other：その他）

Responses

Request samples

Content type
application/json
{
  • "simDeviceIdList": [
    ],
  • "estimatedQuitDate": "string",
  • "quitReasonType": "sideGrade"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}

SIM利用状態変更申請

SIMの利用停止・再開申請をする

Request Body schema: application/json

SIM利用停止・再開申請情報

required
Array of objects (simDeviceId) = 10 characters

SIM機器情報ID：半角英数字10桁

operationType
required
string
Enum: "stop" "restart"

オペレーション区分（stop：利用停止，restart：利用再開）

stopRestartReason
required
string
Enum: "losted" "paused" "resumed"

利用停止・再開理由（利用停止の場合、losted：ユーザ申請（紛失等）、paused：ユーザ申請（休止） 利用再開の場合、resumed：ユーザ申請）

Responses

Request samples

Content type
application/json
{
  • "simDeviceIdList": [
    ],
  • "operationType": "stop",
  • "stopRestartReason": "losted"
}

Response samples

Content type
application/json
{
  • "count": 10,
  • "failedcount": 1
}

SIM回線5Gオプション変更申請

SIM回線の5Gオプションを変更する

Request Body schema: application/json

5Gオプション変更有無

required
Array of objects (SimPlanOptionUseEditRequest)

SIMプランオプション利用情報リスト

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "parameterErrorList": [
    ]
}