> For the complete documentation index, see [llms.txt](https://docs.contiple.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.contiple.com/jp/api/open-api/inquiry-history.md).

# お問合せ履歴

## **➊** 顧客チケットリスト <a href="#ticket-list" id="ticket-list"></a>

> * 顧客からお問い合わせされたチケット一覧を取得する API です。
> * プロダクト側では、path パラメータとして **ID（usercode）**&#x3092;必須で指定する必要があり、\
>   指定された ID に紐づいて受付されたチケット一覧を返却します。

{% hint style="danger" %}
**ID は必須項目です。**

チケット作成 API を利用する際には、顧客 ID（識別子）を usercode フィールドに必ず保存してください。
{% endhint %}

#### **(1) インターフェース説明** <a href="#ticket-list-interface" id="ticket-list-interface"></a>

* URL: https\://{domain}.oc.nhncloud.com/{serviceId}/openapi/v1/ticket/enduser/{usercode}/list.json

| インターフェース名 | プロトコル | 呼び出し方向 | エンコード | 結果形式 | インターフェース説明                  | アクセス制限可否 |
| --------- | ----- | ------ | ----- | ---- | --------------------------- | -------- |
| 顧客チケットリスト | HTTPS | GET    | UTF-8 | JSON | 検索条件により、条件に合った顧客のチケットリストを取得 | 共通認証     |

***

#### **(2) リクエストパラメータ定義** <a href="#ticket-list-request" id="ticket-list-request"></a>

| 名称         | 変数         | データタイプ  | 変数タイプ | 必須 | 説明                                                                                                                                                                  |
| ---------- | ---------- | ------- | ----- | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| サービスID     | serviceId  | String  | path  | O  | サービスID，URL PATH内に設定した{serviceId}                                                                                                                                    |
| ユーザーコード    | usercode   | String  | path  | O  | ユーザーコード(唯一の値)。URL PATH内に設定した{usercode}                                                                                                                              |
| カテゴリーID    | categoryId | Integer | query | X  | カテゴリー（受付タイプ）ID                                                                                                                                                      |
| チケットの状態    | status     | String  | query | X  | <p>チケットのステータス。 </p><ul><li>new: アサイン待ち </li><li>open: 処理中 </li><li>reply: 保留中</li><li>solved: 解決</li><li>closed: 完了</li></ul>                                       |
| 言語コード      | language   | String  | query | X  | サービスヘルプセンターの基本言語コード                                                                                                                                                 |
| チャネル       | source     | String  | query | X  | <p>お問い合わせチャネル</p><ul><li>web:PCウェブ</li><li>spweb:モバイルウェブ</li><li>api:API </li></ul><p>複数のチャネルを指定して取得する場合は、カンマ（,）区切りで指定。</p><ul><li>デフォルト: web, spweb, api</li></ul> |
| 整列方式       | sort       | String  | query | X  | <p>整列順序</p><ul><li>デフォルト: updatedDt:desc</li></ul><p>(昇順:asc、降順:desc)</p>                                                                                           |
| ページ        | page       | Integer | query | X  | 基本値: 1                                                                                                                                                              |
| 1ページ当たりの件数 | pageSize   | Integer | query | X  | <ul><li>基本値= 10</li><li>max= 200</li></ul>                                                                                                                          |

***

#### **(3) 結果データ** <a href="#ticket-list-response-data" id="ticket-list-response-data"></a>

| 名称              | 変数               |         |                                                                                                                              |
| --------------- | ---------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| result.contents | ticketId         | String  | チケットID                                                                                                                       |
|                 | subject          | String  | チケットのタイトル                                                                                                                    |
|                 | categoryId       | Integer | 受付タイプID                                                                                                                      |
|                 | categoryName     | String  | 受付タイプ名                                                                                                                       |
|                 | categoryFullName | String  | <p>受付タイプの全階層パス</p><ul><li>「>」で各階層を連結</li></ul>                                                                               |
|                 | status           | String  | <p>チケットのステータス </p><ul><li>new: アサイン待ち </li><li>open: 処理中 </li><li>reply: 保留中</li><li>solved: 解決</li><li>closed: 完了</li></ul> |
|                 | statusName       | String  | ステータス名                                                                                                                       |
|                 | createdDt        | Long    | チケット作成時間                                                                                                                     |
|                 | updatedDt        | Long    | チケットアップデート時間                                                                                                                 |
|                 | displayDt        | String  | 露出時間(yyyy.MM.dd)                                                                                                             |
| result          | total            | Integer | 総件数                                                                                                                          |
|                 | pages            | Integer | 総ページ数                                                                                                                        |
|                 | pageNum          | Integer | 現在のページ                                                                                                                       |
|                 | pageSize         | Integer | 1ページあたりのデータ件数                                                                                                                |

***

#### **(4) Response Body** <a href="#ticket-list-response-body" id="ticket-list-response-body"></a>

```json
{       
  "header": {       
    "resultCode": 200,      
    "resultMessage": "",        
    "isSuccessful": true        
  },        
  "result": {       
    "contents": [       
      {     
        "ticketId": "T1658213182227yb9hI",      
        "subject": "유형11",      
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "reply",      
        "statusName": "추가 확인",      
        "content": null,        
        "createdDt": 1658213182000,     
        "updatedDt": 1658215682000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      },        
      {     
        "ticketId": "T16582131010751o8BM",      
        "subject": "유형10",      
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "solved",     
        "statusName": "답변 완료",      
        "content": null,        
        "createdDt": 1658213101000,     
        "updatedDt": 1658215702000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      },        
      {     
        "ticketId": "T1658213078429EFmxm",      
        "subject": "유형9",       
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "closed",     
        "statusName": "최종 완료",      
        "content": null,        
        "createdDt": 1658213078000,     
        "updatedDt": 1658215720000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      },        
      {     
        "ticketId": "T1658213060072Witj6",      
        "subject": "유형8",       
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "open",       
        "statusName": "문의 확인",      
        "content": null,        
        "createdDt": 1658213060000,     
        "updatedDt": 1658215646000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      },        
      {     
        "ticketId": "T1658212816320fVxqS",      
        "subject": "유형7",       
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "new",        
        "statusName": "접수 완료",      
        "content": null,        
        "createdDt": 1658212816000,     
        "updatedDt": 1658212816000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      },        
      {     
        "ticketId": "T1658211072628h00Qf",      
        "subject": "유형6",       
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "new",        
        "statusName": "접수 완료",      
        "content": null,        
        "createdDt": 1658211073000,     
        "updatedDt": 1658211073000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      },        
      {     
        "ticketId": "T1658211058049HP1U0",      
        "subject": "유형5",       
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "new",        
        "statusName": "접수 완료",      
        "content": null,        
        "createdDt": 1658211058000,     
        "updatedDt": 1658211058000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      },        
      {     
        "ticketId": "T165821104308563aoM",      
        "subject": "유형4",       
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "new",        
        "statusName": "접수 완료",      
        "content": null,        
        "createdDt": 1658211043000,     
        "updatedDt": 1658211043000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      },        
      {     
        "ticketId": "T1658211028245FwMKd",      
        "subject": "유형3",       
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "new",        
        "statusName": "접수 완료",      
        "content": null,        
        "createdDt": 1658211028000,     
        "updatedDt": 1658211028000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      },        
      {     
        "ticketId": "T1658211012753VCyy2",      
        "subject": "유형2",       
        "categoryId": 2542,     
        "categoryName": "유형1-1-1-1-1",      
        "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",      
        "status": "new",        
        "statusName": "접수 완료",      
        "content": null,        
        "createdDt": 1658211013000,     
        "updatedDt": 1658211013000,     
        "contents": null,       
        "attachments": null,        
        "displayDt": "2022.07.19"       
      }     
    ],      
    "total": 12,        
    "pages": 2,     
    "pageNum": 1,       
    "pageSize": 10      
  }     
}
```

***

## **➋** チケット詳細 <a href="#ticket-detail" id="ticket-detail"></a>

* 選択したチケットの問い合わせ内容や対応内容など、詳細情報を取得するAPIです。
* [➊ 顧客チケットリスト](#ticket-list)から取得した、詳細確認が必要なチケットの**チケットID（ticketId）**&#x3092;必須パラメータとして指定し、該当チケットの詳細情報を返却します。

#### **(1) インターフェース説明** <a href="#ticket-detail-interface" id="ticket-detail-interface"></a>

* URL: https\://{domain}.oc.nhncloud.com/{serviceId}/openapi/v1/ticket/enduser/{usercode}/{ticketId}/detail.json

| インターフェース名 | プロトコル | 呼び出し方向 | エンコード | 結果形式 | インターフェース説明       | アクセス制限可否 |
| --------- | ----- | ------ | ----- | ---- | ---------------- | -------- |
| チケット詳細    | HTTPS | GET    | UTF-8 | JSON | 顧客が受け付けたチケット詳細照会 | 共通認証     |

***

#### **(2) リクエストパラメータ定義** <a href="#ticket-detail-request" id="ticket-detail-request"></a>

| 名称     | 変数        | データタイプ | 変数タイプ | 必須 | 説明                               |
| ------ | --------- | ------ | ----- | -- | -------------------------------- |
| サービスID | serviceId | String | path  | O  | サービスID，URL PATH内に設定した{serviceId} |
| ID     | usercode  | String | path  | O  | ID(ユーザー固有ID)、お問い合わせ受付時のusercode  |
| チケットID | ticketId  | String | path  | O  | チケットID                           |
| 言語コード  | language  | String | query | X  | サービスヘルプセンターの基本言語コード              |

***

#### **(3) 結果データ** <a href="#ticket-detail-response-data" id="ticket-detail-response-data"></a>

| 名称             | 変数                                | データタイプ  | 説明                                                                                                                        |
| -------------- | --------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
| result.content | ticketId                          | String  | チケットID                                                                                                                    |
|                | subject                           | String  | サービスID                                                                                                                    |
|                | categoryId                        | Integer | カテゴリー（受付タイプ）ID                                                                                                            |
|                | categoryName                      | String  | カテゴリー名                                                                                                                    |
|                | categoryFullName                  | String  | <p>カテゴリーの全階層パス</p><ul><li>「>」で各階層を連結</li></ul>                                                                            |
|                | status                            | String  | <p>チケットのステータス</p><ul><li>new: アサイン待ち</li><li>open: 処理中</li><li>reply: 保留中</li><li>solved: 解決</li><li>closed: 完了</li></ul> |
|                | statusName                        | String  | ステータス名                                                                                                                    |
|                | content                           | String  | 問い合わせ内容                                                                                                                   |
|                | createdDt                         | Long    | 作成時間                                                                                                                      |
|                | updatedDt                         | Long    | 修正時間                                                                                                                      |
|                | contents                          | Array   | チケット詳細                                                                                                                    |
|                | contents.content                  | String  | 内容詳細                                                                                                                      |
|                | contents.type                     | String  | <p>お問い合わせのタイプ</p><ul><li>enduser: お問い合わせ</li><li>csuser:回答</li></ul>                                                      |
|                | contents.typeName                 | String  | お問い合わせタイプ名                                                                                                                |
|                | contents.createdDt                | Long    | チケット処理時間                                                                                                                  |
|                | contents.displayDt                | String  | <p>内容の露出時間</p><ul><li>yyyy.MM.dd</li></ul>                                                                                |
|                | contents.attachments              | Array   | 処理内容の添付ファイル                                                                                                               |
|                | contents.attachments.attachmentId | String  | 処理内容の添付ファイルID                                                                                                             |
|                | contents.attachments.fileName     | String  | 処理内容の添付ファイル名                                                                                                              |
|                | contents.attachments.contentType  | String  | 処理内容の添付ファイルタイプ                                                                                                            |
|                | contents.attachments.disposition  | String  | <p>処理内容の添付ファイル処理方式</p><ul><li>attachment: 添付ファイル</li></ul>                                                                |
|                | contents.attachments.size         | Long    | 処理内容の添付ファイルサイズ                                                                                                            |
|                | contents.attachments.createdDt    | Long    | 処理内容の添付ファイルのアップロード時間                                                                                                      |
|                | attachments                       | Array   | お問い合わせの添付ファイル                                                                                                             |
|                | attachments.attachmentId          | String  | お問い合わせの添付ファイルID                                                                                                           |
|                | attachments.fileName              | String  | お問い合わせの添付ファイル名                                                                                                            |
|                | attachments.contentType           | String  | お問い合わせの添付ファイルタイプ                                                                                                          |
|                | attachments.disposition           | String  | <p>お問い合わせの添付ファイル処理方式 </p><ul><li>attachment: 添付ファイル</li></ul>                                                             |
|                | attachments.size                  | Long    | お問い合わせの添付ファイルサイズ                                                                                                          |
|                | attachments.createdDt             | Long    | お問い合わせの添付ファイルのアップロード時間                                                                                                    |
|                | attachments.repealFlag            | Boolean | <p>お問い合わせの添付ファイルの削除有無</p><ul><li>削除 X: false</li><li>削除 O: true</li></ul>                                                 |
|                | displayDt                         | String  | <p>露出時間</p><ul><li>yyyy.MM.dd</li></ul>                                                                                   |
| result         | total                             | Integer | 総件数                                                                                                                       |
|                | pages                             | Integer | 総ページ数                                                                                                                     |
|                | pageNum                           | Integer | ページ                                                                                                                       |
|                | pageSize                          | Integer | 1ページあたりのデータ件数                                                                                                             |

***

#### **(4) Response Body** <a href="#ticket-detail-response-body" id="ticket-detail-response-body"></a>

```json
{       
  "header": {       
    "resultCode": 200,      
    "resultMessage": "",        
    "isSuccessful": true        
  },        
  "result": {       
    "content": {        
      "ticketId": "T1658199661153IXTfw",        
      "subject": "유형",      
      "categoryId": 2542,       
      "categoryName": "유형1-1-1-1-1",        
      "categoryFullName": "유형1>유형1-1>유형1-1-1>유형1-1-1-1>유형1-1-1-1-1",        
      "status": "solved",       
      "statusName": "답변 완료",        
      "content": "문의내용",        
      "createdDt": 1658199661000,       
      "updatedDt": 1658279983000,       
      "contents": [     
        {       
          "content": "<p>solved</p>",       
          "type": "reply",      
          "typeName": "답변",     
          "createdDt": 1658279983000,       
          "displayDt": "2025.08.29",        
          "attachments": [      
            {       
              "attachmentId": "a9e126cf01654631acc2d1e56e8c694e",       
              "fileName": "image.png",      
              "contentType": "image/png",       
              "disposition": "attachment",      
              "size": 90576,        
              "createdDt": 1658279969000,
              "repealFlag": true
            }       
          ]     
        },      
        {       
          "content": "<p>append comment</p>",       
          "type": "enduser",        
          "typeName": "질문",     
          "createdDt": 1658279813000,       
          "displayDt": "2025.08.20",        
          "attachments": null       
        },      
        {       
          "content": "<p>append comment</p>",       
          "type": "enduser",        
          "typeName": "질문",     
          "createdDt": 1658216460000,       
          "displayDt": "2025.08.20",        
          "attachments": null       
        },      
        {       
          "content": "<p>solved</p>",       
          "type": "reply",      
          "typeName": "답변",     
          "createdDt": 1658216406000,       
          "displayDt": "2025.08.29",        
          "attachments": null       
        }       
      ],        
      "attachments": null,      
      "displayDt": "2025.08.29"     
    }       
  }     
}
```

***

## **➌** チケット添付ファイルを開く/ダウンロード <a href="#open-file" id="open-file"></a>

* チケットに添付ファイルが存在する場合に、閲覧およびダウンロードを行うためのAPIです。
* [➋ チケット詳細](#ticket-detail)APIで返却された**添付ファイルID（attachmentId）**&#x3092;必須パラメータとして指定する必要があります。

#### **(1) インターフェース説明** <a href="#open-file-interface" id="open-file-interface"></a>

* URL: https\://{domain}.oc.nhncloud.com/{serviceId}/api/v2/ticket/attachments/{id}

| インターフェース名            | プロトコル | 呼び出し方向 | エンコード | 結果形式 | インターフェース説明           | アクセス制限可否 |
| -------------------- | ----- | ------ | ----- | ---- | -------------------- | -------- |
| チケット添付ファイルを開く/ダウンロード | HTTPS | GET    | UTF-8 | JSON | チケット添付ファイルを開く/ダウンロード | 必要なし     |

***

#### **(2) リクエストパラメータ定義** <a href="#open-file-request" id="open-file-request"></a>

| 名称       | 変数        | データタイプ | 変数タイプ | 必須 | 説明                                                                         |
| -------- | --------- | ------ | ----- | -- | -------------------------------------------------------------------------- |
| サービスID   | serviceId | String | path  | O  | サービスID，URL PATH内に設定した{serviceId}                                           |
| 添付ファイルID | id        | String | path  | O  | 添付ファイルID, URL PATH内に設定した{id}                                               |
| 処理方式     | type      | String | query | X  | <p>デフォルト: open</p><ul><li>download: ダウンロード</li><li>open: ブラウザで開く</li></ul> |

***

#### **(3) 結果データ** <a href="#open-file-response-data" id="open-file-response-data"></a>

* File

***

## **➍** 顧客再問合せ <a href="#re-inquiry" id="re-inquiry"></a>

* 顧客が回答内容に対して追加の質問を行えるように実装する際に使用するAPIです。
* [➋ チケット詳細](#ticket-detail)APIで詳細情報を取得した後、顧客が追加質問を入力できるフィールドを提供し、本APIを呼び出すことで、対象チケットに追加の質問が登録されます。

#### **(1) インターフェース説明** <a href="#re-inquiry-interface" id="re-inquiry-interface"></a>

* URL: https\://{domain}.oc.nhncloud.com/{serviceId}/openapi/v1/ticket/enduser/{usercode}/{ticketId}/comment.json

| インターフェース名 | プロトコル | 呼び出し方向 | エンコード | 結果形式 | インターフェース説明        | アクセス制限可否 |
| --------- | ----- | ------ | ----- | ---- | ----------------- | -------- |
| 顧客再問合せ    | HTTPS | POST   | UTF-8 | JSON | チケットIDを基準に再お問い合わせ | 共通認証     |

***

#### **(2) リクエストパラメータ定義** <a href="#re-inquiry-request" id="re-inquiry-request"></a>

| 名称     | 変数          | データタイプ | 変数タイプ | 必須 | 説明                                                                                                                |
| ------ | ----------- | ------ | ----- | -- | ----------------------------------------------------------------------------------------------------------------- |
| サービスID | serviceId   | String | path  | O  | サービスID，URL PATH内に設定した{serviceId}                                                                                  |
| ID     | usercode    | String | path  | O  | ID(ユーザー固有ID)、お問い合わせ受付時のusercode                                                                                   |
| チケットID | ticketId    | String | path  | O  | チケットID                                                                                                            |
| 内容     | comment     | String | body  | O  | 再問合せの内容                                                                                                           |
| 添付ファイル | attachments | String | query | X  | <p>添付ファイルID。複数のファイルを添付する場合は、ファイルIDをカンマ（,）で区切って指定。最大5件まで指定可能。</p><ul><li>例: ファイルID1, ファイルID2, …, ファイルID5</li></ul> |

***

#### **(3) 結果データ** <a href="#re-inquiry-response-data" id="re-inquiry-response-data"></a>

| 名称             | 変数                       | データタイプ | 説明                                                    |
| -------------- | ------------------------ | ------ | ----------------------------------------------------- |
| result.content | content                  | String | 再問合せの内容                                               |
|                | type                     | String | <p>お問い合わせタイプ。</p><p>固定値: enduser</p>                  |
|                | typeName                 | String | お問い合わせタイプ名                                            |
|                | createdDt                | Long   | 作成時間                                                  |
|                | displayDt                | String | <p>露出時間</p><ul><li>yyyy.MM.dd</li></ul>               |
|                | attachments              | Array  | 添付ファイル                                                |
|                | attachments.attachmentId | String | 添付ファイルID                                              |
|                | attachments.fileName     | String | 添付ファイル名                                               |
|                | attachments.contentType  | String | 添付ファイルタイプ                                             |
|                | attachments.disposition  | String | <p>添付ファイル処理方式</p><ul><li>attachment: 添付ファイル</li></ul> |
|                | attachments.size         | Long   | 添付ファイルサイズ                                             |
|                | attachments.createdDt    | Long   | 添付ファイルのアップロード時間                                       |

***

#### **(4) Response Body** <a href="#re-inquiry-response-body" id="re-inquiry-response-body"></a>

```json
{       
  "header": {       
    "resultCode": 200,      
    "resultMessage": "",        
    "isSuccessful": true        
  },        
  "result": {       
    "content": {        
      "content": "<p>append comnment</p>",      
      "type": "enduser",        
      "typeName": null,     
      "createdDt": 1658286589999,       
      "displayDt": null,        
      "attachments": [      
        {       
          "attachmentId": "a9e126cf01654631acc2d1e56e8c694e",       
          "fileName": "image.png",      
          "contentType": "image/png",       
          "disposition": "attachment",      
          "size": 90576,        
          "createdDt": 1658279969000        
        }       
      ]     
    }       
  }     
}
```