渠道客服虚拟号接口
接口说明
- 接口为幂等实现，幂等条件为 orderNo + csPhone + driverPhone(订单相关的司机真实号)
- 调用时，如果根据幂等条件查询出的绑定关系已经失效，或即将失效(距离真正的失效时间差1分钟以内)，则触发重新绑定(虚拟号可能会变)
- 相同幂等条件下，最多存在10个绑定关系(即最多允许创建10次)
- 创建的虚拟号使用自动解绑逻辑，依据绑定时传入的有效时长
- 渠道使用此功能需要联系商务/产品来开通此功能
接口地址
https:// <SQYC_DOMAIN>/carapi/partner/cs-virtual
请求方式
POST
请求参数
| 参数名称 | 参数类型 | 是否必传 | 参数说明 |
|---|---|---|---|
| channel | string | 是 | 渠道调用身份标识 |
| orderNo | string | 是 | 首汽订单号 |
| partnerOrderNo | string | 是 | 渠道订单号(与orderNo关联的订单号) |
| csPhone | string | 是 | 客服使用的真实号码, 11位大陆手机号或者座机号(座机号需要带有区号前缀, 区号与号码间不使用分隔符) |
| duration | int | 否 | 用于自定义虚拟号的绑定时长, 单位:分钟, 不传递则使用默认值30分钟, 最小值5分钟, 最大值1440分钟(24小时) |
| sign | string | 是 | 签名 |
返回数据
| 字段名称 | 字段类型 | 字段说明 |
|---|---|---|
| result | int | 0-成功, 1-失败 |
| errmsg | string | 错误说明 |
| data | object | 对象结构见下方示例 |
返回示例
{
"result": 0,
"errmsg": "",
"data": {
"virtualPhone": "13012345678",
"extraInfo": { // 额外信息,目前仅包含司机昵称
"driver": "赵先生/女士", // 司机昵称
}
}
}