1:1 Inquiry
➊ Submission Type list
(1) Interface description
URL: https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/ticket/categories.json
URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/ticket/categories.json
URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/ticket/categories.json
Submission type list
HTTPS
GET
UTF-8
JSON
Retrieve the list of submission types associated with the service
Not required
(2) Request parameter
Service ID
serviceId
String
path
O
Service ID configured in the URL path
Parent category ID
parent
Integer
query
X
Child category(Subcategory) list under the parent category
Child category(Subcategory) ID
child
Integer
query
X
Parent list for the child category(Subcategory)
Language code
language
String
query
X
Default helpcenter language of the service
(3) Response data
result.contents
categoryId
Integer
Submission type ID
parent
Integer
Parent submission Type ID
name
String
Submission type name
level
Integer
Submission type depth (1, 2, 3, 4, 5)
path
String
Submission type depth path (Each depth category ID is concatenated using \\)
orderNo
Integer
Display order
languages
Object
Submission type name (Multilingual)
(4) Response Body
➋ Submission Type Fields
(1) Interface description
URL: https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/ticket/field/user/{categoryId}.json
URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/ticket/field/user/{categoryId}.json
URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/ticket/field/user/{categoryId}.json
Submission type fields
HTTPS
GET
UTF-8
JSON
Retrieve fields by submission type
Common Authentication
(2) Request parameter
Service ID
serviceId
String
path
O
Service ID configured in the URL path
Submission type ID
categoryId
Integer
path
O
Submission type ID configured in the URL path
Language code
language
String
query
X
Default helpcenter language of the service
(3) Response data
result.contents
fieldId
Integer
Customer field ID
code
String
Field code
type
String
Field type
title
String
Field name
description
String
Notice
placeholder
String
Place holder
length
Integer
length (0: No length limit)
required
Boolean
Required (true: yes, false: no)
encrypt
Boolean
Encrypt (true: yes, false: no)
holdingText
Boolean
Click to reset (true: yes, false: no)
options
Array
Options
value
String
User input
(4) Response Body
➌ Upload Files
(1) Interface description
URL: https://{domain}.oc.nhncloud.com/{serviceId}/openapi/v1/ticket/attachments/upload.json
URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/openapi/v1/ticket/attachments/upload.json
URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/openapi/v1/ticket/attachments/upload.json
Upload files to the server
HTTPS
POST
UTF-8
JSON
Upload files to the server(ticket)
Common Authentication
(2) Request parameter
Service ID
serviceId
String
path
O
Service ID configured in the URL path
Upload file
file
File
formData
O
Submit the file as form.
Supported file formats: jpg, png, gif, bmp, jpeg, tif, tiff, pdf, txt, hwp, xls, xlsx, doc, docx, ppt, pptx, mp3, wav, zip.
Max file size : <10MB, Max filename length : <100 characters
(3) Response data (Success)
result.content
attachmentId
String
Attachment ID
fileName
String
Attachment name
contentType
String
Attachment type
disposition
String
File disposition
size
Long
Attachment size(byte)
createdDt
Long
Upload attachment date
(4) Response Body (Success)
(5) Response data (Failure)
result.content
exception
String
fixed value : OcException
message
String
Error message
Refer to the failure cases below
Failure cases
400
File size exceeds 10MB
Files can be attached within 10MB.
File name exceeds 100 characters
You can only attach files that named within 100 characters.
Unsupported file extension
This attachment format is not allowed.
9017
File extension and MIME type do not match
Allowed values:
"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 (Failure)
➍ Create a Ticket
(1) Interface description
URL : https://{domain}.oc.nhncloud.com/{serviceId}/openapi/v1/ticket.json
URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/openapi/v1/ticket.json
URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/openapi/v1/ticket.json
Creat a ticket
HTTPS
POST
UTF-8
JSON
Create a ticket
Common Authentication
(2) Request parameter
Service ID
serviceId
String
path
O
Service ID configured in the URL path
Ticket data
request body
Object
body
O
Ticket data(JSON)
Category
categoryId
Integer
O
Category(Submission type) ID
Subject
subject
String
O
Title (Max : 255)
Content
content
String
O
Content Policy: In principle, only plain text is allowed. Submitting content encoded in Base64 may cause issues when viewing tickets due to excessive content length. Images should be uploaded as attachments, or uploaded as files first and then referenced using an HTML img src=""/{serviceId}/api/v2/ticket/attachments/{attachmentId}""/.
Customer information
endUser
Object
O
User(Customer) information
ID
endUser.usercode
String
X
User ID (When the member integration feature is enabled, the platform’s unique user ID can be used as the userCode.
This userCode allows inquiry history to be retrieved for the member.
For non-member inquiries, this value does not need to be provided.)
endUser.email
String
O
User Email (If email information is configured in [Service Management] → [Ticket] → [Email Settings], emails will be sent to the customer using the configured email address during ticket processing.)
Name
endUser.username
String
O
User Name (Required when the email parameter is provided. If not specified, the email cannot be sent.)
Phone
endUser.phone
String
X
Phone
Attachment
attachments
Array
X
Attachment (Up to 5 files can be attached.)
Attachment ID
attachments.attachmentId
String
O
Attachment ID
Type1
typeOne
String
X
Type1 field (Extended system fields)
Type2
typeTwo
String
X
Type2 field (Extended system fields)
Language
language
String
X
Language
Channel (Inbound channel)
source
String
X
Ticket channel (web: Web(Default), spweb: Mobile web, api`: API)
User field
userFields
Array
X
User field
Field code
userFields.code
String
O
Field code (User field)
User Input
userFields.value
String
O
User Input (User field)
(3) Response Body
(4) Response data (Success)
result.content
ticketId
String
Ticekt ID
categoryId
int
Submission type ID
subject
String
Ticket title
content
String
Ticket Contents
status
String
Ticket status (Fixed value: new, open, closed)
createdDt
Long
Created date
updatedDt
Long
Updated date
attachments
Array
Attchment
attachments.attachmentId
String
Attchment ID
attachments.fileName
String
Attchment Name
attachments.contentType
String
Attchment Type
attachments.disposition
String
File disposition
attachments.size
String
Attchment size (byte)
attachments.createdDt
String
Attchment updated date
(5) Response Body (Success)
(6) Response data (Failure)
result.contents
objectName
String
User field : Field code
field
String
User field : Field ID
validate
String
invalid: Invalid value, length: Maximum length exceeded, required: Please enter a value.
key
String
"validate.ticket." + objectName + "." + validate
message
String
"validate.ticket." + objectName + "." + validate
(7-1) Response Body (Failure)
(7-2) Response Body (Failure): Failure due to spam policy
resultCode : 1001
If more than 3 inquiry creation attempts are made from the same IP within 1 minute, ticket creation will be blocked for 24 hours
resultCode : 1002
If more than 10 inquiry creation attempts are made from the same IP within 24 hours, ticket creation will be blocked for 24 hours.
Last updated