讯通接口规范-呼出模块V1.3_20140730要点

1、讯通接口参考webServer 接口讯通接口规范目录1.1 呼出模块21.1.1 userLogin （登录） 21.1.2 callOut（夕卜呼）31.1.3 getCalloutRecordFile（录音下载 ）41.1.4 getCalloutRecordList （外呼录音查询） 51.1.5 getCalloutList （外呼查询） 71.1.6 getCallin List （呼入记录查询） 91.1.7 getCallinList2 （呼入记录查询 2） 131.2 调用接口示例181.2.1 登陆、注销调用接口示例 181.2.2 外呼调用接口示例 191.2.3 录音下载

2、调用接口示例 201.2.4 外呼录音查询调用接口示例 201.2.5 外呼查询调用接口示例 211.2.6 呼入记录查询调用接口示例 221.2.7 呼入记录查询2调用接口示例 222018-10-5华为保密信息，未经授权禁止扩散第27页，共23页1.1呼出模块1.1.1 userLogin （登录）接口功能：企业定制平台调用此接口实现讯通登录功能。预置事件：用户未登录讯通平台。接口声明：String userLogin（Stringxml）。请求报文（方法参数）:118114057187878787vpho neNpasswordE10ADC3949BA59ABB

3、E56E057F20F883E1回复报文（返回参数）：0参数声明：参数类别参数如何理解数据类型是否可以为空请求报文cen trexId企业IDStri ng否phoneNo成员绑定号码Stri ng否password成员密码Stri ng否（需要32位MD5大写加密）type操作类型Stri ng否（1:登录；2:注销）返回报文result结果Stri ng（报文）成功：返回 0，（当成员已经登录时， 不做任务操作，当作登录成功返回 ）失败：返回-11.1.2 callOut （外呼）接口功能：企业工作人员通过使用企业定制平台外呼客户电话，进行相关业务处理，讯通平台提供外呼web servic

4、e接口供企业定制平台调用，企业定制平台记录外呼ID，供后续录音下载使用。预置事件：需先调用登录接口；处于登录状态。且开通讯通并增加讯通成员账号，绑定一个电话固话或C网号码。接口声明：Stringcallout（Stringxml）请求报文（方法参数）:118114057187878787vpho neNo1389999888818205819990回复报文（返回参数）：20130711111176620参数声明参数类别参数如何理解数据类型是否可以为空请求报文cen trexId企业IDStri ng否phoneNo成员绑定号码Stri ng否calloutNo外呼号码Stri ng否返回报文c

5、alloutId外呼IDStri ng是：（返回失败时为空）result结果类型Stri ng否：（成功：返回0失败：返回-1）1.1.3 getCalloutRecordFile（录音下载）接口功能：企业工作人员通过使用企业定制平台外呼客户电话，保存外呼记录。讯通平台提供web service形式的录音文件下载接口，企业定制平台根据自己记录的外呼ID调用讯通录音文件下载接口，获取外呼录音，供企业工作人员视听。预置事件：需要先调用坐席登录接口。处于登录状态。接口声明：String getCalloutRecordFile（String xml ）请求报文（方法参数）:1181140571878

6、78787138999988882013071111117662回复报文（返回参数）：0:8080/webservice/2013071111117662.wav参数声明参数类别参数如何理解数据类型是否可以为空请求报文cen trexId企业IDStri ng否phoneNo成员绑定号码Stri ng否calloutId外呼IDStri ng否返回报文result结果类型Stri ng否：（成功：返回0失败：返回-1）recordfile录音文件路径Stri ng是：（返回失败时为空）1.1.4 getCalloutRecordList （外呼录音查询）接口功能：

7、企业工作人员通过使用企业定制平台外呼客户电话，保存外呼记录。讯通平台提供web service形式的录音文件下载接口，企业定制平台根据自己记录的外呼ID调用讯通录音文件下载接口，获取外呼录音，供企业工作人员视听。预置事件：需要先调用坐席登录接口。处于登录状态。接口声明：StringgetCalloutRecordList （Stringxml ）请求报文（方法参数）:11811405718787878713899998888183581260012013/11/01 08:00:002013/11/01 23:00:00201回复报文（返回参数）：02520130711111176621389

8、999888813899998888183581260012013/01/01 11:01:012013/01/01 11:03:01 v/record2013071111117663 vpho neNo1389999888813899998888183581260012013/11/01 08:00:002013/11/01 23:00:00 参数声明：参数类别参数如何理解数据类型是否可以为空请求报文cen trexId企业IDStri ng否phoneNo成员绑定号码Stri ng否callee被叫号码Stri ng是begi ntime录音开始时间格式例2013/11/01 08:00:

9、00Stri ng否en dtime录音结束时间格式例2013/11/01 23:00:00Stri ng否pagesize每页条数（默认20,最大500 条）Stri ng是page num页数Stri ng是回复报文totalcou nt记录总条数Stri ng是：（返回失败时为空）recordlist录音信息列表父节点是：（返回失败时为空）result结果类型Stri ng0:成功-1失败-2未登录录音信息说明参数类别参数如何理解数据类型是否可以为空recordcalloutId外呼IDStri ng否phoneNo成员绑定号码Stri ng否showNo外呼显示号码Stri ng否ca

10、llee被叫号码Stri ng否begi ntime录音开始时间Stri ng否en dtime录音开始时间Stri ng否1.1.5 getCalloutList （外呼查询）接口功能：外呼记录查询。预置事件：需要先调用坐席登录接口，处于登录状态。接口声明：String getCalloutList （Stringxml ）请求报文（方法参数）:11811405718787878713899998888183581260012013/11/01 08:00:002013/11/01 23:00:000201回复报文（返回参数）：0vtotalcou nt252013071111117662v

11、pho neNo138999988881389999888818358126001vsubmitTime 2013/01/01 11:01:002013/01/01 11:01:012013/01/01 11:03:0112013071111117663138999988881389999888818358126001vsubmitTime 2013/11/01 07:59:582013/11/01 08:00:002013/11/01 23:00:001v/resp on se参数声明：参数类别参数如何理解数据类型是否可以为空请求报文cen trexld企业IDStri ng否phoneNo

12、成员绑定号码Stri ng否callee被叫号码Stri ng是begi ntime提父开始时间格式例2013/11/01 08:00:00Stri ng否en dtime提父结束时间格式例2013/11/01 23:00:00Stri ng否status呼叫状态0全部1成功2失 败Stri ng否pagesize每页条数（默认20,最大500 条）Stri ng是page num页数Stri ng是回复报文totalcou nt记录总条数Stri ng是：（返回失败时为空）recordlist外呼列表父节点是：（返回失败时为空）result结果类型Stri ng0:成功-1失败-2未登录录音

13、信息说明参数类别参数如何理解数据类型是否可以为空recordcalloutId外呼IDStri ng否pho neNo成员绑定号码Stri ng否showNo外呼显示号码Stri ng否callee被叫号码Stri ng否submitTime提交时间Stri ng否callbegi ntime通话开始时间Stri ng是calle ndtime通话结束时间Stri ng是status通话状态1成功2失败Stri ng否1.1.6 getCallinList (呼入记录查询)接口功能：呼入记录查询。预置事件：需要先调用坐席登录接口，处于登录状态。接口声明：Stri ng getCalli nLi

14、st (Stri ngxml )请求报文（方法参数）:v?xml version=1.0 encoding=UTF-8 ?118114057187878787vpho neNo1389999888818358126001012013/11/01 08:00:002013/11/01 23:00:00OO013989898989101201回复报文（返回参数）:02513899998888O13899998888010vbegi ntime2013/01/01 11:01:012013/01/01 11:03:01viftra ns1112013/01/01 11:03:012013/01/01

15、 11:06:0110113899998888O138999988880102013/01/01 11:01:012013/01/01 11:03:011112013/01/01 11:03:012013/01/01 11:06:01101参数声明：参数类别参数如何理解数据类型是否可以为空请求报文cen trexId企业IDStri ng否phoneNo成员绑定号码Stri ng否caller主叫号码Stri ng是call in Type接入方式：01分机号接入02直接接入03按“ 0或动态语音键接入04人工话务员转接接入05转接接入Stri ng是begi ntime开始时间格式例2013

16、/11/01 08:00:00Stri ng否en dtime结束时间格式例2013/11/01 23:00:00Stri ng否logi nStatus坐席登录状态0未登录，1登录Stri ng是callResult是否接通0未接通，1接通Stri ng是iftrans是否转接 0未转接，1转接Stri ng是tran scallee转接号码Stri ng是work no坐席工号Stri ng是pagesize每页条数（默认20,最大500条）Stri ng是page num页数Stri ng是回复报文totalcou nt记录总条数Stri ng是：（返回失败时为空）recordlist呼

17、入列表父节点是：（返回失败时为空）result结果类型Stri ng0:成功-1失败-2未登录呼入信息说明参数类别参数如何理解数据类型是否可以为空recordpho neNo成员绑定号码Stri ng否logi nStatus坐席登录状态0未登录，1登录Stri ng否caller主叫号码Stri ng否call in Type接入方式：01分机号接入02直接接入03按“ 0或动态语音键接入04人工话务员转接接入05转接接入Stri ng否callResult是否接通0未接通，1接通Stri ng否beg in time开始时间格式例2013/11/01 08:00:00Stri ng否en

18、dtime结束时间格式例2013/11/01 23:00:00Stri ng否iftrans是否转接 0未转接，1转接Stri ng否tran scallee转接号码Stri ng是tran sResult是否接通0未接通，1接通Stri ng否tra nsbeg in time转接开始时间 格式例2013/11/01 08:00:00Stri ng是tra nsen dtime转接结束时间 格式例2013/11/01 23:00:00Stri ng是work no工号Stri ng是1.1.7 getCallinList2 （呼入记录查询 2）接口功能：呼入记录查询。预置事件：需要先调用坐席

19、登录接口，处于登录状态。接口声明：StringgetCallinList2 （String xml）请求报文（方法参数）:118114057187878787vpho neNo1389999888818358126001012013/11/01 08:00:002013/11/01 23:00:00OO013989898989vwork no 101201回复报文（返回参数）：025201407301122114412413899998888calli nType01O2013/01/01 11:01:012013/01/01 11:03:011112013/01/0

20、1 11:03:012013/01/01 11:06:01 vwork no 101201407301122114412513899998888O138999988880102013/01/01 11:01:012013/01/01 11:03:011112013/01/01 11:03:012013/01/01 11:06:01101v/resp on se参数声明：参数类别参数如何理解数据类型是否可以为空请求报文cen trexId企业IDStri ng否phoneNo成员绑定号码Stri ng否caller主叫号码Stri ng是call in Type接入方式：01分机号接入02直接接

21、入03按“ 0或动态语音键接入04人工话务员转接接入05转接接入Stri ng是begi ntime开始时间格式例2013/11/01 08:00:00Stri ng否en dtime结束时间格式例2013/11/01 23:00:00Stri ng否logi nStatus坐席登录状态0未登录，1登录Stri ng是callResult是否接通0未接通，1接通Stri ng是iftrans是否转接 0未转接，1转接Stri ng是tran scallee转接号码Stri ng是work no坐席工号Stri ng是pagesize每页条数（默认20,最大500条）Stri ng是page n

22、um页数Stri ng是回复报文totalcou nt记录总条数Stri ng是：（返回失败时为空）recordlist呼入列表父节点是：（返回失败时为空）result结果类型Stri ng0：成功-1失败-2未登录呼入信息说明参数类别参数如何理解数据类型是否可以为空recordcalllD记录标志IDStri ng否pho neNo成员绑定号码Stri ng否logi nStatus坐席登录状态0未登录，1登录Stri ng否caller主叫号码Stri ng否call in Type接入方式：01分机号接入02直接接入03按“ 0或动态语音键接入04人工话务员转接接入05转接接入Stri

23、ng否callResult是否接通0未接通，1接通Stri ng否beg in time开始时间格式例2013/11/01 08:00:00Stri ng否en dtime结束时间格式例2013/11/01 23:00:00Stri ng否iftrans是否转接 0未转接，1转接Stri ng否tran scallee转接号码Stri ng是tran sResult是否接通0未接通，1接通Stri ng否tra nsbeg in time转接开始时间 格式例2013/11/01 08:00:00Stri ng是tra nsen dtime转接结束时间 格式例2013/11/01 23:00:0

24、0Stri ng是work no工号Stri ng是1.2调用接口示例访问接口工具：xfire1.2importjava .n et.MalformedURLExceptio n;importjava .n et.URL;importorg.codehaus.xfire.clie nt.Clie nt;publicclass XFireMa in public static void main( Stri ng args) String url =52:8080/Ce ntrexService/remoti ng/caservice?wsduserLogin

25、 (url); / 登陆、注销/callout(url);/ 外呼/getCalloutRecordFile(url); /下载录音/ getCalloutRecordList(url);/getCalloutList(url);/getCallinList(url); / 呼入记录查询1.2.1 登陆、注销调用接口示例public static void userLogi n( Stri ng url) Clie nt clie nt;try clie nt =new Clie nt(new URL(url);/1:登录；2 :注销Stri ng xml =11811405718787878

26、718958104720E10ADC3949BA59ABBE56E057F20F883E1;System. out .println(xml);Object results = client.invoke(userLogin, new Object xml );System. out .println(String) results0); catch (MalformedURLException e) e.pri ntStackTrace(); catch (Exception e) e.pri ntStackTrace();1.2.2 外呼调用接口示例public static void c

27、allout(Stri ng url) Clie nt clie nt;try clie nt = new Clie nt(new URL(url);Stri ng xml =1181140571878787871895810472018857184811 ;System. out .println(xml);Object results = clie nt. in voke(callout , new Object xml );System. out .println(String) results0); catch(MalformedURLException e) e.pri ntStac

28、kTrace(); catch(Exception e) e.pri ntStackTrace();123录音下载调用接口示例public static void getCalloutRecordFile(Stri ng url) Clie nt clie nt;try clie nt = new Clie nt(new URL(url);Stri ng xml =118114057187878787189581047202013073002412047System. out .println(xml);Object results = clie nt.i nvoke(new Object x

29、ml );System. out .printin(String) results0); catch (MalformedURLException e) e.pri ntStackTrace(); catch(Exception e) e.pri ntStackTrace();getCalloutRecordFile1.2.4 外呼录音查询调用接口示例public static void getCalloutRecordList (Stri ng url) Clie nt clie nt;try clie nt =new Clie nt( new URL(url);Stri ng xml =1

30、18114057187878787 189581047202012/10/18 00:00:002013/10/1800:00:00vpagesize200vpage num1;System. out .println(xml);newObject results = clie nt.i nvoke(getCalloutRecordListObject xml );System. out .println(String) results0); catch(MalformedURLException e) e.pri ntStackTrace(); catch(Exception e) e.pr

31、i ntStackTrace();1.2.5外呼查询调用接口示例/ 录音列表public static void getCalloutList(Stri ng url) Clie nt clie nt;try clie nt =new Clie nt(new URL(url);Stri ng xml =118114057187878787189581047202014/04/01 08:00:002014/04/0923:00:00vstatus0v/statusvpagesize10v/pagesizexpage num1v/request;System. out .println(xml);Object results = clie nt.i nvoke(getCalloutList,new Object xml );System. out .println(String) results0); catch (MalformedURLException e) /TODO Auto-ge nerated catch blocke.pri ntStackTrace(); catch (Exception e) /TODO Auto-ge nerated catch blocke.pri ntStackTrace()