话务平台API接口1.0V8

2020-05-12 19:07:55 admin 68

 

 

 

 

 

 

 

 

 

 

早发达智能话务平台

API接口文档

 

 

 

 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

北京仁和昌盛技术开发有限公司

20191001

 

 

 

 

 

 

 

 

 

1.基础约定

1.1公共响应体

1.2MSGDGT的生成

1.3消息的推送

2.AX模式

2.1绑定关系

2.2删除绑定

3.AXB模式

3.1绑定关系

3.2删除绑定

3.3外呼设置

3.4删除外呼设置

4.AXYB模式

4.1绑定关系

4.2删除绑定

5.onlinecall

6.查询

7.finish

8.code返回码定义

 

 


1.基础约定

1.1公共响应体

所有的响应 Json 都应符合下面的格式,其中 code 是返回码

{

        "code": 0,

        "message": "success",

        "data": {

        }

}

1.2MSGDGT的生成

msgdgt 是消息交换双方进行数据校验的摘要信息,用来保证数据在网络传输过程中的数据一致性,剔除假冒和非法的请求数据。系统采用共享秘钥方式,秘钥由业务平台分配。

msgdgt 生成规则如下:

1)消息体按 key 的字母顺序排序(msgdgt除外)

2)消息体的所有 key、value 串起来以 UTF-8 编码进行 MD5 加密,如: MD5(secretkey1value1key2value2..)

3)生成 32 位大写的摘要字符串,如:BA9854BED1A2986B061E2713F403C752

1.3消息的推送

finish 推送给第三方平台,总共推动3次,间隔1分钟,第三方平台正常响应,业务系统即认为推送成功。业务系统不对响应信息进行校验.

说明:

请求使用JSON报文格式。通过请求包头的字段Content-Type及Accept,指定请求和响应的数据格式。

Content-Type

请求如果携带消息体,需要携带Content-Type和userid,并且指定为application/json,如下:

Content-Type: application/json;charset=UTF-8

userid:test01

Accept

响应的消息格式由Accept指定,当前版本只支持application/json,如下:

Accept: application/json

2.AX模式

2.1绑定关系

接口名称

绑定关系

接口用途

绑定副号码

Method

POST  json请求

URL

{url}/ax/mode101

输入参数

参数

类型

必须

解释

userid

string

城市id

tel

string

tel_x绑定的真实被叫号码

tel_x

string

 

副号码

name

string

姓名

cardno

string

身份证号

area_code

string

区号(北京(010)

expiration

string

过期时间(秒)

model

int

来电显示号码显示形式:

0:来电真实号码

1:系统随机分配虚号Y (AYB)(暂无)

2:tel_x

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss


返回数据

{

    "code":0,

    "data":{

        "bind_id":"A2147X21X0056072001-11-1-DSCS-GXI",

        "tel_x":"170198535"

    },

    "message":"SUCCESS"

}

输出参数

参数

类型

必须

解释

code

int

状态值

bind_id

string


绑定 id

message

string

详情信息


2.2删除绑定

接口名称

删除绑定

接口用途

删除绑定

Method

POST  json请求

URL

{url}/ax/delete

输入参数

参数

类型

必须

解释

userid

string

城市id

bind_id

string

绑定时返回的绑定id

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss


返回数据

{

    "code":0,

    "message":"SUCCESS"

}

输出参数

参数

类型

必须

解释

code

int

状态值

message

string

详情信息


3.AXB模式

3.1绑定关系

接口名称:

绑定关系

接口用途:

绑定长号

Method

POST  json请求

URL

{url}/axb/mode101

输入参数:

参数

类型

必须

解释

userid

string

城市id

tel_a

string

主叫

tel_x

string

副号码

tel_b

string

被叫

area_code

string

区号(上海(21), 北京(10))

expiration

string

过期时间(秒)

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss

model

int

来电显示号码显示形式:

0:来电真实号码

1:系统随机分配虚号Y (AYB)(暂无)

2:tel_x


返回数据:

 {

    "code":0,

    "data":{

       "bind_id":"A2147X21X0056072001-11-1-DSCS-GXI",

       "tel_x":"170198535"

    },

    "message":"SUCCESS"

}

输出参数:

参数

类型

必须

解释

code

int

状态值

bind_id

string


绑定 id

message

string

详情信息


3.2删除绑定

接口名称:

删除绑定

接口用途:

删除绑定

Method

POST  json请求

URL

{url}/axb/delete

输入参数:

参数

类型

必须

解释

userid

string

城市id

bind_id

string

绑定时返回的绑定id

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss


返回数据:

{

    "code":0,

    "message":"SUCCESS"

}


输出参数:

参数

类型

必须

解释

code

int

状态值

message

string

详情信息


3.3外呼设置

接口名称:

增加外呼设置

Method

POST  json请求

URL

{url}/axb/outtransfer

输入参数:

参数

类型

必须

解释

userid

string

城市id

tel_x

string

隐私号码

transferms

string

外呼号码

model

int

来电显示号码显示形式:

0:来电真实号码

1:系统随机分配虚号Y (AYB)(暂无)

2:tel_x

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss


返回数据:

{

    "code":0,

    "data":{

       "bind_id":"A2147X21X0056072001-11-1-DSCS-GXI",

       "tel_x":"170198535"

    },

    "message":"SUCCESS"

}

输出参数:

参数

类型

必须

解释

code

int

状态值

bind_id

string


绑定 id

message

string

详情信息


3.4删除外呼设置

接口名称:

删除外呼设置

Method

POST  json请求

URL

{url}/axb/deleteOuttransfer

输入参数:

参数

类型

必须

解释

userid

string

城市id

bind_id

string

绑定时返回的绑定id

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss


返回数据:


{

    "code":0,

    "message":"SUCCESS"

}

输出参数:

参数

类型

必须

解释

code

int

状态值

message

string

详情信息


4.AXYB模式

4.1绑定关系

接口名称:

绑定关系

接口用途:

绑定长号

Method

POST  json请求

URL

{url}/axyb/mode101

输入参数:

参数

类型

必须

解释

userid

string

城市id

tel_a

string

主叫

tel_x

string

x号码

tel_y

string

y号码

tel_b

string

被叫

area_code

string

区号(上海(21), 北京(10))

expiration

string

过期时间(秒)

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss


返回数据:

 

{

    "code":0,

    "data":{

       "bind_id":"A2147X21X0056072001-11-1-DSCS-GXI",

       "tel_x":"170198535"

    },

    "message":"SUCCESS"

}

输出参数:

参数

类型

必须

解释

code

int

状态值

bind_id

string

  否

绑定 id

message

string

详情信息




4.2删除绑定

接口名称:

删除绑定

接口用途:

删除绑定

Method

POST  json请求

URL

{url}/axyb/delete

输入参数:

参数

类型

必须

解释

userid

string

城市id

bind_id

string

绑定时返回的绑定id

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss


返回数据:

 

{

    "code":0,

    "message":"SUCCESS"

}


输出参数:

参数

类型

必须

解释

code

int

状态值

message

string

详情信息


 

5.onlinecall

接口名称

在线语音主叫请求和响应

接口用途

在线语音主叫请求和响应

Method

POST  json请求

URL

{url}/ax/onlinecall

输入参数

参数

类型

必须

解释

userid

string

城市id

bind_id

string

绑定是返回的绑定id

tel_b

string

被叫

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss


返回数据

{

    "code":0,

    "message":"SUCCESS"

}

输出参数

参数

类型

必须

解释

code

int

状态值

message

string

详情信息


6.查询

接口名称:

查询绑定

接口用途:

查询绑定

Method

POST  json请求

URL

{url}/ax/search

输入参数:

参数

类型

必须

解释

userid

string

城市id

tel_x

string

副号码

msgdgt

string

签名见msgdgt生成

ts

string

时间 yyyyMMddHHmmss


返回数据:

{

    "code":0,

    "message":"SUCCESS",

           "data":{

                "tel_a":"",

                "tel_x”:"",

                "bind_id":""

             }

}



输出参数:

参数

类型

必须

解释

code

int

状态值

message

string

详情信息


7.finish

接口名称

Finish

接口用途

呼叫结束推送(准实时)

Method

POST  json请求

URL

{url}/ax/finish

输入参数

参数

类型

必须

解释

recorder_id

string

通话唯一标识

caller

string

主叫真实号码

called

string

被叫真实号码

caller_show

string

主叫分配号码,即被叫看到的显号

called_show

string

被叫分配号码,即主叫看到的显号

begin_time

string

主叫拨通虚拟号码时刻,格式为YYYY-MM-DD HH:mm:ss

connect_time

string

被叫接通时刻,格式同上。

alerting_time

string

被叫振铃时间,格式同上

release_time

string

通话结束时刻,格式同上

call_duration

int

主被叫之间的通话时长,单位为秒

record_file_url

string

通话录音URL

sign

string

参数签名

extend

string

扩展字段

bind_id

String

绑定id

cdr_type

Int

通话类型:1:双呼话单 2:长号话单 3:APP话单 4:回拨

userId

String

城市id


请求数据:

 

{

    "recorder_id": "20190726181755802109722245",

    "caller": "18402264163",

    "called": "01062961199",

    "caller_show": "17138356035",

    "called_show": "17138356035",

    "begin_time": "2019-07-26 18:17:55",

    "connect_time": "2019-07-26 18:17:59",

    "alerting_time": "2019-07-26 18:17:56",

    "release_time": "2019-07-26 18:18:35",

    "call_duration": 36,

    "record_file_url": "http://rec1.1ketong.com:8090/pull0/1688/20190726/20190726181755802109722245.mp3",

    "sign": "816e16d518ecfa56277f0e5b166d4736",

    "extend": "{\"hangup\":1}",

      “bind_id”:”A2147X21X0056072001-11-1-DSCS-GXI”,

      “cdr_type”:1,

      “userId”:”0001”

}



响应数据

{

"code": 0,

"message": "success"

}

8.code返回码定义

第三方业务系统应该检查响应消息中的“返回码”。如果结果不是成功,则第三方业务系统需要针对不同返回码进行处理。

返回码

描述

定义

0

成功

请求报文成功被处理

400

格式异常

请求报文格式不正确

401

认证未通过

请求的来源或者推送的签名未通过校验

402

副号码已经使用

请求中要求绑定的副号码已经被分配给其他用户

429

请求过多

第三方业务系统在一定时间内提交了过多的请求。第三方业务系统在访问某些特定服务接口时,可能会出现该错误。

501

业务处理超时

副号码业务系统内部处理引起的超时。第三方业务系统可以尝试重新提交请求

其他

待定义


《end》


免费试用
电话咨询
热门产品
免费体验
QQ客服