视频外呼

日期	版本	修订内容摘要
2024-02-23	v1.0.0	更新接口文档

1.1 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/video-call/voice-videocall

1.2 请求参数

数据提交方式：x-www-form-urlencoded

参数名	参数类型	是否必传	说明
appId	String	是	请在官网登录后获取，详情请看,功能介绍->接口详情
appKey	String	是	请在官网登录后获取，详情请看,功能介绍->接口详情
mobile	String	是	被叫号码，多个号码则以英文半角分号“;”分割，单次最大1000，如果带短信变量，则用“#”隔开,多个短信变量以竖线“
templateId	String	是	语音模版Id，官网控制台创建后产生，且已审核通过
billUrl	String	否	话单推送回调地址（最大长度250）
transData	String	否	透传数据(话单推送回调时返回最大长度50)
displayNum	String	否	主叫号码，由运营提供，未提供的则不需要传
smsHangupStatus	String	否	挂机短信开启标识 0：关闭，1：开启，默认：关闭
smsTemplateId	String	否	挂机短信模板id
smsSendType	String	否	挂机短信发送方式：0:接通后发送，1:全部群发，2:未接通发送，3:按接通时长发送，默认:0
smsSendLimit	String	否	当挂机短信方式为3时必填，单位秒，输入时间规则为大于等于x后发送挂机短信（整数输入大于等于1）
fmsStatus	String	否	闪信状态：0：关闭，1：开启
fmsTemplateId	String	否	闪信模版Id
sendType	String	否	任务发送类型 1-定时任务2-即时任务,不传为即时任务
taskStartTime	String	否	任务开始时间，yyyyMMddHHmmss，eg:20200902170000
taskEndTime	String	否	任务结束时间，yyyyMMddHHmmss，eg:20200902235959
taskName	String	否	任务名称
maxRecallCount	String	否	最大重拨次数，只能0-1，0不重拨，默认：1 重拨1次
recallInterval	String	否	重拨间隔时长（分钟），根据重播间隔*重播次数，时间跨度不能超过三天，默认值60，最大重拨次数大于0时必传
noConnected	String	否	重拨策略：被叫无法接通,true:重拨;false:不重拨,默认值:true
noAnswer	String	否	重拨策略：被叫无人接听,true:重拨;false:不重拨,默认值:true
mobileType	String	否	发送方式： 0:仅安卓发送(默认)，1:安卓设备+未知设备，2:全量发送

请求示例：

{
	"appId": "*****",
	"appKey": "*****,
	"mobile": "176***5202;176***5203",
	"templateId": "123",
	"allowedCallTime": "",
	"billUrl": "http://****/voice/test/test3",
	"transData": "12****44",
	"smsHangupStatus": "1",
	"smsTemplateId": "4123***1",
    "smsSendType": "0",
    "smsSendLimit": "0",
    "fmsStatus": "1",
	"fmsTemplateId": "1123***0",
	"displayNum": "",
	"sendType": "1",
	"taskStartTime": "20230909151800",
	"taskEndTime": "20230909231800",
	"taskName": "示例任务测试",
	"maxRecallCount": "3",
	"recallInterval": "3",
	"noConnected": "true",
	"noAnswer": "true",
    "mobileType": "0",
   
}

1.3 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
callId	string	呼叫唯一标识Id
ios	string	苹果设备号码数据
android	string	安卓设备号码数据
other	string	未识别设备号码数据

1.4 返回数据示例（成功）

{
    "message": "请求成功",
    "data": {
        "callId": "YYYX931******64224",
        "ios":"2",
        "android":"10",
        "other":"5",
    },
    "code": "200000"
}

1.5 返回数据示例（失败）

{
  "message": "系统异常",
  "code": "500000"
}

产品中心

热门搜索

中国站

国际站

视频外呼

视频外呼