Stop processing a batch of call sessions

Request

Stop processing a batch of call sessions. This will prevent any queued calls in the batch from being initiated. Calls that are already in progress will not be affected and will continue until completion.

Security

BasicAuth or SinchOAuth2

Path

projectIdstring, (uuid)(Project ID)required

The ID of the project.

batchIdstring, (ulid)(Batch ID)required

The ID of the batch.

curl -i -X DELETE \
  -u '<username>:<password>' \
  'https://voice.api.sinch.com/v2/projects/{projectId}/batches/{batchId}'

Responses

Batch call processing cancellation received.

Bodyapplication/json

resultstring

State of the batch processing cancellation request

Value	Description
STOP_REQUESTED	Batch call processing cancellation requested. No new calls will be initiated.

Response

{
  "result": "STOP_REQUESTED"
}

We'd love to hear from you!