API > 通讯接口定义
通讯接口定义
更新时间：2021/07/06 10：34
外呼号码绑定
接口地址：https://api.51lianlian.cn/api/v1/binding
请求参数
字段名称 字段类型 约束 说明
token string(50) 必选 密钥
ts int 必选 时间戳
type string(16)
绑定号码类型 默认优先使用个人的，后使用号池号码
坐席PER_PERSON
号池POOL
callerId string(32) 必选 主叫坐席编号
calledId string(50) 客户编号，话单推送时回传
calledName string(50) 客户姓名，话单推送时回传
calledNo string(20) 必选 需要呼叫的客户号码 固话需带区号
transferNo string(32) 指定小号，空时由系统分配
option object
指绑定策略选项：
duration (int) 绑定有效时长 单位(秒)
release (bool) 通话/短信发生时是否解绑
未定义选项则遵循系统默认配置；
payload string(1024) 扩展信息，话单推送时回传
province string(10) 指定优先使用的省份小号(接口暂不支持)
city string(10) 指定优先使用的城市小号(接口暂不支持)
poolName string(16) 指定号池，默认全部号池的号码可用 (接口暂不支持)
ivrType int Ivr类型  默认0不开启  1开启
ivrName string(20) 指定Ivr名称 默认使用系统配置
返回格式
字段名称 字段类型 约束 说明
code int 必选
状态码
0成功
1签名验证错误
2参数错误
3坐席员工错误
4小号错误
5企业相关错误
6其他错误
message string(20) 必选 错误原因描述
number string(20) 必选 绑定的小号
caller
Array
string(20)
 必选 限制使用的主叫
reuse bool 必选 是否是复用的号码
bindId string(50) 必选 绑定ID
话单推送
企业方提供接收话单的接口地址，连犀云平台会将话单推送到企业接口
请求参数
字段名称 字段类型 约束 说明
ts int 必选 时间戳
reqId string(50) 必选 请求UUID
corpKey string(50) 必选 企业账户标识key
records
Array
Object
 话单列表
records
recordId string(50) 必选 话单唯一标识
type string(20) 必选
通话类型：
OutBound_Call, 外呼电话；
OutBound_Unkown, 陌生外呼；
InBound_Call, 客户来电；
InBound_Call_Channel, 渠道来电；
Unknow_Call, 陌生来电；
transferNo string(20) 必选 小号号码
showNo string(20) 必选 被叫方显示的号码
result string(20) 必选
通话状态：
ANSWERED, 通话成功；
BUSY, 被叫忙；
NO_ANSWER, 被叫无应答；
REJECT, 被叫拒接；
HANGUP, 主叫提前挂机；
INVALID_NUMBER, 空号
POWER_OFF, 关机；
UNAVAILABLE, 暂时无法接听；
SUSPEND, 停机；
BLACK, 黑名单号码；
OTHER, 其他失败情形；
startTime string(20) 必选 通话开始时间 格式yyyy-MM-dd HH:mm:ss
city string(10) 指定优先使用的城市小号(接口暂不支持)
alertTime string(20) 被叫振铃时间 格式yyyy-MM-dd HH:mm:ss
connectTime string(20) 被叫接通时间 格式yyyy-MM-dd HH:mm:ss
endTime string(20) 必选 通话结束时间 格式yyyy-MM-dd HH:mm:ss
duration int 必选 通话时长, 大于0已接通, 否则未接通
recordingUrl string(100) 必选 录音文件HTTP地址, 文件格式为MP3（录音格式转换有一定处理时间, 转换完成后录音地址有效，录音托管期间地址可以访问）；
callInfo string(1024) 必选 外呼绑定时的扩展字段回传信息
seatNo string(20) 坐席编号
empId string(20) 必选 员工编号
empNo string(20) 必选 员工号码
empNoArea string(20) 员工号码归属地
cusId string(20) 客户编号，外呼绑定时的客户编号回传信息
cusName string(20) 客户姓名，外呼绑定时的客户姓名回传信息
cusNo string(20) 必选 客户号码
cusNoArea string(20) 客户号码归属地
ivrInfo string(200) 语音应答内容回传 内容如："{\"name\":\"满意度\",\"value\":\"满意\",\"initKey\":\"1\",\"respKey\":\"3\"}" 其中initKey为发起键，respKey为响应键
返回格式
字段名称 字段类型 约束 说明
result int 必选
0 成功
1 错误,如果errIds空, 本批次话单推送全部失败处理, 如果errIds不为空, 只对errIds对应的话单推送失败处理
message string 必选 结果消息
errIds
Array
string(50)
 处理失败返回的话单标识, 用于查询补推
短信推送
企业方提供接收短信的接口地址，连犀云平台会将短信推送到企业接口
请求参数
字段名称 字段类型 约束 说明
ts int 必选 时间戳
reqId string(50) 必选 请求UUID
corpKey string(50) 必选 企业账户标识key
records
Array
Object
 短信列表
records
recordId string(50) 必选 话单唯一标识
type string(20) 必选
短信类型：
OutBound_Sms, 外发短信；
OutBound_Unkown, 陌生外发短信；
InBound_Sms, 客户回复短信；
InBound_Sms_Channel, 渠道短信；
Unknow_Sms, 陌生短信；
transferNo string(20) 必选 小号号码
showNo string(20) 必选 短信接收方显示号码
result string(20) 必选
短信状态：
SENT, 成功发送；
INVALID_SHOW_NUMBER, 显示号码不合法；
INVALID_RECEIVER_NUMBER, 接收号码非手机号；
OTHER, 其他失败；
transferTime string(20) 必选 短信发送时间 格式yyyy-MM-dd HH:mm:ss
content string(255) 必选 短信内容
smsInfo string(1024) 必选 外呼绑定时的扩展字段回传信息
seatNo string(20) 坐席编号
empId string(20) 必选 员工编号
empNo string(20) 必选 员工号码
empNoArea string(20) 员工号码归属地
cusId string(20) 客户编号，外呼绑定时的客户编号回传信息
cusName string(20) 客户姓名，外呼绑定时的客户姓名回传信息
cusNo string(20) 必选 客户号码
cusNoArea string(20) 客户号码归属地
返回格式
字段名称 字段类型 约束限制 说明
result int 必选
0 成功
1 错误,如果errIds空, 本批次话单推送全部失败处理, 如果errIds不为空, 只对errIds对应的话单推送失败处理
message string 必选 结果消息
errIds
Array
string(50)
 处理失败返回的话单标识, 用于查询补推
事件推送
企业方提供接收事件的接口地址，平台会将事件推送到企业接口
请求参数
字段名称 字段类型 约束 说明
ts int 必选 时间戳
reqId string(50) 必选 请求UUID
corpKey string(50) 必选 企业账户标识key
records
Array
Object
事件列表
records
recordId string(50) 必选 话单唯一标识
type string(20) 必选
事件类型：
DIALING_OUTBOUND, 外呼去电拨打事件
DIALING_UNKNOWNOUTCALL, 陌生去电拨打事件
DIALING_INBOUND, 客户来电拨打事件
DIALING_CHANNEL, 渠道来电拨打事件
DIALING_UNKNOWN, 陌生来电拨打事件
time string(20) 必选
事件发生时间
格式yyyy-MM-dd HH:mm:ss
transferNo string(20) 必选 小号号码
callInfo string(1024) 必选 外呼绑定时的扩展字段回传信息
seatNo string(20) 坐席编号
empId string(20) 必选 员工编号
empNo string(20) 必选 员工号码
empNoArea string(20) 员工号码归属地
cusId string(20) 客户编号，外呼绑定时的客户编号回传信息
cusName string(20) 客户姓名，外呼绑定时的客户姓名回传信息
cusNo string(20) 必选 客户号码
cusNoArea string(20) 客户号码归属地
返回格式
字段名称 字段类型 约束限制 说明
result int 必选
0 成功
1 错误,如果errIds空, 本批次话单推送全部失败处理, 如果errIds不为空, 只对errIds对应的话单推送失败处理
message string 必选 结果消息
errIds
Array
string(50)
 处理失败返回的话单标识
通话扩展信息推送
企业方提供接收的接口地址，连犀云平台会将通话扩展信息推送到企业接口
请求参数
字段名称 字段类型 约束限制 说明
ts int 必选 时间戳
reqId string(50) 必选 请求UUID
corpKey string(50) 必选 企业账户标识key
records
Array
Object
 扩展信息列表
records  扩展信息列表(一级属性)
recordId string(50) 必选 话单唯一标识
time string(20) 必选 处理成功录音时间
格式yyyy-MM-dd HH:mm:ss
fileTime int 必选 处理录音的文件时长(秒)
tags string(1024) 必选 录音的标签，逗号分隔
datas
Array
Object
 必选 录音转文字的内容
datas  录音转文字的内容(records的子属性)
roleType int 必选 角色 1或2不同的值代表不同的说话人
text string(256) 必选 文字内容
s_time string(20) 必选 当前文本内容开始时间
格式yyyy-MM-dd HH:mm:ss.SSS
e_time string(20) 必选 当前文本内容结束时间
返回格式
字段名称 字段类型 约束限制 说明
result int 必选
0 成功
1 错误,如果errIds空, 本批次推送全部失败处理, 如果errIds不为空, 只对errIds对应的推送失败处理
message string 必选 结果消息
errIds
Array
string(50)
 处理失败返回的话单标识
外呼号码绑定
话单推送
短信推送
事件推送
通话扩展信息推送