Help Center/ Cognitive Engagement Center/ API Reference/ Chatbot Management Interface Reference/ FAQ Configuration Interface/ FAQ Group Creation Interface
Updated on 2023-09-27 GMT+08:00
View PDF
Share

FAQ Group Creation Interface

Interface Method

POST

URL

https://IP:PORT/oifde/rest/api/faqGroup/create

Request

Parameter

Type

Position

Mandatory

Description

model

FaqModel

Body

Yes

FAQ group model.

authToken

String

Body

Yes

Authentication token.

For details, see C3 OIAP Interface Authentication.
Table 1 FaqModel

Parameter

Type

Position

Mandatory

Description

id

Integer

Body

No

Internal sequence number. Set this parameter to -1 during creation. If this parameter is left empty, the default value -1 is used.

tenantId

String

Body

Yes

Tenant ID.

name

String

Body

Yes

Name, which contains a maximum of 64 characters.

description

String

Body

Yes

Description, which contains a maximum of 512 characters.

updateTime

Long

Body

No

Modification time.

The value is in timestamp format.

on

Boolean

Body

No

Activation flag.

true: activation

false: deactivation

amout

Integer

Body

No

Number of FAQs.

language

String

Body

Yes

Language.

en_US: English

zh_CN: Chinese

es_ES: Spanish

ar: Arabic

th_TH: Thai

pt_BR: Portuguese

Response

Parameter

Type

Position

Mandatory

Description

faqGroupModel

FaqModel

Body

No

Q&A data.

faqModel

FaqElementModel

Body

No

Q&A object data.

errorCode

String

Body

Yes

Error code.

  • 0: success
  • Other values: failure

errorMsg

String

Body

No

Error description.

Example

  • Request 
    {
    "authToken": "e***************************",
    "model":{
             "id": -1,
             "tenantId": "00030010",
             "name": "Social Security Related FAQ2",
             "description": "This is a test group.",
             "language": "en_US"
    }
}
  • Response 
    { 
     "errorCode" : "0",
     "errorMsg" : "" 
 }