400总机分机接口说明文档.doc

新联协同通信技术（北京）有限公司 400总机接口文档 400总机分机（超级总机）接口文档 2011/6  目录 1 接口概述 3 2 接口身份验证 3 3 接口具体实现 3 3.1 创建分机 3 3.2 更新分机信息 4 3.3 删除分机 5 4 事件推送机制 6 4.1 中继呼入 6 4.2 响铃 7 4.3 应答 8 4.4 挂机 9  接口概述 接口基于HTTP协议实现，通过URL的GET、POST方式进行参数传递 接口数据返回统一采用JSON格式 接口身份验证 该文档中涉及的接口，统一采用企业400号码和登录密码进行身份验证。为了提高安全性，接口中的密码采用MD5加密的方式传递，即：MD5(‘企业密码’)。 接口具体实现 创建分机 Request URL规范： http://XLP_HOST/interface/data/ext.php 调用方式：POST 参数说明： 参数 要求 描述 备注 必选 值为” create” verifymethod 必选 验证方式 值为”pwd”固定值, loginid 必选 即企业400号码 loginpwd 必选 原始密码用MD5加密，如：md5(‘123456’) extname 可选 分机名称 ext 必选 Response 返回内容： 成功： {code:0,msg:操作成功！} 失败： {code:-1,msg:失败信息} 更新分机信息 Request URL规范： http://XLP_HOST/interface/data/ext.php 调用方式：POST 参数说明： 可选参数如不填则保持分机该参数之前的值 参数 要求 描述 备注 必选 值为” update” verifymethod 必选 验证方式 值为”pwd”固定值, loginid 必选 即企业400号码 loginpwd 必选 原始密码用MD5加密，如：md5(‘123456’) ext 必选 tels 可选 电话数组。手机号加0，座机加区号，例如：01088380197,013100001111 strategy 可选 呼叫策略：1 平均，2 顺序 3随机 默认为平均 dialedtimeout_tel 可选 座机接听超时时间 默认值为20 dialedtimeout_mobile 可选 手机接听超时时间 默认值为30 maxlen 可选 最大排队等待数，取值范围为0-99，默认值为3 timeout 可选 客户排队等待超时时间，默认值600 exception_act 可选 异常处理方式：挂机或转留言 hangup/leavemsg 默认为hangup limitsecond 可选 限制最长通话时间，0代表不限，单位：秒 默认为0 warningsecond 可选 limitsecond，单位：秒 备注： 涉及到语音和提示音部分的参数具体意思——参数为空时不播放声音。参数为”default”时 Response 返回内容： 成功： {code:0,msg:操作成功！} 失败： {code:-1,msg:失败信息} 删除分机 该操作不仅删除分机的配置信息，同时也会删除绑定在该分机下的电话号码。 Request URL规范： http://XLP_HOST/interface/data/ext.php?act=delete verifymethod=pwdloginid=4000000001loginpwd=e10adc3949ba59abbe56e057f20f883eext=25001 调用方式：GET、POST 参数说明： 参数 要求 描述 备注 必选 值为”delete” verifymethod 必选 验证方式 值为”pwd”固定值, loginid 必选 即企业400号码 loginpwd 必选 原始密码用MD5加密，如：md5(‘123456’) ext 必选 要删除的分机号码 Response 返回内容： 成功： {code:0,msg:操作成功！} 失败： {code:-1,msg:失败信息} 事件推送机制 中继呼入 有电话呼入平台时推送 参数名 参考值 描述 备注 1269916991000000 呼叫唯一标识 event incoming 中继呼入事件 固定值 1269916991 呼入时间 Unix时间戳 accountno 861000001 企业ID 对应的企业 caller 01088380197 主叫号码 dnis 4006123456 中继号码 响铃 参数名 参考值 描述 备注 callid 1269916991 呼叫唯一标识