FAQ

---

➊ Category List

(1) Interface description

• URL: https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/helpdoc/categories.json

• URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/helpdoc/categories.json

• URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/helpdoc/categories.json

Interface Name	Protocol	Request Format	Encoding	Response Format	Interface Descriptio	Access Required
Category list	HTTPS	GET	UTF-8	JSON	Retrieve the FAQ category list	Not required

---

(2) Request parameter

Name	Field (Parameter)	Type	Location	Required	Description
Service ID	serviceId	String	path	O	Service ID configured in the URL path
Language code	language	String	query	X	Default helpcenter language of the service

---

(3) Response data

Name	Field (Parameter)	Type	Description
result.contents	categoryId	Integer	Category ID
	parent	Integer	Parent category ID
	name	String	Category name
	level	Integer	Depth (1, 2, 3)
	path	String	Depth Path (\level1\level2)
	orderNo	Integer	Sort order (Default Value: 0)
	languages	Object	다국어

---

(4) Response Body

{   
    "header": { 
        "resultCode": 200,  
        "resultMessage": "",    
        "isSuccessful": true    
    },  
    "result": { 
        "contents": [   
            {   
                "categoryId": 2546, 
                "parent": 0,    
                "name": "유형1",  
                "level": 1, 
                "path": "\\",   
                "orderNo": 0,   
                "languages": {  
                    "ko": "유형1",    
                    "th": "พิมพ์1", 
                    "ja": "タイプ1",   
                    "en": "Type1",  
                    "zh": "类型1" 
                }   
            },  
            {   
                "categoryId": 2548, 
                "parent": 2546, 
                "name": "유형1-1",    
                "level": 2, 
                "path": "\\2546\\", 
                "orderNo": 0,   
                "languages": {  
                    "ko": "유형1-1",  
                    "th": "พิมพ์1-1",   
                    "ja": "タイプ1-1", 
                    "en": "Type1-1",    
                    "zh": "类型1-1"   
                }   
            },  
            {   
                "categoryId": 2550, 
                "parent": 2548, 
                "name": "유형1-1-1",  
                "level": 3, 
                "path": "\\2546\\2548\\",   
                "orderNo": 0,   
                "languages": {  
                    "ko": "유형1-1-1",    
                    "th": "พิมพ์1-1-1", 
                    "ja": "タイプ1-1-1",   
                    "en": "Type1-1-1",  
                    "zh": "类型1-1-1" 
                }   
            },  
            {   
                "categoryId": 2547, 
                "parent": 0,    
                "name": "유형2",  
                "level": 1, 
                "path": "\\",   
                "orderNo": 1,   
                "languages": {  
                    "ko": "유형2",    
                    "th": "พิมพ์2", 
                    "ja": "タイプ2",   
                    "en": "Type2",  
                    "zh": "类型2" 
                }   
            },  
            {   
                "categoryId": 2549, 
                "parent": 2546, 
                "name": "유형1-2",    
                "level": 2, 
                "path": "\\2546\\", 
                "orderNo": 1,   
                "languages": {  
                    "ko": "유형1-2",  
                    "th": "พิมพ์1-2",   
                    "ja": "タイプ1-2", 
                    "en": "Type1-2",    
                    "zh": "类型1-2"   
                }   
            },  
            {   
                "categoryId": 2551, 
                "parent": 2548, 
                "name": "유형1-1-2",  
                "level": 3, 
                "path": "\\2546\\2548\\",   
                "orderNo": 1,   
                "languages": {  
                    "ko": "유형1-1-2",    
                    "th": "พิมพ์1-1-2", 
                    "ja": "タイプ1-1-2",   
                    "en": "Type1-1-2",  
                    "zh": "类型1-1-2" 
                }   
            }   
        ]   
    }   
}

---

➋ FAQ List

(1) Interface description

• URL: https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/helpdoc/list.json

• URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/helpdoc/list.json

• URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/helpdoc/list.json

Interface Name	Protocol	Request Format	Encoding	Response Format	Interface description	Access Required
FAQ list	HTTPS	GET	UTF-8	JSON	Retrieve the Help Center FAQ list	Not required

---

(2) Request parameter

Sort Parameter Format and Example

• Format: 필드1:정렬,필드2:정렬,……

• Example: isTop:desc,createdDt:asc

• Default sort(If the category ID is provided) : isTop:desc,isRecommend:desc,updatedDt:desc

• Default sort(If the category ID is empty) : isTop:desc,updatedDt:desc

Name	Field (Parameter)	Type	Location	Required	Description
Service ID	serviceId	String	path	O	Service ID configured in the URL path
Language code	language	String	query	X	Default helpcenter language of the service
Category ID	categoryId	Integer	query	X	FAQ category ID
Keyword	query	String	query	X	Search keyword (scope: FAQ title, contents)
Sort order	sort	String	query	X	Sorting is supported by the isTop, isRecommend, createdDt, and updateDt fields. For multi-field sorting, separate each sort condition with a comma (,). asc : ascending order, desc : descending order
Page	page	Integer	query	X	Page number (Default: 1)
Items per page	pageSize	Integer	query	X	Items per page (Default: 10, MAX: 200)

---

(3) Response data

명칭	변수	데이터 타입	설명
result.contents	helpDocId	Integer	FAQ ID
	title	String	FAQ title
	content	String	FAQ contents
	isRecommend	Boolean	Fixed top (true : fixed, false: not fixed)
	isTop	Boolean	Fixed main screen (true : fixed, false : not fixed)
	createdDt	Long	Created date
	updatedDt	Long	Updated date
	categoryId	Integer	FAQ category ID
	categoryName	String	Category name. Display category names in the language corresponding to the request parameter’s language code.
	isNew	String	New FAQ (true: Display date is today, false : Display date is not today)
result	total	Integer	Total items
	pages	Integer	Total pages
	pageNum	Integer	Page
	pageSize	Integer	Items per page

---

(4) Response Body

{   
    "header": { 
        "resultCode": 200,  
        "resultMessage": "",    
        "isSuccessful": true    
    },  
    "result": { 
        "contents": [   
            {   
                "helpDocId": 3414,  
                "title": "자주 묻는 질문 제목2",    
                "content": "자주 묻는 질문 내용2",  
                "isRecommend": false,   
                "isTop": true,  
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657265718000, 
                "updatedDt": 1657265718000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2551, 
                "categoryName": "유형1-1-2",  
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            },  
            {   
                "helpDocId": 3413,  
                "title": "자주 묻는 질문 제목1",    
                "content": "자주 묻는 질문 내용1",  
                "isRecommend": true,    
                "isTop": true,  
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657265403000, 
                "updatedDt": 1657265403000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2550, 
                "categoryName": "유형1-1-1",  
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            },  
            {   
                "helpDocId": 3423,  
                "title": "자주 묻는 질문 제목11",   
                "content": "자주 묻는 질문 내용11", 
                "isRecommend": false,   
                "isTop": false, 
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657266235000, 
                "updatedDt": 1657266235000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2550, 
                "categoryName": "유형1-1-1",  
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            },  
            {   
                "helpDocId": 3422,  
                "title": "자주 묻는 질문 제목10",   
                "content": "자주 묻는 질문 내용10", 
                "isRecommend": false,   
                "isTop": false, 
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657266185000, 
                "updatedDt": 1657266196000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2550, 
                "categoryName": "유형1-1-1",  
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            },  
            {   
                "helpDocId": 3421,  
                "title": "자주 묻는 질문 제목9",    
                "content": "자주 묻는 질문 내용9",  
                "isRecommend": false,   
                "isTop": false, 
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657266110000, 
                "updatedDt": 1657266110000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2550, 
                "categoryName": "유형1-1-1",  
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            },  
            {   
                "helpDocId": 3420,  
                "title": "자주 묻는 질문 제목8",    
                "content": "자주 묻는 질문 내용8",  
                "isRecommend": false,   
                "isTop": false, 
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657266059000, 
                "updatedDt": 1657266059000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2550, 
                "categoryName": "유형1-1-1",  
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            },  
            {   
                "helpDocId": 3419,  
                "title": "자주 묻는 질문 제목7",    
                "content": "자주 묻는 질문 내용7",  
                "isRecommend": false,   
                "isTop": false, 
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657266009000, 
                "updatedDt": 1657266009000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2550, 
                "categoryName": "유형1-1-1",  
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            },  
            {   
                "helpDocId": 3418,  
                "title": "자주 묻는 질문 제목6",    
                "content": "자주 묻는 질문 내용6",  
                "isRecommend": false,   
                "isTop": false, 
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657265956000, 
                "updatedDt": 1657265956000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2547, 
                "categoryName": "유형2",  
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            },  
            {   
                "helpDocId": 3417,  
                "title": "자주 묻는 질문 제목5",    
                "content": "자주 묻는 질문 내용5",  
                "isRecommend": false,   
                "isTop": false, 
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657265902000, 
                "updatedDt": 1657265902000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2546, 
                "categoryName": "유형1",  
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            },  
            {   
                "helpDocId": 3416,  
                "title": "자주 묻는 질문 제목4",    
                "content": "자주 묻는 질문 내용4",  
                "isRecommend": true,    
                "isTop": false, 
                "readCnt": null,    
                "attachmentYn": null,   
                "createdDt": 1657265838000, 
                "updatedDt": 1657265838000, 
                "parentCategoryList": null, 
                "category": null,   
                "categoryId": 2549, 
                "categoryName": "유형1-2",    
                "categoryFullName": null,   
                "attachments": null,    
                "isNew": false  
            }   
        ],  
        "total": 11,    
        "pages": 2, 
        "pageNum": 1,   
        "pageSize": 10  
    }   
}

---

➌ FAQ Details

(1) Interface description

• URL: https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/helpdoc/detail/{id}.json

• URL (생산 테스트 환경) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/helpdoc/detail/{id}.json

• URL (개발 테스트 환경) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/helpdoc/detail/{id}.json

Interface name	Protocol	Request Format	Encoding	Response Format	Interface Description	Access Required
FAQ details	HTTPS	GET	UTF-8	JSON	Retrieve FAQ content using the FAQ ID	Not required

---

(2) Request parameter

Name	Field (Parameter)	Type	Location	Required	Description
Service ID	serviceId	String	path	O	Service ID configured in the URL path
FAQ ID	id	Integer	path	O	(FAQ) ID configured in the URL path
Language code	language	String	query	X	Default helpcenter language of the service

---

(3) Response data

Name	Field (Parameter)	Type	Description
result.content	helpDocId	Integer	FAQ ID
	title	String	FAQ title
	content	String	FAQ contencs
	isRecommend	Boolean	Fixed top
	isTop	Boolean	Fixed main screen
	readCnt	Integer	Views
	attachmentYn	Boolean	Include attachments
	createdDt	Long	Created date
	updatedDt	Long	Updated date
	parentCategoryList	Array	Parent category
	parentCategoryList.categoryId	Integer	Category ID
	parentCategoryList.parent	Integer	Parent category ID
	parentCategoryList.name	String	Category name
	parentCategoryList.level	Integer	Category Depth (0, 1, 2)
	parentCategoryList.path	String	Category Depth path
	parentCategoryList.orderNo	Integer	Set category display order
	parentCategoryList.languages	Object	Multilingual category name
	category	Object	Category data
	category.categoryId		Category ID
	category.parent		Parent category ID
	category.name		Category name
	category.level		Category Depth (0, 1, 2)
	category.languages		Multilingual category name
	categoryId	Integer	Category ID
	categoryName	String	Category name
	categoryFullName	String	카테고리 전체 경로 명
	attachments	Array	Attachment
	attachments.attachmentId	String	Attachment ID
	attachments.fileName	String	Attachment name
	attachments.contentType	String	Attachment type
	attachments.size	Long	Attachment size
	isNew	String	신규 공지 표시. true: 노출 시간(displayDt) 값이 오늘, false: 노출 시간(displayDt) 값이 오늘 외

---

(4) Response Body

{       
    "header": {     
        "resultCode": 200,      
        "resultMessage": "",        
        "isSuccessful": true        
    },      
    "result": {     
        "content": {        
            "helpDocId": 3413,      
            "title": "자주 묻는 질문 제목1",        
            "content": "<p>자주 묻는 질문 내용1</p>",       
            "isRecommend": true,        
            "isTop": true,      
            "readCnt": 12,      
            "attachmentYn": "Y",        
            "createdDt": 1657265404000,     
            "updatedDt": 1657265404000,     
            "parentCategoryList": [     
                {       
                    "categoryId": 2546,     
                    "parent": 0,        
                    "name": "유형1",      
                    "level": 1,     
                    "path": "\\",       
                    "orderNo": 0,       
                    "languages": {      
                        "ko": "유형1",        
                        "th": "พิมพ์1",     
                        "ja": "タイプ1",       
                        "en": "Type1",      
                        "zh": "类型1"     
                    }       
                },      
                {       
                    "categoryId": 2548,     
                    "parent": 2546,     
                    "name": "유형1-1",        
                    "level": 2,     
                    "path": "\\2546\\",     
                    "orderNo": 0,       
                    "languages": {      
                        "ko": "유형1-1",      
                        "th": "พิมพ์1-1",       
                        "ja": "タイプ1-1",     
                        "en": "Type1-1",        
                        "zh": "类型1-1"       
                    }       
                },      
                {       
                    "categoryId": 2550,     
                    "parent": 2548,     
                    "name": "유형1-1-1",      
                    "level": 3,     
                    "path": "\\2546\\2548\\",       
                    "orderNo": 0,       
                    "languages": {      
                        "ko": "유형1-1-1",        
                        "th": "พิมพ์1-1-1",     
                        "ja": "タイプ1-1-1",       
                        "en": "Type1-1-1",      
                        "zh": "类型1-1-1"     
                    }       
                }       
            ],      
            "category": {       
                "categoryId": 2550,     
                "parent": 2548,     
                "name": "유형1-1-1",      
                "level": 3,     
                "languages": {      
                    "ko": "유형1-1-1",        
                    "th": "พิมพ์1-1-1",     
                    "ja": "タイプ1-1-1",       
                    "en": "Type1-1-1",      
                    "zh": "类型1-1-1"     
                }       
            },      
            "categoryId": 2550,     
            "categoryName": "유형1-1-1",      
            "categoryFullName": "유형1>유형1-1>유형1-1-1",        
            "attachments": [        
                {       
                    "attachmentId": "badf8fac176e42cc85e232e19759ad2f",     
                    "fileName": "nhn.png",      
                    "contentType": "image/png",     
                    "size": 9682        
                },      
                {       
                    "attachmentId": "d4f3667f13c14ddea57cd55b71df868c",     
                    "fileName": "logo_footer.png",      
                    "contentType": "image/png",     
                    "size": 1412        
                }       
            ],      
            "isNew": false      
        }       
    }       
}

---

➍ FAQ Attachment

(1) Interface description

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

• URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/helpdoc/attachments/{id}

• URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/helpdoc/attachments/{id}

Interface Name	Protocol	Request Format	Encoding	Response Format	Interface Description	Access Required
Open and download FAQ attachments	HTTPS	GET	UTF-8	JSON	Open and download FAQ attachments	Not required

---

(2) Request Parameter

Name	Field (Parameter)	Type	Location	Required	Description
Service ID	serviceId	String	path	O	Service ID configured in the URL path
Attachment file ID	id	String	path	O	Attachment file ID
Viewing Method	type	String	query	X	Default: open (download: download, open: open)

---

(3) Response data

• File