暂停作业。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
outboundbot:SuspendJobs |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID |
ef4c09ac-2f5c-49e7-9d33-5d85249cee10 |
| All |
boolean |
是 |
过滤条件，是否暂停所有 |
false |
| ScenarioId |
string |
否 |
过滤条件，场景 ID（历史参数，已废弃） |
4b6dd926-3cc3-4111-a333-15d9b006fe81 |
| JobGroupId |
string |
否 |
过滤条件，任务组 ID |
6b3ea2a1-32b3-4041-842b-9bde5de9dda0 |
| JobId |
array |
否 |
作业 ID 列表 说明
当 ALL 为 fasle 时，JobId 为必填 |
|
|
string |
否 |
作业 ID |
11994321-e6bc-47bb-8b1c-8eef8f2f768b |
|
| JobReferenceId |
array |
否 |
作业的第三方 ID。 说明
即为上传外呼名单时客户上传的 ReferenceId |
|
|
string |
否 |
作业的第三方 id |
de3ab269-6746-477c-b13d-bd49f13202c2 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 状态码 |
200 |
| Code |
string |
接口状态码。 |
OK |
| Message |
string |
接口提示消息 |
Success |
| RequestId |
string |
请求 ID |
1364f208-982d-4d0c-89aa-d56e22b47589 |
| Success |
boolean |
是否成功 |
true |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"Code": "OK",
"Message": "Success",
"RequestId": "1364f208-982d-4d0c-89aa-d56e22b47589",
"Success": true
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试，如果多次重试报错请提交工单。 |
| 404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
| 404 | NotExist.JobGroup | The specified JobGroup does not exist. | 指定的任务组不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。