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

FAQ Group Query Interface

Interface Method

POST

URL

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

Request

Table 1 Parameters in the request body

Parameter

Type

Position

Mandatory

Description

tenantId

String

Body

Yes

Tenant ID.

language

String

Body

No

Language.

en_US: English

zh_CN: Chinese

es_ES: Spanish

ar: Arabic

th_TH: Thai

pt_BR: Portuguese

name

String

Body

No

Name.

pageNum

Integer

Body

Yes

Page number.

Number of the page to be queried. The value 1 is for the first page.

pageSize

Integer

Body

Yes

Number of records on each page.

authToken

String

Body

Yes

Authentication token.

For details, see C3 OIAP Interface Authentication.

Response

Parameter

Type

Position

Mandatory

Description

data

FaqModel[]

Body

Yes

FAQ group data.

totalSize

Integer

Body

Yes

Total number of records.
Table 2 FaqModel

Parameter

Type

Position

Mandatory

Description

id

Integer

Body

No

Internal sequence number.

tenantId

String

Body

Yes

Tenant ID.

name

String

Body

Yes

Name, which contains a maximum of 64 characters.

description

String

Body

No

Description, which contains a maximum of 512 characters.

language

String

Body

Yes

Language.

en_US: English

zh_CN: Chinese

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

Yes

Number of FAQs.

Example

  • Request
    { 
    "tenantId":"00030010",
    "language":"en_US",
    "name":"",
    "pageNum":1,
    "pageSize":10,
       "authToken": "0*******************************"
 }
  • Response
    {
   "data":    [
            {
         "id": 10003,
         "tenantId": "00030010",
         "name": "FAQ",
         "description": "",
         "language": "en_US",
         "updateTime": 1556260264000,
         "on": false,
         "amout": 1
      },
            {
         "id": 10005,
         "tenantId": "00030010",
         "name": "Social Security Related FAQ",
         "description": "",
         "language": "en_US",
         "updateTime": 1556260257000,
         "on": false,
         "amout": 1
      },
            {
         "id": 10002,
         "tenantId": "00030010",
         "name": "Service Provisioning",
         "description": "",
         "language": "en_US",
         "updateTime": 1554285568000,
         "on": false,
         "amout": 1
      }
   ],
   "totalSize": 3
}