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

FAQ Group Modification Interface

Interface Method

POST

URL

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

Request

Table 1 Parameters in the request body

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 2 FaqModel

Parameter

Type

Position

Mandatory

Description

id

Integer

Body

Yes

FAQ group ID.

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.

language

String

Body

Yes

Language, which does not take effect and cannot be changed.

updateTime

Long

Body

No

Modification time.

on

Boolean

Body

No

Activation flag.

true: activation

false: deactivation

amout

Integer

Body

No

Number of FAQs.

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.

errorMsg

String

Body

No

Error description.

Example

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