停止活动批次

开发环境

POST

/v1/batches/{batch_id}/stop

批量停止所有活动呼叫。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v1/batches//stop' \
--header 'authorization: <authorization>'

响应示例

{
  "status": "success",
  "message": "Successfully stopped batch",
  "num_calls": 1205,
  "batch_id": "5e5b1a3a-2b0a-4b9e-8b9e-asdf-gen-batch"
}

请求参数

Path 参数

batch_id

string

必需

要取消的批次的唯一标识符。

Header 参数

authorization

string

必需

示例值:

🟢200成功

application/json

Body

status

string

必需

请求的状态。如果不是“成功”，则表明发生了错误或所有调用均已完成。

message

string

必需

描述请求状态的消息。

num_calls

integer

已取消的呼叫数量。

必需

batch_id

string

必需

已batch_id取消批次的。

修改于 2024-05-10 09:15:20