search

FAQ

hashtag
➊ 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

hashtag
(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

hashtag
(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

다국어

hashtag
(4) Response Body

hashtag
➋ FAQ List

hashtag
(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

hashtag
(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)

hashtag
(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

hashtag
(4) Response Body

hashtag
➌ FAQ Details

hashtag
(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

hashtag
(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

hashtag
(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) 값이 오늘 외

hashtag
(4) Response Body

hashtag
➍ FAQ Attachment

hashtag
(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

hashtag
(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)

hashtag
(3) Response data

  • File

PreviousNoticeNext1:1 Inquiry

Last updated