お問合せ

お問い合わせ受付機能を独自に実装する場合は、以下の手順に沿って実装してください。

  1. 受付タイプリストの取得

    1. Contiple に登録されている受付タイプのリストを取得します。

    2. 取得した受付タイプは、ユーザーが直接選択できるように UIを実装します。

    3. 特定の受付タイプを固定したい場合は、[サービス管理 > チケット > カテゴリー管理] 画面にてカテゴリーID を確認し、category パラメータに固定値として指定してください。

  2. フィールドリストの取得

    1. ユーザーが選択した受付タイプをパラメータとして、フィールドリストを取得します。

    2. 返却されたフィールドリストの Type に応じて、テキストフィールド、ドロップダウン、チェックボックスなどの UI を実装します。

  3. 添付ファイルのアップロード

    1. ファイル添付機能を実装する場合は、ファイルアップロード API を呼び出して添付機能を実装します。

    2. アップロードに成功すると、システムから添付ファイル IDが返却されます。チケット作成時には、当該 IDをパラメータとして指定してください。

  4. チケット作成

    1. お問い合わせを送信する時に、ユーザーが各フィールドに入力した値をパラメータとして、チケット作成 API を呼び出します。

受付タイプリスト

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

  • URL: https://{domain}.oc.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

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

受付タイプフィールドリスト

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

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

チケット添付ファイルアップロード

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

  • ファイルサイズ<10MB

  • ファイル名長さ<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

エラーメッセージ

  • 以下の失敗ケースを参照

失敗ケース

400

  • ファイルサイズが 10MB を超過

    • 10MB以内のファイルのみ添付可能です。

  • ファイル名が 100 文字を超過

    • ファイル名が100文字以内のファイルのみ添付可能です。

  • 許可されていない拡張子

    • 添付できないファイル形式です。

9017

  • ファイルの拡張子と MIME タイプが不一致

    • 許可されるタイプ: "image", "application/pdf", "application/vnd", "text/plain", "application/zip", "application/x-tika-ooxml", "application/x-hwp", "application/x-tika-msoffice", "image/tiff", "audio/mpeg", "audio/wav", "audio/vnd.wave", "audio/x-wav"

    • The file is corrupted or unrecognized.


(6) Response Body (失敗)


チケット作成

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

  • URL: https://{domain}.oc.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 を 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) Request 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

添付ファイルサイズ(byte)

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時間チケットの作成をブロック

最終更新