一.查询结束会话类型接口

1、接口概述

查询账户内已设置的所有结束会话类型

2、接口请求

• 请求方式：POST
• 请求url：{HOST}/v202411202/closeSession/selectCloseSessionType/{ACCOUNTID}?sig=SIG
• 请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
• 鉴权文档：接口鉴权
• 频次限制：60次/每分钟
• 查询数据限制：默认返回所有数据
• 请求参数：无

3、返回参数

返回字段说明：

字段	说明
success	成功
name	结束会话类型名称
key	结束会话类型 ID
state	状态（2是启用，1是停用）

返回成功示例：

{
    "success": true,
    "row": {
        "_id": "a3860000-7ec1-11ee-a04c-63320de4b86b",
        "createTime": "2023-11-09 13:34:23",
        "account": "N00000004911",
        "options": [
            {
                "key": "5b29f640-d3b6-11ef-a3aa-61265474b75f",
                "name": "结束会话类型1",
                "state": "2",
                "autoCreate": "0",
                "desc": null
            },
            {
                "key": "5b29f640-d3b6-11ef-a333-612654742115f",
                "name": "结束会话类型2",
                "state": "2",
                "autoCreate": "0",
                "desc": null
            }
        ],
        "type": "webchat",
        "autoUpdateTime": "2025-01-16T03:02:44.840Z"
    },
    "message": "200 ok!"
}

二.修改结束会话类型接口

1、接口概述

对已设置结束会话类型的会话进行修改结束会话类型

2、接口请求

• 请求方式：POST
• 请求url：{HOST}/v202411202/closeSession/updateCloseSessionType/{ACCOUNTID}?sig=SIG
• 请求时请将{HOST}换成对接数据查询查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
• 鉴权文档：接口鉴权
• 频次限制：60次/每分钟

3、请求参数

字段	类型	是否必填	参数说明
_id	string	必填	会话id
sid	string	必填	访客id
exten	string	必填	坐席工号
finishReason	string	必填	结束会话类型名称（value）
finishKey	string	必填	结束会话类型名称（key）

请求参数示例：

{
    "_id": "51013ac0-d708-11ef-9b27-e9e061ce76fc",
    "sid": "a7973254-2c1e-4bdf-98c3-757f22d8406d",
    "exten":"7788",
    "finishReason": "访客离开关闭",
    "finishKey": "5b29f640-d3b6-11ef-a3aa-61265474b75f"
}

返回示例：

{
    "success": true,
    "message": "200 ok!"
}

三.结束会话接口

1、接口概述

通过接口的方式对指定的会话进行关闭并设置结束会话类型，(会话所属坐席必须在线)

2、接口请求

• 请求方式：POST
• 请求url：{HOST}/v202411202/closeSession/closeSession/{ACCOUNTID}?sig=SIG
• 请求时请将{HOST}换成对接数据查询查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
• 鉴权文档：接口鉴权
• 频次限制：60次/每分钟

3、请求参数

字段	类型	是否必填	参数说明
_id	string	必填	会话id
sid	string	必填	访客id
exten	string	必填	坐席工号
finishReason	string	必填	结束会话类型名称（vllue）
finishKey	string	必填	结束会话类型名称（key）

请求体示例：

{
    "_id": "51013ac0-d708-11ef-9b27-e9e061ce76fc",
    "sid": "a7973254-2c1e-4bdf-98c3-757f22d8406d",
    "exten":"7788",
    "finishReason": "访客离开关闭",
    "finishKey": "fae67f40-4ee2-11ef-8172-198cab6f2ac7"
}

返回示例：

{
    "success": true,
    "message": "200 ok!"
}