更新时间:2024-09-24 GMT+08:00
分享

问答组查询接口

接口方法

设置成“POST”。

URL

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

请求说明

表1 请求体参数

参数名称

数据类型

参数位置

必选/可选

描述

tenantId

String

body

True

租户ID

language

String

body

False

语言

英文:en_US、

中文:zh_CN、

西班牙语:es_ES、

阿拉伯语:ar、

泰语:th_TH、

葡萄牙语:pt_BR

name

String

body

False

名称

pageNum

int

body

True

页码

分页查询,查询第几页,首页为1

pageSize

int

body

True

每页多少条

authToken

String

body

True

认证token。

请参见C3 智能助手平台接口鉴权方式

响应说明

参数名称

数据类型

参数位置

必选/可选

描述

data

FaqModel[]

body

True

问答组数据

totalSize

int

body

True

总条数

表2 FaqModel

参数名称

数据类型

参数位置

必选/可选

描述

id

int

body

False

内部序号

tenantId

String

body

True

租户ID

name

String

body

True

名称,最大64个字符

description

String

body

False

描述,最大512个字符

language

String

body

True

语言

英文:en_US、

中文:zh_CN

updateTime

long

body

False

修改时间

格式为时间戳

on

boolean

body

False

是否激活

true:激活

false:去激活

amount

int

body

True

Faq数量

报文样例

  • 请求消息样例
    { 
        "tenantId":"00030010",
        "language":"en_US",
        "name":"",
        "pageNum":1,
        "pageSize":10,
           "authToken": "0*******************************"
     }
  • 响应消息样例
    {
       "data":    [
                {
             "id": 10003,
             "tenantId": "00030010",
             "name": "FAQ",
             "description": "",
             "language": "en_US",
             "updateTime": 1556260264000,
             "on": false,
             "amount": 1
          },
                {
             "id": 10005,
             "tenantId": "00030010",
             "name": "Social Security Related FAQ",
             "description": "",
             "language": "en_US",
             "updateTime": 1556260257000,
             "on": false,
             "amount": 1
          },
                {
             "id": 10002,
             "tenantId": "00030010",
             "name": "Service Provisioning",
             "description": "",
             "language": "en_US",
             "updateTime": 1554285568000,
             "on": false,
             "amount": 1
          }
       ],
       "totalSize": 3
    }

相关文档