技能接口文档摘要.docVIP

技能接口文档 版本：1.0 北京天润融通科技有限公司 2012年 11月26日 Revision History Name Date Reason For Changes Version 罗尧 12/11/26 初始 1.0 引言 编写目的 为开发人员提供一个规范化的接口协议，以实现与第三方平台的互操作，进行业务定制。 背景 本协议适用于天润托管型呼叫中心Clink平台与第三方的基于B/S架构的系统间的行为、数据及事件的交互与传递。本协议承载于HTTP协议，严格遵守HTTP协议规范。本协议的大部分数据传递采用JSON格式，采用JSON协议框架。 定义 参考资料 RFC2616，HTTP协议 RFC2617，HTTP认证 XML协议 Uniform Resource Identifier (URI): Generic Syntax 概述 规范 1 技能接口 通过接口添加技能、修改技能、删除技能、查看企业所有技能。 1.1 新建或修改接口 接口类型：HTTP 接口使用账户：企业账户 接口地址：呼叫中心系统IP 接口参数：企业账号、企业账户密码、技能id、名称、备注 接口返回值：操作结果 接口说明 添加或修改一个技能。 接口URL URL示例： /interfaceAction/skillInterface!save.action?enterpriseId=3000008userName=adminpassword=e10adc3949ba59abbe56e057f20f883ename=%E5%8C%97%E4%BA%ACcomment=%E5%8C%97%E4%BA%AC 说明：该示例中password = e10adc3949ba59abbe56e057f20f883e = MD5Encoder.encode(123456)。name值是经过URLEncode按“UTF-8”格式编码的，中文是“北京”。 参数说明 参数 要求 描述 备注 enterpriseId 必选 企业Id 例如:3000008 userName 必选 角色名称 例如:admin password 必选 登录密码 两种方式加密（必须二选一）。 1.对应username的密码，md5(登录密码)，例如：md5(123456) 2.密码和seed进行MD5加密，格式：md5(md5(对应userName的密码)+seed)，例如：md5(md5(123456)seed) seed 可选 随机字符串 采用第二种加密方式时seed为必选。 id 可选 技能id 技能id,如新增不用传. name 必选 技能名称 需进行URLEncode编码 comment 必选 描述 需进行URLEncode编码 返回值 JSON串，格式为{result:xxx,msg:xxx},result表示返回结果状态码，msg表示结果状态的描述。 如果新增技能成功,将返回技能Id，JSON串格式为{result:xxx,msg:xxx,id:xxx} result与msg属性值的定义： result msg success 保存成功 error 失败原因 1.2 删除接口 接口类型：HTTP 接口使用账户：企业账户 接口地址：呼叫中心系统IP 接口参数：企业账号、企业账户密码、技能Id 接口返回值：操作结果 接口说明 删除一个指定技能。 接口URL URL示例： /interfaceAction/skillInterface!delete.action?enterpriseId=3000008userName=adminpassword=e10adc3949ba59abbe56e057f20f883eid=6 说明：该示例中password = e10adc3949ba59abbe56e057f20f883e = MD5Encoder.encode(123456)。 参数说明 参数 要求 描述 备注 enterpriseId 必选 企业Id 例如:3000008 userName 必选 角色名称 例如:admin password 必选 登录密码 两种方式加密（必须二选一）。 1.对应username的密码，md5(登录密码)，例如：md5(123456) 2.密码和seed进行MD5加密，格式：md5(md5(对应userName的密码)+seed)，例如：md5(md5(123456)seed) seed 可选 随机字符串 采用第二种加密方式时seed为必选。 id 必选 技能编号 技能id 返回值 JSON串，格式为{result:xxx,msg: