Удалить пакет сообщений

DeletedMessageBatch Messages.Batches.Delete(parameters, cancellationToken = default)

DELETE/v1/messages/batches/{message_batch_id}

Удалите пакет сообщений.

Пакеты сообщений можно удалять только после завершения их обработки. Если вы хотите удалить пакет, находящийся в обработке, сначала необходимо его отменить.

Подробнее о Message Batches API читайте в нашем руководстве пользователя

Parameters

BatchDeleteParams parameters

required string messageBatchID

ID of the Message Batch.

string workspaceID

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns

class DeletedMessageBatch { Type = "message_batch_deleted"; ID; }

JsonElement Type = "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

required string ID

ID of the Message Batch.

Удалить пакет сообщений

BatchDeleteParams parameters = new() { MessageBatchID = "message_batch_id" };

var deletedMessageBatch = await client.Messages.Batches.Delete(parameters);

Console.WriteLine(deletedMessageBatch);

Response 200

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}

Returns Examples

Response 200

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}