050IP電話アプリ API

Overview

本APIはNTT Comの「050IP電話アプリ」のオーダ種別（新設、変更、廃止など）を支援するAPIです。
ご利用には「050 VoIP SDK」のご契約が必要です。

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。

グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。1

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/050voip

2.Base Path(Region)

https://{region}.api.ntt.com/v1/050voip
  • region is jp|us|uk
  • e.g. https://us.api.ntt.com/v1/050voip

Resource Information

Key Value
リクエスト フォーマット JSON
レスポンス フォーマット JSON
認証(OAuth) Yes

オーダ種別


戻る

オーダチェック（新規）

申込重複を確認する。

GET /v1/050voip/service-orders-dx/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

GET /v1/050voip/service-orders-dx/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "5010", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx"
}

Response Parameters

Name Description Type Usage
applyNumber 申込番号 string Required
checkResult チェック結果 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
reasonOfResult 可否事由 string Optional
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required

Example Result

"orderCheckRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "orderChecks": {
        "orderCheck": {
            "applyInfoForOc": {
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "applyPossStatus": {
                "checkResult": "false", 
                "reasonOfResult": 130
            }, 
            "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
            "version": 1
        }
    }
}


戻る

オーダチェック（解約）

申込重複を確認する。

GET /v1/050voip/service-orders-dx2/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

GET /v1/050voip/service-orders-dx2/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "5020", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
applyNumber 申込番号 string Required
checkResult チェック結果 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
reasonOfResult 可否事由 string Optional
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"orderCheckRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "orderChecks": {
        "orderCheck": {
            "applyInfoForOc": {
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "applyPossStatus": {
                "checkResult": "true"
            }, 
            "lineInfoForOc": {
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
            "version": 1
        }
    }
}


戻る

新規申込

VoIP電話回線加入申込を新規に登録する。

POST /v1/050voip/service-orders

Request Parameters

Name Description Type Usage
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required
sipPwd SIPパスワード string Optional
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

POST /v1/050voip/service-orders
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "1010", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"sipPwd": "xxxxxxxx", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
receiveDateTime 受信日時 dateTime Required
rendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"orderLineRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 1010, 
            "version": 1
        }
    }
}


戻る

課金開始

課金開始を指示する。

POST /v1/050voip/billings

Request Parameters

Name Description Type Usage
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

POST /v1/050voip/billings
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "1030", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"startChargeRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 1030, 
            "version": 1
        }
    }
}


戻る

廃止

登録済み回線を廃止する。

DELETE /v1/050voip/service-orders/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

DELETE /v1/050voip/service-orders/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "1050", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgVersion メッセージ版 string Required
msgId メッセージID string Required
orderType オーダ種別 string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"cancelLineRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 1050, 
            "version": 1
        }
    }
}


戻る

パスワード変更

申込後にSIPパスワードを変更する。

PUT /v1/050voip/internal-password/{password}

Request Parameters

Name Description Type Usage
{password} SIPパスワード string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required
sipPwd SIPパスワード string Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

PUT /v1/050voip/internal-password/xxxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "1061", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"sipPwd": "xxxxxxxx", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyNumber 申込番号 string Required
applyDateTime 申込日時 dateTime Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgVersion メッセージ版 string Required
msgId メッセージID string Required
orderType オーダ種別 string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipPwd SIPパスワード string Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"changePasswordRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "sipPwd": "xxxxxxxx", 
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "version": 1, 
            "orderType": 1061
        }
    }
}


戻る

新規申込取消

新規申込を取消する。

PUT /v1/050voip/service-orders/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

PUT /v1/050voip/service-orders/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "6010", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgVersion メッセージ版 string Required
msgId メッセージID string Required
orderType オーダ種別 string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"changeServiceRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 6010, 
            "version": 1
        }
    }
}


戻る

廃止申込取消

廃止申込を取消する。

PUT /v1/050voip/service-orders/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

PUT /v1/050voip/service-orders/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "6050", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgVersion メッセージ版 string Required
msgId メッセージID string Required
orderType オーダ種別 string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"changeServiceRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 6050, 
            "version": 1
        }
    }
}


戻る

国際電話不取扱い申込

国際電話不取扱いを登録する。

PUT /v1/050voip/service-orders2/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
productCode 商品コード string Required
sendDateTime 送信日時 dateTime Required
seq SEQ番号 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

PUT /v1/050voip/service-orders2/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "2110", 
"productCode": "AD01ON", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"seq": "21", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgVersion メッセージ版 string Required
msgId メッセージID string Required
orderType オーダ種別 string Required
productCode 商品コード string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"changeServiceRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "productCode": {
                    "content": "AD01ON", 
                    "seq": 21
                }, 
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 2110, 
            "version": 1
        }
    }
}


戻る

留守番電話申込

留守番電話を登録する。

PUT /v1/050voip/service-orders2/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
productCode 商品コード string Required
sendDateTime 送信日時 dateTime Required
seq SEQ番号 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

PUT /v1/050voip/service-orders2/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "2510", 
"productCode": "AD05ON", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"seq": "25", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgVersion メッセージ版 string Required
msgId メッセージID string Required
orderType オーダ種別 string Required
productCode 商品コード string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"changeServiceRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "productCode": {
                    "content": "AD05ON", 
                    "seq": 25
                }, 
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 2510, 
            "version": 1
        }
    }
}


戻る

国際電話不取扱い解約

国際電話不取扱いを廃止する。

PUT /v1/050voip/service-orders2/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
productCode 商品コード string Required
sendDateTime 送信日時 dateTime Required
seq SEQ番号 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

PUT /v1/050voip/service-orders2/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "2150", 
"productCode": "AD01OF", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"seq": "21", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgVersion メッセージ版 string Required
msgId メッセージID string Required
orderType オーダ種別 string Required
productCode 商品コード string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"changeServiceRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "productCode": {
                    "content": "AD01OF", 
                    "seq": 21
                }, 
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 2150, 
            "version": 1
        }
    }
}


戻る

留守番電話解約

留守番電話を廃止する。

PUT /v1/050voip/service-orders2/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
productCode 商品コード string Required
sendDateTime 送信日時 dateTime Required
seq SEQ番号 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

PUT /v1/050voip/service-orders2/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "2550", 
"productCode": "AD05OF", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"seq": "25", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
acceptDateTime 受付日時 dateTime Required
acceptNumber 受付番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
executionDate 実行予定日 date Required
ispCode ISP識別コード string Required
msgVersion メッセージ版 string Required
msgId メッセージID string Required
orderType オーダ種別 string Required
productCode 商品コード string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"changeServiceRs": {
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }, 
    "serviceOrders": {
        "serviceOrder": {
            "acceptInfo": {
                "acceptDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
                "acceptNumber": "xxxxxxxxxxxxx", 
                "executionDate": "xxxx-xx-xx"
            }, 
            "applyInfoForSo": {
                "applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "lineInfoForSo": {
                "productCode": {
                    "content": "AD05OF", 
                    "seq": 25
                }, 
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 2550, 
            "version": 1
        }
    }
}


戻る

付加サービス契約状況

付加サービスの契約状況を確認する。

GET /v1/050voip/option-service-orders/{id}

Request Parameters

Name Description Type Usage
{id} VoIP電話番号 string Required
applyDateTime 申込日時 dateTime Required
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

GET /v1/050voip/option-service-orders/050xxxxxxxx
{
"applyDateTime": "xxxx-xx-xxxxx:xx:xx", 
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "2070", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx"
}

Response Parameters

Name Description Type Usage
addServiceStatus 付加サービス状況値 string Required
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
msgVersion メッセージ版 string Required
msgId メッセージID string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
serviceNumber サービス番号 string Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

"checkAddServiceContractRs": {
    "addServiceContractInfo": {
        "addServiceContract": {
            "applyInfoForAsc": {
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx
            }, 
            "linesInfoForAsc": {
                "lineCurrentDataForAsc": {
                    "addServicesInfo": {
                        "addServiceInfo": {
                            "0": {
                                "addServiceStatus": {}, 
                                "serviceNumber": {}
                            }, 
                            "1": {
                                "addServiceStatus": 610, 
                                "serviceNumber": 21
                            }, 
                            "2": {
                                "addServiceStatus": 610, 
                                "serviceNumber": "2A"
                            }
                        }
                    }, 
                    "lineInfoForAsc": {
                        "sipUserId": xxxxxxxx, 
                        "voipNumber": "050xxxxxxxx"
                    }
                }
            }, 
            "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
            "version": 1
        }
    }, 
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }
}


戻る

留守番電話設定状態

留守番電話の設定状況を確認する。

GET /v1/050voip/option-service-orders/config

Request Parameters

Name Description Type Usage
applyNumber 申込番号 string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
ispPwd ISP識別パスワード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
sendDateTime 送信日時 dateTime Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

GET /v1/050voip/option-service-orders/050xxxxxxxx
{
"applyNumber": "xxxxxxxxxxxx", 
"endUserId": "xxxxxxxxxx", 
"ispCode": "xxxxx", 
"ispPwd": "xxxxxxxxxx", 
"msgId": "xxxxxxxxxxxxxx", 
"msgVersion": "1.0", 
"orderType": "2570", 
"sendDateTime": "xxxx-xx-xxxxx:xx:xx", 
"sipUserId": "xxxxxxxx", 
"voipNumber": "050xxxxxxxx"
}

Response Parameters

Name Description Type Usage
applyNumber 申込番号 string Required
correlateId 関連ID string Required
endUserId エンドユーザID string Required
ispCode ISP識別コード string Required
msgId メッセージID string Required
msgVersion メッセージ版 string Required
orderType オーダ種別 string Required
receiveDateTime 受信日時 dateTime Required
sendDateTime 送信日時 dateTime Required
setUpValue itemNo="2501" 留守番でんわ状態 string Required
setUpValue itemNo="2502" パスワード string Required
setUpValue itemNo="2511" 留守番でんわ通知メールアドレス1 string Required
setUpValue itemNo="2512" 留守番でんわ通知メールアドレス2 string Required
setUpValue itemNo="2513" 留守番でんわ通知メールアドレス3 string Required
setUpValue itemNo="2521" 留守番でんわ通知メールアドレス1の通知条件 string Required
setUpValue itemNo="2522" 留守番でんわ通知メールアドレス2の通知条件 string Required
setUpValue itemNo="2523" 留守番でんわ通知メールアドレス3の通知条件 string Required
sipUserId SIPユーザID string Required
voipNumber VoIP電話番号 string Required

Example Result

checkAddServicesetInfoRs": {
    "AddServicesetInfos": {
        "AddServicesetInfo": {
            "ApplyInfoForASS": {
                "applyNumber": "xxxxxxxxxxxx", 
                "endUserId": "xxxxxxxxxx", 
                "ispCode": xxxxx, 
                "sipUserId": xxxxxxxx, 
                "voipNumber": "050xxxxxxxx"
            }, 
            "orderType": 2570, 
            "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx", 
            "setsInfo": {
                "setInfo": {
                    "0": {
                        "itemNo": 2501, 
                        "content": 4
                    }, 
                    "1": {
                        "itemNo": 2511, 
                        "content": "xxxx1@mail.xxx"
                    }, 
                    "2": {
                        "itemNo": 2521, 
                        "content": "recorded"
                    }, 
                    "3": {
                        "itemNo": 2512, 
                        "content": "xxxx2@mail.xxx"
                    }, 
                    "4": {
                        "itemNo": 2522, 
                        "content": "received"
                    }, 
                    "5": {
                        "itemNo": 2513, 
                        "content": "xxxx3@mail.xxx"
                    }, 
                    "6": {
                        "itemNo": 2523, 
                        "content": "received"
                    }
                }
            }, 
            "version": 1
        }
    }, 
    "ispInfo": {
        "ispCode": xxxxx
    }, 
    "msgInfo": {
        "correlateId": "xxxxxxxxxxxxxx", 
        "msgId": "xxxxxxxxxxxxxx", 
        "msgVersion": 1, 
        "receiveDateTime": "xxxx-xx-xxxxx:xx:xx", 
        "sendDateTime": "xxxx-xx-xxxxx:xx:xx.xxxxxxx+xx:xx"
    }
}
  • 留守番でんわ状態　⇒　0 : 利用しない、4 : 利用する
  • 通知条件　⇒　recorded : 録音通知、received : 着信通知

トップに戻る

  1. 2014/12現在、DNSラウンドロビン運用。準備出来次第、お客さまの地理的に近いAPIゲートウェイに自動接続予定です。別途アナウンスします。 ↩