启动外呼任务
服务描述
本接口,可用于企业自行启动已创建好的外呼任务
开发须知
调用本接口前,请先获取appId
服务地址
POST https://{您的专属域名}/outbound/openapi/v2/task/start
请求参数
参数 | 位置 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
appId | header | String | Y | 应用ID |
timestamp | header | String | Y | 时间戳,毫秒 |
sign | header | String | Y | 签名 |
encrypted | header | String | N | 是否需要加密,需要加密传值(加密方式):AES/REQBODY/RESP,不需要加密不用传该字段 |
Content-Type | header | String | Y | application/json |
taskCode | url地址栏 | String(32) | N | url请求参数,url?taskCode={任务编码} |
请求数据示例:
POST https://{您的专属域名}/outbound/openapi/v2/task/start?taskCode=bdca4ca8c5e8f9d8db12b060e541eec7
返回结果加密
加密方式
header
中的encrypted
传值,表示需要对返回结果进行加密,拿到加密后的返回结果, 使用私钥加解密工具进行解密
返回结果
- 需要加密,以下是返回结果加密前的json
- 不需要加密则直接直接返回不加密的结果
参数 类型 说明 code String 结果码 message String 结果描述 data boolean true成功false失败
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": true
}
结果码说明
结果码 | 说明 |
---|---|
10000 | 请求成功 |
20001 | 请求失败 |
21002 | 认证失败,请重新登录 |