七陌云小号对接说明

注意：

1、隐私小号没有接口能够发起通话的，所有通话都需要绑定的号码的手机来拨打小号才能发起通话。不能用来做一键拨号的功能。隐私小号不需要配置线路，所有通话不过系统。通话记录和录音需要账单中查看。

2、CallCenter模式：坐席配置中选择仅使用小号方式或者小号和线路并用的方式都可以使用CallCenter小号，开启小号之后坐席通过系统外呼会自动调用小号外呼，坐席的设备外显的是服务号被叫外显的则是小号。

3、CallCenter小号目前有三种方式：绑定坐席、随机抽取和归属地抽取。

4、CallCenter小号是通过系统拨打给小号，小号再转给被叫的方式实现的所以需要配置线路。目前CallCenter小号仅支持CallCenter系统拨打、小号外呼接口和小号版软电话条拨打，其他方式均不会使用小号拨打。

5、170和171的移动号码录音保存时间为3个月，联通小号则保留7天。如有业务需要，可自行隔天拉取。

6、170和171的移动号码，针对固话打固话和移动打移动的情况，没法透传真实号码。

7、请和商务同事确认，若配置的线路编号为xh-03，即使显示小号，也要用固话外呼接口。

隐私模式

一、隐私模式

1.XB模式

XB模式：调用绑定接口将一个号码和一个小号绑定。绑定之后使用除B号码之外的任意号码拨打中间小号，小号会自动转接给B号码。

1.1小号绑定接口

  • HTTP请求方式：POST

  • 鉴权方式：接口鉴权

  • 请求链接：http://xxx.xxx.com/v20160818/rlxh/midNumBind/{ACCOUNTID}?sig={SIG}

  • 请求时请将域名中的xxx换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则

接口参数

参数名 是否必填 值 参数释义
midNum 是 小号 小号,中间号,String形式, 必须为小号池中可用数据
called 是 被叫号码 号码, String形式
icDisplayFlag 否 被叫外显号码 "0"显真实号码； "1"显示中间号； "2"主叫显示真实号码，被叫显示小号； "3" 主叫显示小号，被叫显示真实号码。 默认 "1" String形式
needRecord 否 是否需要录音 "true" 录音 "false" 不录音, 默认为”true” String形式
userData 否 自定义字段 会在账单和话单推送时回传回来
expiration 否 绑定时长 单位:秒,0表⽰不限制时间,不会⾃动解绑。170和171号码最大绑定时长为15天

注意：170,171的移动号码expiration默认值为0,联通号码默认值为20s

系统返回的Json对象样例：

{
    "success": true,
    "mappingId": "NME201201712261728130691096966321017080219065",
    "code": "200"
}

返回值字段说明:

字段名称 值 说明
success 处理结果 请求是否成功，当不成功时会在message字段中给出原因
mappingId 字符串 绑定关系id，调用解绑接口时使用
code 执行码 执行成功返回”200”, 执行失败message字段中给出原因
message 结果说明 code=401 请求参数格式不正确
code=400 请求参数不正确,请检查你的参数
code=404 小号找不到,请确认小号参数
code=406 号码绑定失败请联系管理员
code=500 服务器错误请联系管理员 s

1.2 小号解绑接口

  • HTTP请求方式：POST

  • 鉴权方式：接口鉴权

  • 请求链接：http://xxx.xxx.com/v20160818/rlxh/midNumUnBinding/{ACCOUNTID}?sig={SIG}

  • 请求时请将域名中的xxx换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则

接口参数

参数名 是否必填 值 参数释义
mappingId 是 绑定关系Id String字符串, 用于解除XB绑定关系
midNum 是 小号 小号 中间号, String形式

系统返回的Json对象，样例：

{
    "success": true,
    "code": "200"
}

返回值字段说明:

字段名称 值 说明
success 处理结果 请求是否成功，当不成功时会在message字段中给出原因
code 执行码 执行成功返回”200”, 执行失败message字段中给出原因
message 结果说明 code=401 请求参数格式不正确
code=400 请求参数不正确,请检查你的参数
code=404 小号找不到,请确认小号参数
code=406 号码绑定失败请联系管理员
code=500 服务器错误请联系管理员

2.AXB模式

AXB模式：调用绑定接口将两个号码和一个小号进行绑定。绑定之后用A号码或者B号码直接拨打中间小号号码，小号会自动转接给另外一方。

2.1 小号绑定接口

  • HTTP请求方式：POST

  • 鉴权方式：接口鉴权

  • 请求链接：http://xxx.xxx.com/v20160818/rlxh/midNumBindForAXB/{ACCOUNTID}?sig={SIG}

  • 请求时请将域名中的xxx换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则

接口参数

参数名 是否必填 值 参数释义
midNum 是 小号 小号,中间号,String形式, 必须为小号池中可用数据
called 是 被叫号码 号码, String形式
caller 是 主叫号码 号码, String形式
icDisplayFlag 否 被叫外显号码 "0"显真实号码 "1"显示中间号 默认 "1" String形式
needRecord 否 是否需要录音 "true" 录音 "false" 不录音, 默认为”true” String形式
userData 否 自定义字段 会在账单和话单推送时回传回来
expiration 否 绑定时长 单位:秒,0表⽰不限制时间,不会⾃动解绑。170和171号码最大绑定时长为15天

注意：170,171的移动号码expiration默认值为0,联通号码默认值为20s

系统返回的Json对象样例：

{
    "success": true,
    "mappingId": "A2141X10X0162564342-11-1-RLYTX-GXI",
    "code": "200"
}

返回值字段说明:

字段名称 值 说明
success 处理结果 请求是否成功，当不成功时会在message字段中给出原因
mappingId 字符串 绑定关系id，调用解绑接口时使用
code 执行码 执行成功返回”200”, 执行失败message字段中给出原因
message 结果说明 code=401 请求参数格式不正确
code=400 请求参数不正确,请检查你的参数
code=404 小号找不到,请确认小号参数
code=406 号码绑定失败请联系管理员
code=409 绑定关系已存在,请先删除之前的绑定关系
code=500 服务器错误请联系管理员

2.2 小号解绑接口

  • HTTP请求方式：POST

  • 鉴权方式：接口鉴权

  • 请求链接：http://xxx.xxx.com/v20160818/rlxh/midNumUnBindForAXB/{ACCOUNTID}?sig={SIG}

  • 请求时请将域名中的xxx换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，{SIG}是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则

接口参数

参数名 是否必填 值 参数释义
mappingId 是 绑定关系Id String字符串, 用于解除AXB绑定关系
midNum 是 小号 小号 中间号, String形式

系统返回的Json对象，样例：

{
    "success": true,
    "code": "200"
}
字段名称 值 说明
success 处理结果 请求是否成功，当不成功时会在message字段中给出原因
code 执行码 执行成功返回”200”, 执行失败message字段中给出原因
message 结果说明 code=401 请求参数格式不正确
code=400 请求参数不正确,请检查你的参数
code=404 小号找不到,请确认小号参数
code=406 号码绑定失败请联系管理员
code=500 服务器错误请联系管理员

3.小号话单数据推送接口

  • 平台提供通话数据对外推送

  • 用户可以提供针接收url接口。当有通话产生时,平台会访问这个url,在url路径中传递参数

  • 目前数据推送已经支持GET形式的https推送

实例： 此url仅为举例,实际url为平台使用者提供给七陌 www.xxxx.com/callback

话单推送：

http://www.xxxx.com/callback?appId=8a216da85fc7a0**dd4e1b320702&result=0&userData=RlxhMidNumB**1d21-fb34-11e7-a5dc-d904c5c340f5&mappingId=NME201201801171112103061729385718817080219054&calldisplay=1&account=N0**018301&smallNumberType=ytx&call_duration=11&recorder_id=651189304554619577715161**9279&caller=01068**45&called=136**2695&begin_time=2018-01-17%2013:50:42&release_time=2018-01-17%2013:51:04&connect_time=2018-01-17%2013:50:53&alerting_time=2018-01-17%2013:50:42&called_show=1708***054&called_area=010%20%E**E4%BA%AC&caller_area=010%20%E5%8**4%BA%AC

录音推送：

http://www.xxxx.com/callback?userData=RlxhMidNumBind34e31d21-fb34-11e7-a5dc-d904c5c340f5&mappingId=NME201201801171112103061729385718817080219054&account=N00000***1&recorder_id=651***30455461957771516168249279&caller=010684***45&called=136***2695&called_show=170***9054&record_file_url=http://****/vnum/recordings/download/RLQM_651189304554619577715161**279_010**92345_170***9054_1367**2695.mp3

话单推送数据：

参数名 描述
alerting_time 被叫振铃时间,格式为YYYY-MM-DD HH:mm:ss
called 被叫真实号码
recorder_id 企业本次通话唯一标识id
caller_area 主叫归属地
begin_time 主叫拨通虚拟号码时刻 ，格式为YYYY-MM-DD HH:mm:ss
called_area 被叫归属地
caller 主叫号码
called_show 中间号,小号
connect_time 被叫接通时刻,格式为YYYY-MM-DD HH:mm:ss
result 通话状态，通话状态的取值请查通话状态区分（0 成功 2无应答 9呼叫失败 11主叫号码与中间号没有关联）
release_time 通话结束时刻,格式为YYYY-MM-DD HH:mm:ss
account 帐号编号
mappingId 绑定关系唯一Id
appId 应用id
call_duration 本次通话的时长，单位为秒
userData 用户自定义数据
smallNumberType 小号类型
calldisplay 0显真实号 1 不显真实号 2强制不显真实号

录音推送数据：

参数名 描述
userData 用户自定义数据
mappingId 绑定关系唯一Id
account 帐号编号
recorder_id 企业本次通话唯一标识id
caller 主叫号码
called 被叫真实号码
called_show 中间号,小号
record_file_url 录音地址

注：话单和录音地址是同一个，170的移动号码推送两次，如果是联通小号，则推送一次(包含话单和录音)