La API de Lotes de Mensajes admite el mismo conjunto de funciones que la API de Mensajes. Si bien esta página se centra en cómo usar la API de Lotes de Mensajes, consulte ejemplos de la API de Mensajes para ver ejemplos del conjunto de funciones de la API de Mensajes.

Creando un Lote de Mensajes

JSON
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch",
  "processing_status": "in_progress",
  "request_counts": {
    "processing": 2,
    "succeeded": 0,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2024-09-24T18:37:24.100435Z",
  "expires_at": "2024-09-25T18:37:24.100435Z",
  "cancel_initiated_at": null,
  "results_url": null
}

Consultando la finalización del Lote de Mensajes

Para consultar un Lote de Mensajes, necesitarás su id, que se proporciona en la respuesta al crear la solicitud o al listar los lotes. Ejemplo de id: msgbatch_013Zva2CMHLNnXjNJJKqJ2EF.

Listando todos los Lotes de Mensajes en un Espacio de Trabajo

Output
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch",
  ...
}
{
  "id": "msgbatch_01HkcTjaV5uDC8jWR4ZsDV8d",
  "type": "message_batch",
  ...
}

Recuperando Resultados del Lote de Mensajes

Una vez que el estado de tu Lote de Mensajes sea ended, podrás ver la results_url del lote y recuperar los resultados en forma de archivo .jsonl.

Output
{
  "id": "my-second-request",
  "result": {
    "type": "succeeded",
    "message": {
      "id": "msg_018gCsTGsXkYJVqYPxTgDHBU",
      "type": "message",
      ...
    }
  }
}
{
  "custom_id": "my-first-request",
  "result": {
    "type": "succeeded",
    "message": {
      "id": "msg_01XFDUDYJgAACzvnptvVoYEL",
      "type": "message",
      ...
    }
  }
}

Cancelando un Lote de Mensajes

Inmediatamente después de la cancelación, el processing_status de un lote será canceling. Puedes usar la misma técnica de consulta de finalización del lote para consultar cuándo se finaliza la cancelación, ya que los lotes cancelados también terminan en estado ended y pueden contener resultados.

JSON
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch",
  "processing_status": "canceling",
  "request_counts": {
    "processing": 2,
    "succeeded": 0,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2024-09-24T18:37:24.100435Z",
  "expires_at": "2024-09-25T18:37:24.100435Z",
  "cancel_initiated_at": "2024-09-24T18:39:03.114875Z",
  "results_url": null
}