更新时间:2025-11-13 GMT+08:00

查询满意度调查配置(getSatisfactionSurveyMode)

场景描述

用户与座席交谈结束后,调用该接口查看当前租间是否开启了满意度调查选项以及满意度调查的具体配置。

接口方法

POST

接口URI

https://域名/apiaccess/ccmessaging/getsatisfactionsurveymode,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

True

appKey字段,用户标识

2

Authorization

string

True

鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

3

ccmessaging-token

string

True

applyToken接口生成的ccmessagign-token

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

language

string

False

满意度调查的语言,取值范围:

  • zh_CN:汉语
  • en_US:英语
  • pt_BR:葡萄牙语
  • ar_SA:阿拉伯语
  • fr_FR:法语
  • es_ES:西班牙语
  • 为空
说明:

该参数受租户级参数“满意度调查支持的语言”控制,当配置的满意度调查语言在租户级参数已配置的语言范围内,该参数才会生效。以下场景,默认使用开租语言:

  • 该参数为空
  • 租户级参数“满意度调查支持的语言”为空
  • 配置的满意度调查语言不在租户级参数已配置的语言范围内

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

说明

1

resultCode

string

响应码

  • 0:成功
  • 13:查询满意度调查配置失败。

2

resultDesc

string

响应描述

3

satisfactionSurvey

object

满意度调查

3.1

surveyType

string

满意度调查类型

WEB:web网页

NO:不调查

3.2

satisfactionLevel

array

满意度等级对象

3.2.1

satisfactionLevelKey

string

满意度等级(1-5)。默认值为:

  • 1:很不满意
  • 2:不满意
  • 3:一般
  • 4:满意
  • 5:很满意

可调用查询满意度调查配置接口查询“配置中心 > 工作台配置 > 满意度调查 > 满意度等级”中的设置的满意度等级或使用上述默认值。满意度等级与按键数字保持一致。

3.2.2

satisfactionLevelDesc

string

满意度描述,默认值为:

  • 很不满意
  • 不满意
  • 一般
  • 满意
  • 很满意

3.3

satisfactionQuestion

Array

False

问卷问题,展示一种或多种:

  • FCR:问题是否已解决
  • NPS:推荐评分
  • CSAT:满意度评分
  • 响应状态码: 400

    错误的请求:请检查请求路径及参数。

  • 响应状态码: 401

    未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景描述:创建外呼任务
  • 请求头:
    {
    	"X-APP-Key": "b*************c7b",
    	"Authorization": "Bearer 1fea*************1d6a15",
    	"Content-Type": "application/json"
    }
  • 请求参数
    {
        "language": "zh_CN"
    }
  • 响应参数:
    {
         "satisfactionSurvey": {
            "surveyType": "WEB",
            "satisfactionLevel": [
                {
                    "satisfactionLevelDesc": "很不满意",
                    "satisfactionLevelKey": "1"
                },
                {
                    "satisfactionLevelDesc": "不满意",
                    "satisfactionLevelKey": "2"
                },
                {
                    "satisfactionLevelDesc": "一般",
                    "satisfactionLevelKey": "3"
                },
                {
                    "satisfactionLevelDesc": "满意",
                    "satisfactionLevelKey": "4"
                },
                {
                    "satisfactionLevelDesc": "很满意",
                    "satisfactionLevelKey": "5"
                }
            ],
            "satisfactionQuestion": [
                "FCR",
                "CSAT",
                "NPS"
            ]
        },
        "resultCode": "0",
        "resultDesc": "Get satisfaction survey mode success!"
    }