CloudPreviewoutcall - 座席外呼

更新时间:
复制为 MD 格式

当座席在线时,通过此接口进行呼叫。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

EnterpriseId

integer

呼叫中心 id

7000002

Cno

string

座席工号;3-10 位数字

1111

Tel

string

需要进行呼叫的客户方电话号码,固话带区号,手机不加 0。 当开启号码隐藏设置时,可从弹屏事件中获取 customerNumberKey 的值,进行外呼;加密外呼;如果是加密的号码,需要 URLEncode 后传入;当外呼相关配置-支持分机号外呼开启后,此字段可支持传手机号-分机号格式

1774821736

Timeout

integer

呼叫座席侧超时时间;取值范围 5<=timeout<=60,默认 30(单位:s)

16

DialTelTimeout

integer

呼叫客户侧超时时间;取值范围 5<=dialTelTimeout<=60,默认 45(单位:s)

26

CallVariables

string

通道变量可以在以下场景中使用:1. 事件推送,作为推送字段使用 2. 通话记录中,将字段存储在自定义字段 3. 通过 SIP-Header 方式将字段传到呼叫的下游链路格式如: [{"name":"mainUniqueId","value":"cdr_main_unique_id","type":"2"},{"name":"callType","value":"cdr_call_type","type":"2"}]name:变量名称 value:变量值 type:变量类型,1.普通变量 2.PJSIP_HEADER 变量(用于将变量通过 SIP-Header 方式传到客户侧,最多支持 5 个)

[{"name":"mainUniqueId","value":"cdr_main_unique_id","type":"2"},{"name":"callType","value":"cdr_call_type","type":"2"}]

RequestUniqueId

string

请求唯一 id;取值:如果没有传入值则系统会生产。如果是加密的号码,需要 URLEncode 后传入

req1234567

BackupTels

string

备用外呼号码;tel 没呼通时呼叫备用号码,最多支持 5 个号码,多个之间用逗号分隔

41008502

IsInvestigation

integer

是否满意度调查;0.不进行满意度调查 1.进行满意度调查,默认:取企业配置

0

CdrIsAsr

integer

此次通话录音是否进行 ASR 转写;0.不进行 1.进行 默认:1

1

CrnId

string

外显导航标识

12333

ObClid

string

可传入企业中继号码或设置好的客户侧外显号码

41008502

ObClidAreaCode

string

指定外显区号;传入区号,在指定区号下外显号码;如果 obClid 和 obClidAreaCode 都传的情况下,按照 obClid 外显

010

ObClidGroup

string

客户侧外显号码组;使用 clidGroup 需要账号支持按标识路由,使用此参数时 clid 参数无效

333

ClidList

string

外显号码集合, 格式如: [{"clid":"1708587xxxx","priority":1},{"clid":"1304412xxxx","priority":2},{"clid":"0107990xxxx","priority":3}] clid:外显号码(String 类型)(必填)priority:优先级(Integer 类型)(非必填) 特别说明: 一次呼叫最多允许传 10 个指定号码;若指定了号码优先级,要求所有传入的号码都必传

[{"clid":"1708587xxxx","priority":1},{"clid":"1304412xxxx","priority":2},{"clid":"0107990xxxx","priority":3}]

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

访问被拒绝详细信息。

RequestId

string

请求 ID

7BF47617-7851-48F7-A3A1-2021342A78E2

Message

string

返回信息。

OK

Data

object

返回结果。

Result

integer

结果

0

Code

string

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见 API 错误码

OK

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "无",
  "RequestId": "7BF47617-7851-48F7-A3A1-2021342A78E2",
  "Message": "OK",
  "Data": {
    "Result": 0
  },
  "Code": "OK"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情