CloudWebcall - webcall接口

更新时间:
复制为 MD 格式

通过本接口,第三方平台可以给托管型呼叫中心发送呼叫请求,系统分别呼叫客户和座席,先呼叫客户再呼叫座席,并把双方接通。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

EnterpriseId

integer

呼叫中心 id

7000002

Tel

string

电话号码;固话带区号,手机不加 0;固话带分机的以'-'分隔;支持多个号码,多个直接用英文逗号’,’分隔;传多个号码时,若前面的号码没接通则会呼叫后面的号码,若接通则不会呼叫;加密外呼;如果是加密的号码,需要 URLEncode 后传入

13312345678

RequestUniqueId

string

请求唯一标识;说明:长度不超过 300 个字节。1 个汉字是 3 字节。此字段保存到通话记录 requestUniqueId 字段,后续接口查询使用。一次接口请求造成的多次呼叫 requestUniqueId 相同;如果是加密的号码,需要 URLEncode 后传入

requset12345

UserField

string

用户自定义字段;说明:长度不超过 250 个字节。1 个汉字是 3 字节。此字段保存到通话记录 userField 字段,后续接口查询使用。该字段需“动态附带参数”paramNames 有值时方可生效。

UserField

Timeout

integer

呼叫客户超时时间;说明:参数取值范围 0<=timeout<=60;不传入,默认 30(单位:s)

30

Amd

integer

是否开启 amd;自动应答检查(传真机等),1.开启 0.不开启 默认为 0

0

Delay

integer

延迟时长;秒数,延迟多少秒呼叫 参数取值范围:0<=delay<=60 默认为 0

20

MultiTelDelay

integer

多号码时呼叫延时;tel 多个号码时,号码之间的呼叫延迟,最大 120 秒,默认 0

0

MultiTelPush

integer

多号码,是否每个号码呼叫都挂机推送;取值说明 0:只挂机推送一次; 1:每次呼叫都触发挂机推送;默认 0

0

Clid

string

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

41008502

ClidGroup

string

客户侧外显号码组;使用 clidGroup 需要账号支持按标识路由,优先级低于 clid

clidGroup

ClidList

string

指定本次外呼使用的客户侧外显号码集合,系统将根据号码调度策略选择可用号码进行外呼

41008502

ClidAreaCode

string

客户侧外显指定地区号码,优先级低于 clid

010

IvrId

integer

回呼接通后进入的 ivrId;如果不传此参数,使用后台配置的 ivr

70

CrnId

string

外显导航标识

33

Vid

string

用哪种语言播放 ivr 提示音;1.普通话 2.粤语 4.标贝 TTS 5.普通话-甜美女音 默认为 1

1

Retry

integer

重试次数;最大 5 次,使用的企业需要开启 webcall 自动重试开关

2

RetryInterval

integer

重试间隔,单位分钟,最小 0 分钟,最大 59 分钟

3

ExpirTime

string

过期时间,精确到 s,yyyy-MM-dd HH:mm:ss

2026-04-20 10:00:00

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

访问被拒绝详细信息。

RequestId

string

请求 ID。

9FF70B74-1B3C-44C1-ACDF-8DF962988F0E

Message

string

状态码的描述。

OK

Data

object

返回数据。

Result

integer

结果

0

Code

string

状态码。

OK

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "无",
  "RequestId": "9FF70B74-1B3C-44C1-ACDF-8DF962988F0E",
  "Message": "OK",
  "Data": {
    "Result": 0
  },
  "Code": "OK"
}

错误码

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

变更历史

更多信息,参考变更详情