お問合せ
➊ 受付タイプリスト
(1) インターフェース説明
URL: https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/ticket/categories.json
URL (生産テスト環境) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/ticket/categories.json
URL(開発テスト環境) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/ticket/categories.json
受付タイプリスト
HTTPS
GET
UTF-8
JSON
サービス内の受付タイプリスト照会
必要なし
(2) リクエストパラメータ定義
サービスID
serviceId
String
path
O
サービスID,URL PATH内に設定した{serviceId}
上位カテゴリーID
parent
Integer
query
X
上位カテゴリーに所属する下位カテゴリーリスト
下位カテゴリーID
child
Integer
query
X
下位カテゴリーに所属する上位カテゴリーリスト
言語コード
language
String
query
X
サービスヘルプセンターの基本言語コード
(3) 結果データ
result.contents
categoryId
Integer
受付タイプID
parent
Integer
上位受付タイプID
name
String
受付タイプ名
level
Integer
受付タイプレベル(1, 2, 3, 4, 5)
path
String
受付タイプ経路(\\で各レベルのカテゴリーIDを接続)
orderNo
Integer
表示手順
languages
Object
カテゴリー多言語名
(4) Response Body
➋ 受付タイプフィールドリスト
(1) インターフェース説明
URL: https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/ticket/field/user/{categoryId}.json
URL (生産テスト環境) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/ticket/field/user/{categoryId}.json
URL(開発テスト環境) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/ticket/field/user/{categoryId}.json
受付タイプフィールドリスト
HTTPS
GET
UTF-8
JSON
受付タイプで対応するフィールドリストを確認
共通認証
(2) リクエストパラメータ定義
サービスID
serviceId
String
path
O
サービスID,URL PATH内に設定した{serviceId}
受付タイプID
categoryId
Integer
path
O
受付タイプID, URL PATH内に設定した{categoryId}
言語コード
language
String
query
X
サービスヘルプセンターの基本言語コード
(3) 結果データ
result.contents
fieldId
Integer
顧客フィールドID
code
String
項目コード
type
String
項目タイプ
title
String
項目名
description
String
案内文句
placeholder
String
題語
length
Integer
最大長さ(0:長さ制限なし)
required
Boolean
必須項目かどうか(true: yes, false: no)
encrypt
Boolean
保存時に暗号化されているかどうか(true: yes, false: no)
holdingText
Boolean
クリック時に削除するかどうか(true: yes, false: no)
options
Array
テキストボックス, チェックボックス, ドロップボックス, 例:[区分1、区分2、...]
value
String
ユーザー入力値
(4) Response Body
➌ チケット添付ファイルアップロード
(1) インターフェース説明
URL: https://{domain}.oc.nhncloud.com/{serviceId}/openapi/v1/ticket/attachments/upload.json
URL (生産テスト環境) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/openapi/v1/ticket/attachments/upload.json
URL(開発テスト環境) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/openapi/v1/ticket/attachments/upload.json
チケット添付ファイルアップロード
HTTPS
POST
UTF-8
JSON
サーバーにファイルアップロード
共通認証
(2) リクエストパラメータ定義
サービスID
serviceId
String
path
O
URL PATH内に設定した{serviceId}
アップロードファイル
file
File
formData
O
ファイルをformに提出。サポートするファイル形式: jpg, png, gif, bmp, jpeg, tif, tiff, pdf, txt, hwp, xls, xlsx, doc, docx, ppt, pptx, mp3, wav, zip. ファイルサイズ<10M、ファイル名長さ<100
(3) 結果データ(成功)
result.content
attachmentId
String
添付ファイルID
fileName
String
添付ファイル名
contentType
String
添付ファイルタイプ
disposition
String
ファイル処理方式(attachment: 添付ファイル)
size
Long
添付ファイルサイズ(byte)
createdDt
Long
ファイル添付時間
(4) Response Body (成功)
(5) 結果データ (失敗)
result.content
exception
String
固定値:OcException
message
String
エラーメッセージ(10MB以下のファイルのみ添付できます。 / ファイル名最大長超過。(100)/このファイル形式は添付できません。
(6) Response Body (失敗)
➍ チケット作成
(1) インターフェース説明
URL: https://{domain}.oc.nhncloud.com/{serviceId}/openapi/v1/ticket.json
URL (生産テスト環境) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/openapi/v1/ticket.json
URL(開発テスト環境) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/openapi/v1/ticket.json
チケット作成
HTTPS
POST
UTF-8
JSON
新規チケットの作成
共通認証
(2) リクエストパラメータ定義
サービスID
serviceId
String
path
O
URL PATH内に設定した{serviceId}
チケット情報
request body
Object
body
O
チケット情報(JSON)
カテゴリー
categoryId
Integer
O
カテゴリー(受付タイプ) ID
タイトル
subject
String
O
タイトル(max=255)
説明
content
String
O
原則として単純テキストのみ許容。Base64内容で提出する場合、チケット確認時の内容が多く問題になることがある。 画像は添付ファイル形式でアップロードするか、ファイルアップロード後htmlの img src=""/{serviceId}/api/v2/ticket/attachments/{attachmentId}""/ と呼んで使用
顧客情報
endUser
Object
O
顧客情報
ID
endUser.usercode
String
X
ID(会員固有ID)。 会員連動機能を使用する場合、プラットフォーム側のユーザー固有IDをusercodeとして使用することができ、該当usercodeを通じて会員の問い合わせ内訳を照会することができる。 非会員問い合わせの場合、値を転送する必要はない。
メール
endUser.email
String
O
メール(サービス 管理 → チケット → メール設定メニューからメール情報を設定した場合、チケット処理時にそのメールアドレスから顧客にメール送信)
名前
endUser.username
String
O
名前(メールパラメータ入力時、入力が必要。 入力しない場合はメール送信不可)
電話
endUser.phone
String
X
電話
添付ファイル
attachments
Array
X
添付ファイル(max 5件)
添付ファイルID
attachments.attachmentId
String
O
添付ファイルID
区分1
typeOne
String
X
区分1(拡張システムフィールド1)
区分2
typeTwo
String
X
区分2(拡張システムフィールド2)
言語
language
String
X
言語
チャンネル
source
String
X
チケットのチャンネル(web: ウェブ, spweb: モバイルウェブ, api: API, 基本値: web)
ユーザーフィールド
userFields
Array
X
ユーザーフィールド
項目コード
userFields.code
String
O
ユーザーフィールド, 項目コード
ユーザー入力値
userFields.value
String
O
ユーザーフィールドのユーザー入力値
(3) Response Body
(4) 結果データ(成功)
result.content
ticketId
String
チケットID
categoryId
int
受付タイプID
subject
String
チケットのタイトル
content
String
チケット内容
status
String
チケットの状態(固定値: new(アサイン待ち); open(処理中); closed(処理完了)
createdDt
Long
チケット作成時間
updatedDt
Long
チケットアップデート時間
attachments
Array
添付ファイル
attachments.attachmentId
String
添付ファイルID
attachments.fileName
String
添付ファイル名
attachments.contentType
String
添付ファイルタイプ
attachments.disposition
String
ファイル処理方式(attachment:添付ファイル)
attachments.size
String
添付ファイルサイズ(byt)
attachments.createdDt
String
チケットアップデート時間
(5) Response Body (成功)
(6) 結果データ (失敗)
result.contents
objectName
String
ユーザーフィールド:項目コード
field
String
ユーザーフィールド:項目ID
validate
String
invalid:無効な値、length:最大長超過、required:項目を入力してください。
key
String
"validate.ticket." + objectName + "." + validate
message
String
"validate.ticket." + objectName + "." + validate
(7-1) Response Body (失敗)
(7-2) Response Body (失敗)
スパム ポリシーの適用による失敗
resultCode : 1001
同一IPで1分以内に3回以上問い合わせ生成を試みる場合、24時間チケット生成を遮断
resultCode : 1002
同一IPで24時間以内に10回以上問い合わせ生成を試みた場合、24時間チケット生成を遮断
Last updated