チケット API

Overview

本APIは、NTT Com各種サービスのサービストラブルチケット情報を管理するAPIです。

Resource URL

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

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

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/business-process/tickets

2.Base Path(Region)

https://{region}.api.ntt.com/v1/business-process/tickets
  • region is jp|us|uk
  • e.g. https://us.api.ntt.com/v1/business-process/tickets
  • 指定できるregionは、将来拡充予定

Resource Information

Key Value
レスポンス フォーマット JSON
認証(OAuth) Yes
帯域制御#1 Yes
  • #1 お客さま接続単位で適切な流量制限を実施

トラブルチケット状況参照

GET /v1/business-process/tickets

Request Parameters

Name Description type mandatory
serviceName サービス名称を指定#1 query argument Yes
  • #1 uno,bhec,ucaas,cloudn,sip-trunking,050plusbiz,ip-voice,smart-pbx,accs,bdp-e,mss
  • 指定できる名称は、随時増加対応予定

Example Request

 GET /v1/business-process/tickets?serviceName=uno

Response Parameters

Name Description type mandatory
accountId アカウントID String
cRef        Enterprise Cloud契約ID String
category    カテゴリ Int Yes
contractId サービスの契約ID String Yes
distinguishName 識別名 String Yes
internalContractId サービス内部契約ID String
serviceName サービス名 String Yes
site サイト String
ticketEndDate チケット終了日 String
ticketName チケット名 String Yes
ticketStartDate チケット開始日 String
ticketUrl チケットURL String
troubleClearEstimationTime トラブル解消予測日時 String
troubleStatus トラブルステータス Int Yes
troubleStatusUpdateDate トラブルステータス更新日時     String
troubleTicketId チケットID    String Yes
resultCount レスポンス件数    Int Yes

Example Result

{
"items":
      [
       {
          "accountId": null, 
          "cRef": null, 
          "category": 2, 
          "contractId": "N*********", 
          "distinguishName": "***別館L3_BE", 
          "internalContractId": null, 
          "serviceName": "L3 ベストエフォートアクセス フレッツタイプ(フレッツ別契約型)", 
          "site": null, 
          "ticketEndDate": null, 
          "ticketName": "test ticket", 
          "ticketStartDate": "2014-03-20T02:22:05Z", 
          "ticketUrl": null, 
          "troubleClearEstimationTime": null, 
          "troubleStatus": 2, 
          "troubleStatusUpdateDate": "2014-03-20T02:22:05Z", 
          "troubleTicketId": "**************"
        }
     ]
      "resultCount":1
     }

トラブルチケット起案

対応予定

トラブルチケット更新

対応予定


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