语音接入

适用范围

本接口适用于如下产品类型：语音验证码、语音通知

服务器地址

http://apivoice.huaxincloud.com:8081/

接入列表

语音验证码
语音验证码回调
语音通知
语音通知回调

请求地址

/custom/{customId}/voice/send

请求参数

属性	类型	约束	举例	说明
productId	String	必须	B2016000213	已订购的产品ID
content	String	必须	3333	验证码内容
mobile	String	必须	13333333333	号码
reqId	String	必须	1234trsdfg	用户自定义字段，推送时原样带回(唯一交易码)

JSON请求示例

{
"productId":"B2016000213",
"content":"1234",
"mobile":"13333333333"
"reqId":"abcd1234"
}

响应包体

属性	类型	约束	举例	说明
transactId	String	必须	nIqa3aSqBxcb6ZxmflF20160327	交易唯一编码
errorCode	String	必须	0	发送状态0:正常
msg	String	必须	正常	消息

JSON响应示例

{
"transactId":"nIqa3aSqBxcb6ZxmflF20160327",
"errorCode":"0",
"msg":"正常"
}

请求地址

语音验证码采用接口主动推送的形式进行获取，需要用户提供一个接收接口

请求参数

属性	类型	约束	举例	说明
transactId	String	必须	SLIJFLgYbtmI6JbUUGO20150911	交易唯一编码
mobile	String	必须	13333333333	手机号码
status	String	必须	success	success:接通，failed:未接通
code	int	必须	1	接通状态的code,外呼成功为1，外呼失败为0
call_time	String	必须	2016-09-10 10:43:21	通话开始时间,格式:yyyy-mm-dd HH:mm:ss
end_time	String	必须	2016-09-10 10:43:29	通话结束时间,格式:yyyy-mm-dd HH:mm:ss
reqId	String	必须	123sdfghjfred	用户自定义字段，推送时原样带回(唯一交易码)

JSON请求示例

{
"transactId":"SLIJFLgYbtmI6JbUUGO20150911",
"status":"success",
"code":"1",
"call_time":"2016-09-10 10:43:21",
"end_time":"2016-09-10 10:43:29",
"reqId":"123zxfgtrd"
}

响应包体

属性	类型	约束	举例	说明
result	String	必须	SUCC	SUCC成功,其他失败

JSON响应示例

{
"result":"SUCC"
}

请求地址

/custom/{accountSid}/notice/send

请求参数

属性	类型	约束	举例	说明
productId	String	必须	B2016000009	已订购的产品ID
audioNum	String	必须	N121	模板id指定
reqId	String	必须	abcd1234	用户方id
mobile	String	必须	13333333333	手机号码

JSON请求示例

{
"productId":"B2016000009",
"audioNum":"N121",
"reqId":"abcd1234",
"mobile":"13333333333"
}

响应包体

属性	类型	约束	举例	说明
transactId	String	必须	nIqa3aSqBxcb6ZxmflF20160327	交易唯一编码
errorCode	String	必须	0	发送状态0：正常
msg	String	必须	正常	消息

JSON响应示例

{
"transactId":"nIqa3aSqBxcb6ZxmflF20160327",
"errorCode":"0",
"msg":"正常"
}

请求地址

语音通知采用接口主动推送的形式进行获取，需要用户提供一个接收接口

请求参数

属性	类型	约束	举例	说明
transactId	String	必须	SLIJFLgYbtmI6JbUUGO20150911	交易唯一编码
status	String	必须	0	0:接通
talk_time	int	必须	100	通话时间
reqId	String	必须	123sdfghjfred	用户自定义字段，推送时原样带回(唯一交易码)

JSON请求示例

{
"transactId":"SLIJFLgYbtmI6JbUUGO20150911",
"status":"0",
"talk_time":"100",
"reqId":"ancd1234"
}

响应包体

属性	类型	约束	举例	说明
result	String	必须	SUCC	SUCC成功,其他失败

JSON响应示例

{
"result":"SUCC"
}

请求地址

/custom/{customId}/secretCall/sendCall

请求参数

属性	类型	约束	举例	说明
productId	String	必须	B20160000123	已订购的产品ID
calling	String	必须	13333333333	号码1
called	String	必须	18888888888	号码2
reqId	String	必须	abcd1234	用户方交易号
callbackUrl	String	可选	http://abc.com	回调地址
expiryDate	String	必须	2016-09-11 10:10:00	设定到期时间,格式：yyyy-MM-dd HH:mm:ss;默认1小时后过期，最长时间限制在4小时以内

JSON请求示例

{
"productId":" B2016000213",
" calling ":"13333333333",
" called ":"18888888888",
"reqId":"abcd1234",
"callbackUrl":"http://1234.com",
"expiryDate":"2016-08-08 15:29:45"
}

响应包体

属性	类型	约束	举例	说明
transactId	String	必须	SLIJFLgYbtmI6JbUUGO20150911	网关产生唯一业务标识id
reqId	String	可选	abcd1234	如果用户在请求时有reqId，会在回调时返回
errorCode	String	必须	0	0：正常；其他详见错误码
msg	String	必须	正常	状态码描述
phonein	String	必须	010-12345678	分配副号码

JSON响应示例

{
"transactId":"nIqa3aSqBxcb6ZxmflF20160327",
"errorCode":"0",
"msg":"正常",
"phonein":"010-12345678",
"reqId":"abcd1234"
}

请求地址

POST / callbackURL (号码保护发送时的callbackurl参数)；本请求是由我方发起，请求您的服务器；此地址在“号码保护发送”请求中上传

请求参数

属性	类型	约束	举例	说明
transactId	String	必须	SLIJFLgYbtmI6JbUUGO20150911	交易唯一编码
status	String	必须	3	3:成功，4:失败
msg	String	必须	正常	状态描述
counts	String	必须	3	次数:第几次通话
call_time	String	必须	2016-08-04 12:43:23	外呼结束时间格式：yyyy-MM-dd HH:mm:ss
end_time	String	必须	2016-08-04 12:44:21	外呼结束时间格式：yyyy-MM-dd HH:mm:ss
calling_seconds	String	必须	97	主叫通话时长(秒数)
called_seconds	String	必须	97	被叫通话时长(秒数)
reqId	String	必须	abcd1234	用户自定义字段，推送时原样带回(唯一交易码)
direction	String	必须	1	1:主叫发起通话（号码保护发送时的calling发起通话），2:被叫发起通话（号码保护发送时的called发起通话）

JSON请求示例

{
"transactId":"nIqa3aSqBxcb6ZxmflF20160327",
" status ":"0",
"msg":"正常",
"counts":"3",
"call_time":"2016-08-04 12:43:23",
"end_time":"2016-08-04 12:44:02",
"calling_seconds":"97",
"called_seconds":"97",
"reqId","abcd1234",
"direction":"1"
}

响应包体

属性	类型	约束	举例	说明
result	String	必须	SUCC	SUCC成功,其他失败

JSON响应示例

{
"result":"SUCC"
}

请求地址

/custom/{customId}/secretCall/expiry

请求参数

属性	类型	约束	举例	说明
transactId	String	必须	SLIJFLgYbtmI6JbUUGO20150911	交易唯一编码
reqId	String	必须	abcd1234	发送号码保护时的reqId
productId	int	必须	B2016000133	已订购的产品ID

JSON请求示例

{
"productId":"B2016000213",
"transactId":"nIqa3aSqBxcb6ZxmflF20160327" ,
"reqId":"998456"
}

响应包体

属性	类型	约束	举例	说明
transactId	String	必须	nIqa3aSqBxcb6ZxmflF20160327	交易唯一编码
errorCode	String	必须	0	发送状态0:正常
msg	String	必须	正常	消息

JSON响应示例

{
"transactId":"nIqa3aSqBxcb6ZxmflF20160327",
"errorCode":"0",
"msg":"正常"
}

接入指南

常见问题

服务条款

接入文档

DEMO下载

语音接入

适用范围

本接口适用于如下产品类型：语音验证码、语音通知

服务器地址

http://apivoice.huaxincloud.com:8081/

接入列表

请求地址

/custom/{customId}/voice/send

请求参数

JSON请求示例

响应包体

JSON响应示例

请求地址

语音验证码采用接口主动推送的形式进行获取，需要用户提供一个接收接口

请求参数

JSON请求示例

响应包体

JSON响应示例

请求地址

/custom/{accountSid}/notice/send

请求参数

JSON请求示例

响应包体

JSON响应示例

请求地址

语音通知采用接口主动推送的形式进行获取，需要用户提供一个接收接口

请求参数

JSON请求示例

响应包体

JSON响应示例

请求地址

/custom/{customId}/secretCall/sendCall

请求参数

JSON请求示例

响应包体

JSON响应示例

请求地址

POST / callbackURL (号码保护发送时的callbackurl参数)； 本请求是由我方发起，请求您的服务器；此地址在“号码保护发送”请求中上传

请求参数

JSON请求示例

响应包体

JSON响应示例

请求地址

/custom/{customId}/secretCall/expiry

请求参数

JSON请求示例

响应包体

JSON响应示例

恭喜您注册成功

POST / callbackURL (号码保护发送时的callbackurl参数)；本请求是由我方发起，请求您的服务器；此地址在“号码保护发送”请求中上传