验证码外呼

访问地址:http://voice.3tong.net/json/voiceSms/SubmitVoc

提交方式:

接口数据输入输出均采用JSON格式封装的字符串,编码(对整个请求的字符串编码)统一为UTF-8,采用post方式提交请求

功能:

提交验证码内容,系统使用默认提示音播放该验证码

请求参数:

参数值说明:以下json内容为提交请求数据格式
{
    "account":"dh****",
    "password":"0243614f784a8cfa94a94b85cbee7540",
        "data":[{
            "msgid":"49a5f1d78ab84b90a963beac04867888",
            "callee":"157****6131",
            "text":"255178",
            "calltype":1,
            "playmode":0,
            "params":{"param1":"value1","param2":"value2"}
            },{
            "msgid":"49a5f1d78ab84b90a963beac04867b74",
            "callee":"157****6132",
            "text":"211456",
            "calltype":1,
            "playmode":0
            }]
    }

示例解释:上述请求一共提交了两条验证码语音消息内容。
参数名称 约束 说明
account 必须(String) 用户账号
password 必须(String) 用户密码,需采用MD5加密(32位小写)
needallresp 非必须(String) 当值为字符串true时,响应中包含所有提交的msgid
下列为一次请求中携带的具体消息参数(可多条):
msgid 必须(String) 消息编号ID,必须唯一,不可为空,最大长度64位
callee 必须(String) 被叫号码。只能有一个号码。
text 必须(String) 验证码内容,只允许4~8位的数字验证码
playmode 必须(int) 放音模式: 0-只播放文本
calltype 必须(int) 外呼类型:1-验证码呼叫
params 可选(Map对象) 终端客户自定义参数params(总长度限制为1000)

返回示例:

{
    "result":"DH:0000",
    "desc":"成功",
    "data":[{
        "status":"DH:1004",
        "desc":"存在无效号码/限制运营商号码",
        "msgid":"49a5f1d78ab84b90a963beac04867b74",
        "callee":"157****6132"
        }]
}
示例解释:外呼请求的响应一般只会返回result,只有存在错误数据时才会返回data,status是错误码(提交响应码),desc是错误描述。

返回参数说明:

参数名 说明
result 总的提交结果状态码;说明请参照:提交响应码
desc 提交结果描述下列为响应中可能携带的具体消息的参数(可多条)
status 状态码
desc 描述
msgid 消息编号
callee 被叫号码
文档更新时间: 2024-08-28 09:07   作者:admin