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

400总机分机（超级总机）接口文档2020年1月18日新联协同通信技术（北京）有限公司400总机接口文档400总机分机（超级总机）接口文档2011/6目录1接口概述32接口身份验证33接口具体实现33.1创建分机33.2更新分机信息43.3删除分机54事件推送机制64.1中继呼入64.2响铃74.3应答84.4挂机91 接口概述1、 接口基于HTTP协议实现，通过URL的GET、POST方式进行参数传递2、 接口数据返回统一采用JSON格式2 接口身份验证该文档中涉及的接口，统一采用企业400号码和登录密码进行身份验证。为了提高安全性，接口中的密码采用MD5加密的方式传递，即：MD5(企业密码)。3 接口具体实现3.1 创建分机 Request1) URL规范：http:/XLP_HOST/interface/data/ext.php2) 调用方式：POST3) 参数说明：参数要求描述备注action必选动作类型值为” create”verifymethod必选验证方式值为”pwd”固定值,不得更改loginid必选登录ID即企业400号码loginpwd必选登录密码原始密码用MD5加密，如：md5(123456)extname可选分机名称ext必选分机号码 Response1) 返回内容：成功：code:0,msg:操作成功！失败：code:-1,msg:失败信息3.2 更新分机信息 Request1) URL规范：http:/XLP_HOST/interface/data/ext.php2) 调用方式：POST3) 参数说明： 可选参数如不填则保持分机该参数之前的值参数要求描述备注action必选动作类型值为” update”verifymethod必选验证方式值为”pwd”固定值,不得更改loginid必选登录ID即企业400号码loginpwd必选登录密码原始密码用MD5加密，如：md5(123456)ext必选分机号码tels可选电话数组。手机号加0，座机加区号，例如：01088380197,013100001111strategy可选呼叫策略：1 平均，2 顺序 3随机 默认为平均dialedtimeout_tel可选座机接听超时时间 默认值为20dialedtimeout_mobile可选手机接听超时时间 默认值为30maxlen可选最大排队等待数，取值范围为0-99，默认值为3timeout可选客户排队等待超时时间，默认值600exception_act可选异常处理方式：挂机或转留言 hangup/leavemsg 默认为hanguplimitsecond可选限制最长通话时间，0代表不限，单位：秒 默认为0warningsecond可选提前多少秒语音提示达到最长通话时间，此参数依赖limitsecond，单位：秒 默认为0 备注： 涉及到语音和提示音部分的参数具体意思参数为空时不播放声音。参数为”default”时播放系统默认声音，参数为语音文件时，播放语音文件所对应的提示音。此参数建议选default。如需选用其他语音需由接口提供方配合（上传语音文件，告之文件名） Response1) 返回内容：成功：code:0,msg:操作成功！失败：code:-1,msg:失败信息3.3 删除分机该操作不仅删除分机的配置信息，同时也会删除绑定在该分机下的电话号码。 Request1) URL规范：http:/XLP_HOST/interface/data/ext.php?act=delete& verifymethod=pwd&loginid=4000000001&loginpwd=e10adc3949ba59abbe56e057f20f883e&ext=250012) 调用方式：GET、POST3) 参数说明：参数要求描述备注action必选动作类型值为”delete”verifymethod必选验证方式值为”pwd”固定值,不得更改loginid必选登录ID即企业400号码loginpwd必选登录密码原始密码用MD5加密，如：md5(123456)ext必选分机号码要删除的分机号码 Response1) 返回内容：成功：code:0,msg:操作成功！失败：code:-1,msg:失败信息4 事件推送机制4.1 中继呼入有电话呼入平台时推送参数名参考值描述备注callid1269916991000000呼叫唯一标识eventincoming中继呼入事件固定值time1269916991呼入时间Unix时间戳accountno861000001企业ID对应的企业caller01088380197主叫号码dnis4006123456中继号码4.2 响铃座席响铃时推送参数名参考值描述备注callid1269916991000000呼叫唯一标识eventringing响铃事件固定值time1269916991响铃时间Unix时间戳accountno861000001企业ID对应的企业caller01088380197主叫号码dnis4006123456中继号码总机分机产品中，此参数将携带分机信息，例如01088380197-600。以”-“分割，前部分为中继号，后部分为分机号cno8610000012001座席ID对应呼叫中心座席number88886666电话号码响铃座席电话号码queuename861000001001队列号4.3 应答座席应答时推送参数名参考值描述备注callid1269916991000000呼叫唯一标识eventanswer应答事件固定值time1269916991应答时间Unix时间戳accountno861000001企业ID对应的企业caller013800001111主叫号码呼入平台的电话dnis4006123456中继号码总机分机产品中，此参数将携带分机信息，例如01088380197-600。以”-“分割，前部分为中继号，后部分为分机号cno8610000012001座席IDnumber01088380197电话号码应答电话号码answercustomer应答方呼入流程中此参数无效，外呼流程中custmoer客户应答 agent 坐席应答。typeinbound呼叫类型呼入流程中固定为inbound。外呼流程中固定为outbound4.4 挂机通话结束，挂机时推送参数名参考值描述备注callid1269916991000000呼叫唯一标识eventhangup挂机事件固定值time1269916991挂机时间accountno861000001企业ID对应的企业caller013800001111主叫号码呼入平台的电话dnis4006123456中继号码总机分机产品中，此参数将携带分机信息，例如01088380197-600。以”-“分割，前部分为中继号，后部分为分机号cno