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
Interface Name
Protocol
Request Format
Encoding
Response Format
Interface Description
Access Required
Creat a ticket
HTTPS
POST
UTF-8
JSON
Create a ticket
Common Authentication
(2) Request parameter
Name
Field (Parameter)
Type
Location
Required
Description
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.)
Email
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)
Name
Field (Parameter)
Type
Description
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)
Name
Field (Parameter)
Type
Description
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.
