search

お問合せ履歴

hashtag
➊ 顧客チケットリスト

  • 顧客からお問い合わせされたチケット一覧を取得する API です。

  • プロダクト側では、path パラメータとして ID（usercode）を必須で指定する必要があり、 指定された ID に紐づいて受付されたチケット一覧を返却します。

triangle-exclamation

ID は必須項目です。

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

hashtag
(1) インターフェース説明

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

インターフェース名
プロトコル
呼び出し方向
エンコード
結果形式
インターフェース説明
アクセス制限可否

顧客チケットリスト

HTTPS

GET

UTF-8

JSON

検索条件により、条件に合った顧客のチケットリストを取得

共通認証

hashtag
(2) リクエストパラメータ定義

名称
変数
データタイプ
変数タイプ
必須
説明

サービス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

チケットのステータス。

  • new: アサイン待ち

  • open: 処理中

  • reply: 保留中

  • solved: 解決

  • closed: 完了

言語コード

language

String

query

X

サービスヘルプセンターの基本言語コード

チャネル

source

String

query

X

お問い合わせチャネル

  • web:PCウェブ

  • spweb:モバイルウェブ

  • api:API

複数のチャネルを指定して取得する場合は、カンマ（,）区切りで指定。

  • デフォルト: web, spweb, api

整列方式

sort

String

query

X

整列順序

  • デフォルト: updatedDt:desc

(昇順:asc、降順:desc)

ページ

page

Integer

query

X

基本値: 1

1ページ当たりの件数

pageSize

Integer

query

X

  • 基本値= 10

  • max= 200

hashtag
(3) 結果データ

名称
変数

result.contents

ticketId

String

チケットID

subject

String

チケットのタイトル

categoryId

Integer

受付タイプID

categoryName

String

受付タイプ名

categoryFullName

String

受付タイプの全階層パス

  • 「>」で各階層を連結

status

String

チケットのステータス

  • new: アサイン待ち

  • open: 処理中

  • reply: 保留中

  • solved: 解決

  • closed: 完了

statusName

String

ステータス名

createdDt

Long

チケット作成時間

updatedDt

Long

チケットアップデート時間

displayDt

String

露出時間(yyyy.MM.dd)

result

total

Integer

総件数

pages

Integer

総ページ数

pageNum

Integer

現在のページ

pageSize

Integer

1ページあたりのデータ件数

hashtag
(4) Response Body

hashtag
➋ チケット詳細

  • 選択したチケットの問い合わせ内容や対応内容など、詳細情報を取得するAPIです。

  • ➊ 顧客チケットリストから取得した、詳細確認が必要なチケットのチケットID（ticketId）を必須パラメータとして指定し、該当チケットの詳細情報を返却します。

hashtag
(1) インターフェース説明

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

インターフェース名
プロトコル
呼び出し方向
エンコード
結果形式
インターフェース説明
アクセス制限可否

チケット詳細

HTTPS

GET

UTF-8

JSON

顧客が受け付けたチケット詳細照会

共通認証

hashtag
(2) リクエストパラメータ定義

名称
変数
データタイプ
変数タイプ
必須
説明

サービス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

サービスヘルプセンターの基本言語コード

hashtag
(3) 結果データ

名称
変数
データタイプ
説明

result.content

ticketId

String

チケットID

subject

String

サービスID

categoryId

Integer

カテゴリー（受付タイプ）ID

categoryName

String

カテゴリー名

categoryFullName

String

カテゴリーの全階層パス

  • 「>」で各階層を連結

status

String

チケットのステータス

  • new: アサイン待ち

  • open: 処理中

  • reply: 保留中

  • solved: 解決

  • closed: 完了

statusName

String

ステータス名

content

String

問い合わせ内容

createdDt

Long

作成時間

updatedDt

Long

修正時間

contents

Array

チケット詳細

contents.content

String

内容詳細

contents.type

String

お問い合わせのタイプ

  • enduser: お問い合わせ

  • csuser:回答

contents.typeName

String

お問い合わせタイプ名

contents.createdDt

Long

チケット処理時間

contents.displayDt

String

内容の露出時間

  • yyyy.MM.dd

contents.attachments

Array

処理内容の添付ファイル

contents.attachments.attachmentId

String

処理内容の添付ファイルID

contents.attachments.fileName

String

処理内容の添付ファイル名

contents.attachments.contentType

String

処理内容の添付ファイルタイプ

contents.attachments.disposition

String

処理内容の添付ファイル処理方式

  • attachment: 添付ファイル

contents.attachments.size

Long

処理内容の添付ファイルサイズ

contents.attachments.createdDt

Long

処理内容の添付ファイルのアップロード時間

attachments

Array

お問い合わせの添付ファイル

attachments.attachmentId

String

お問い合わせの添付ファイルID

attachments.fileName

String

お問い合わせの添付ファイル名

attachments.contentType

String

お問い合わせの添付ファイルタイプ

attachments.disposition

String

お問い合わせの添付ファイル処理方式

  • attachment: 添付ファイル

attachments.size

Long

お問い合わせの添付ファイルサイズ

attachments.createdDt

Long

お問い合わせの添付ファイルのアップロード時間

attachments.repealFlag

Boolean

お問い合わせの添付ファイルの削除有無

  • 削除 X: false

  • 削除 O: true

displayDt

String

露出時間

  • yyyy.MM.dd

result

total

Integer

総件数

pages

Integer

総ページ数

pageNum

Integer

ページ

pageSize

Integer

1ページあたりのデータ件数

hashtag
(4) Response Body

hashtag
➌ チケット添付ファイルを開く/ダウンロード

  • チケットに添付ファイルが存在する場合に、閲覧およびダウンロードを行うためのAPIです。

  • ➋ チケット詳細APIで返却された添付ファイルID（attachmentId）を必須パラメータとして指定する必要があります。

hashtag
(1) インターフェース説明

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

インターフェース名
プロトコル
呼び出し方向
エンコード
結果形式
インターフェース説明
アクセス制限可否

チケット添付ファイルを開く/ダウンロード

HTTPS

GET

UTF-8

JSON

チケット添付ファイルを開く/ダウンロード

必要なし

hashtag
(2) リクエストパラメータ定義

名称
変数
データタイプ
変数タイプ
必須
説明

サービスID

serviceId

String

path

O

サービスID，URL PATH内に設定した{serviceId}

添付ファイルID

id

String

path

O

添付ファイルID, URL PATH内に設定した{id}

処理方式

type

String

query

X

デフォルト: open

  • download: ダウンロード

  • open: ブラウザで開く

hashtag
(3) 結果データ

  • File

hashtag
➍ 顧客再問合せ

  • 顧客が回答内容に対して追加の質問を行えるように実装する際に使用するAPIです。

  • ➋ チケット詳細APIで詳細情報を取得した後、顧客が追加質問を入力できるフィールドを提供し、本APIを呼び出すことで、対象チケットに追加の質問が登録されます。

hashtag
(1) インターフェース説明

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

インターフェース名
プロトコル
呼び出し方向
エンコード
結果形式
インターフェース説明
アクセス制限可否

顧客再問合せ

HTTPS

POST

UTF-8

JSON

チケットIDを基準に再お問い合わせ

共通認証

hashtag
(2) リクエストパラメータ定義

名称
変数
データタイプ
変数タイプ
必須
説明

サービス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

添付ファイルID。複数のファイルを添付する場合は、ファイルIDをカンマ（,）で区切って指定。最大5件まで指定可能。

  • 例: ファイルID1, ファイルID2, …, ファイルID5

hashtag
(3) 結果データ

名称
変数
データタイプ
説明

result.content

content

String

再問合せの内容

type

String

お問い合わせタイプ。

固定値: enduser

typeName

String

お問い合わせタイプ名

createdDt

Long

作成時間

displayDt

String

露出時間

  • yyyy.MM.dd

attachments

Array

添付ファイル

attachments.attachmentId

String

添付ファイルID

attachments.fileName

String

添付ファイル名

attachments.contentType

String

添付ファイルタイプ

attachments.disposition

String

添付ファイル処理方式

  • attachment: 添付ファイル

attachments.size

Long

添付ファイルサイズ

attachments.createdDt

Long

添付ファイルのアップロード時間

hashtag
(4) Response Body

前へお問合せ次へ会員認証 (POST)

最終更新