050IP Phone App API

Overview

This API allows you to control the order of "050IPPhoneApp".
You will need a contract of"050 VoIP SDK" to use This API.

Resource URL

"Globally Common Domain (Global Load Balance)" or "Individual Region Domain (Region)" should be utilized. When using the globally common domain, a connection will be made to the nearest API Gateway according to the Customer's usage details.

1.Base Path(Global Load Balance)

https://api.mail.xxx/v1/050voip

2.Base Path(Region)

https://{region}.api.mail.xxx/v1/050voip

• region is jp|us|uk
• e.g. https://us.api.mail.xxx/v1/050voip

Resource Information

Key	Value
Request Format	JSON
Response Format	JSON
Authentication(OAuth)	Yes

---

Order type

• Order Check（New application）
• Order check（Cancellation application）
• New application
• Charge start
• Cancellation application
• Change password
• New application revocation
• Cancellation application revocation
• International call regulation application
• Answering machine application
• Cancellation International call regulation
• Cancellation Answering machine
• Check Optional feature
• Check Answering machine

Back

Order check(New application)

Check Overlap application.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Apply Number	string	Required
endUserId	Enduser ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	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	Apply Number	string	Required
checkResult	Check Result	string	Required
correlateId	Correlated ID	string	Required
endUserId	Enduser ID	string	Required
ispCode	ISP Code	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
reasonOfResult	Reason of Result	string	Optional
receiveDateTime	Reeive DateTime	dateTime	Required
sendDateTime	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
        }
    }
}

Back

Order check（Cancellation application）

Check Overlap application.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply Datetime	dateTime	Required
applyNumber	Apply Number	string	Required
endUserId	Enduse ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Order Number	string	Required
checkResult	Check Result	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
reasonOfResult	Reason of Result	string	Optional
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

New application

Register the telephone line subscription to new.

POST /v1/050voip/service-orders

Request Parameters

Name	Description	Type	Usage
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	Send DateTime	dateTime	Required
sipPwd	Password	string	Optional
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
rendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

Charge start

Instruct Charge start.

POST /v1/050voip/billings

Request Parameters

Name	Description	Type	Usage
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

Cancellation application

Abolish the registered line.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgVersion	Message Version	string	Required
msgId	Message ID	string	Required
orderType	Order Type	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

Change password

Change password after application.

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

Request Parameters

Name	Description	Type	Usage
{password}	Password	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	Send DateTime	dateTime	Required
sipPwd	Password	string	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyNumber	Order Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgVersion	Message Version	string	Required
msgId	Message ID	string	Required
orderType	Order Type	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipPwd	Password	string	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

New application revocation

Revocate a new application.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgVersion	Message Version	string	Required
msgId	Message ID	string	Required
orderType	Order Type	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

Cancellation application revocation

Revocate a cancellation application.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgVersion	Message Version	string	Required
msgId	Message ID	string	Required
orderType	Order Type	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

International call regulation application

Register international call regulation.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
productCode	Product Number	string	Required
sendDateTime	Send DateTime	dateTime	Required
seq	SEQ Number	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgVersion	Message Version	string	Required
msgId	Message ID	string	Required
orderType	Order Type	string	Required
productCode	Product Number	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

Answering machine application

Register answering machine.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
productCode	Product Number	string	Required
sendDateTime	Send DateTime	dateTime	Required
seq	SEQ Number	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgVersion	Message Version	string	Required
msgId	Message ID	string	Required
orderType	Order Type	string	Required
productCode	Product Number	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

Cancellation International call regulation

Cancel international call regulation.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
productCode	Product Number	string	Required
sendDateTime	Send DateTime	dateTime	Required
seq	SEQ Number	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgVersion	Message Version	string	Required
msgId	Message ID	string	Required
orderType	Order Type	string	Required
productCode	Product Number	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

Cancellation Answering machine

Cancel answering machine.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
productCode	Product Number	string	Required
sendDateTime	Send DateTime	dateTime	Required
seq	SEQ Number	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Accept DateTime	dateTime	Required
acceptNumber	Accept Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
executionDate	Execution Date	date	Required
ispCode	ISP Code	string	Required
msgVersion	Message Version	string	Required
msgId	Message ID	string	Required
orderType	Order Type	string	Required
productCode	Product Number	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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
        }
    }
}

---

Back

Check Optional feature

Check optional feature.

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

Request Parameters

Name	Description	Type	Usage
{id}	Phone Number	string	Required
applyDateTime	Apply DateTime	dateTime	Required
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	Send DateTime	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	Optional feature status	string	Required
applyNumber	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
msgVersion	Message Version	string	Required
msgId	Message ID	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
serviceNumber	Service Number	string	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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"
    }
}

---

Back

Check Answering machine

Check a status of answering machine.

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

Request Parameters

Name	Description	Type	Usage
applyNumber	Order Number	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
ispPwd	ISP Password	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
sendDateTime	Send DateTime	dateTime	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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	Order Number	string	Required
correlateId	Correlate ID	string	Required
endUserId	User ID	string	Required
ispCode	ISP Code	string	Required
msgId	Message ID	string	Required
msgVersion	Message Version	string	Required
orderType	Order Type	string	Required
receiveDateTime	Recieve DateTime	dateTime	Required
sendDateTime	Send DateTime	dateTime	Required
setUpValue itemNo="2501"	Answering machine Status	string	Required
setUpValue itemNo="2502"	Answering machine Password	string	Required
setUpValue itemNo="2511"	Answering machine emailadress1	string	Required
setUpValue itemNo="2512"	Answering machine emailadress2	string	Required
setUpValue itemNo="2513"	Answering machine emailadress3	string	Required
setUpValue itemNo="2521"	Notification conditions of Answering machine emailadress1	string	Required
setUpValue itemNo="2522"	Notification conditions of Answering machine emailadress2	string	Required
setUpValue itemNo="2523"	Notification conditions of Answering machine emailadress3	string	Required
sipUserId	User ID	string	Required
voipNumber	Phone Number	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"
    }
}

• Answering machine Status　⇒　0 : use、4 : not use
• Notification conditions　⇒　recorded : Recording notification、received : Incoming call notification

Back to top