单点登录

注意，本接口的使用需要进行接口鉴权

一、单点登录说明

1.接口简介

本接口实现的业务场景是：在用户第三方系统嵌入七陌云客服系统，用户方可以在自己系统集成我们的客服模块，通过token验证的方式自动登录七陌云客服系统。

2.单点登录步骤

第三方调用七陌提供的接口获取 token，然后将 token 带到公有云地址中并访问， 校验成功后即可自动登录。token有效时间为5分钟，下次获取token之前，且token登录进去以后8个小时内没有操作或者请求的话就会自动失效。

二、获取 token 接口介绍

  • HTTP请求方式：POST

  • 请求链接：{HOST}/v20160818/sso/getToken/{ACCOUNTID}?sig={SIG}

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则

  • 鉴权文档：接口鉴权

  • 请求示例：

https://apis.7moor.com/v20160818/sso/getToken/N00000012351?sig=SIG

请求体：

字段 类型 是否必须 备注
account String 是 账户编号
exten String 是 座席号
password String 是 座席登陆密码，为加密值(7moor[固定字符]+account [账户编号]+exten [坐席号]+password[坐席密码]+ timeStamp [如20170712135437]),加密方式：32位小写的md5加密
extentype String 是 座席登陆方式，Local(手机接听，需绑定手机号)、sip（企话宝接听或在线客服登录）、gateway（话机、坐席接听）。如果值为字符串 null 则视为此次单点登录不使用呼叫功能，并隐藏电话条等头部功能
timeStamp String 是 请求的时间戳，用于座席登陆密码加密（时间戳是当前系统时间,格式"yyyyMMddHHmmss"）
module String 是 跳转自动定位模块，传 null 则视为默认模块

注意：密码加密所用时间戳和传参中的时间戳必须一致。

请求体示例

{
    "exten":"8000",
    "password":"3757ac77ab6b7cfc3249f55532e67ecd",
    "extentype":"null",
    "timeStamp":"20170417135455",
    "module":"call"
}

返回值说明：

code String 返回编码，成功为 200
message String 返回值信息
token String token 值，只有返回值为 200 才会有

code：

代码 含义
200 请求成功
401 账户编号不正确或未开通呼叫中心产品
402 座席不存在
403 校验不通过，请求失败
404 座席密码错误

返回200示例

{"code":"200","message":"200 ok!","token":"c26b910ef6f549cf7c594a985fb70d4c"}

三、登陆方式

1.获取 token 成功之后访问

http://kf.7moor.com/?token=c26b910ef6f549cf7c594a985fb70d4c

注意：如果查询出来的请求域名{HOST}是https://openapis.7moor.com，则获取 token 成功之后访问地址域名需要将http://kf.7moor.com替换为http://ykf.7moor.com。

以此种形式访问系统当 token 校验成功之后则可以正常登陆 如开启了通话功能此次登陆同样会占用 licence。

可通过busyType控制电话条状态，默认busyType为1，如果需要坐席的软电话条默认空闲，可指定busyType为0。示例：

https://kf.7moor.com?token=834c0707084cb1XXdd32d21&busyType=0

此种单点登录方式与正常登陆校验相同，同样受当前设备状态，licence 数量的限制；并且 只要发起单点登录访问此 token 便失效，无论登陆成功与否都需要重新获取 token

四、登陆模块介绍（module 参数说明）

null 默认工作台
call 通话模块
webchat 在线客服模块
email 邮件客服模块
customer 用户资料模块
business 工单模块
km 知识库模块
monitor 监控模块
report 报表模块
questionnaire 问卷调查模块
qualityCheck 质检模块
sms 短信模块
my_call_sheet_leak 我的未接来电模块
url_interface 首页对接模块
config 设置模块

注意：如所传模块账号并无此权限则会跳转到默认模块