Usar el punto de conexión /conversation/{conversationId}/messages

Recupere una lista de todos los mensajes intercambiados en una conversación activa. La respuesta se estructura mediante el esquema de actividad de Bot Framework.

Si no hay ningún mensaje para el identificador de conversación, la API devuelve una matriz vacía.

Nota:

No use el punto de conexión de conversaciones como mecanismo de sondeo. Los eventos de conversación se publican en Microsoft y las actualizaciones se envían de vuelta al webhook suscrito.

Método

GET

URL

/api/v1.0/consumer/conversation/{conversationId}/messages

Parámetros de solicitud

Parámetro Description Tipo Obligatorio
Id de conversación Identificador único de la conversación para recuperar mensajes. Cadena GUID Sí

Parámetros de consulta (opcional)

Los parámetros de consulta permiten filtrar, limitar y paginar los mensajes devueltos por la API para una recuperación de datos eficaz.

Parámetro Description Tipo
StartTimeStamp Filtra los mensajes enviados después de la marca de tiempo especificada. La marca de tiempo debe estar en formato ISO 8601 y codificada con dirección URL. datetimeoffset (ISO 8601)
PageSize Especifica el número máximo de mensajes que se van a devolver. El valor predeterminado es 50 y el máximo es 100. entero
Token de Continuación Recupera el siguiente lote de resultados para la paginación. El token debe estar codificado con dirección URL. DatetimeOffset

Carga de respuesta

{
  "messages": [
    {
      "type": "message",
      "attachments": [],
      "text": "Message 1",
      "messageId": "12313",
      "timestamp": "2025-04-15T12:37:00+00:00",
      "from": {},
      "channelData": {}
    },
    {
      "type": "message",
      "attachments": [],
      "text": "Message 2",
      "messageId": "12314",
      "timestamp": "2025-04-15T12:38:00+00:00",
      "from": {},
      "channelData": {}
    }
  ],
  "continuationToken": "2025-04-15T12:38:00+00:00"
}

Parámetros de respuesta

Clave de nivel 1 Clave de nivel 2 Clave de nivel 3 Description Tipo
messages [ ] — Matriz JSON de objetos de actividad de Bot Framework array
type — Tipo de mensaje (por ejemplo, mensaje) cuerda / cadena
datos adjuntos [ ] Matriz de datos adjuntos (si existe) array
texto — Contenido del mensaje cuerda / cadena
ID de mensaje — Identificador único del mensaje cuerda / cadena
marca de tiempo — Marca de tiempo cuando se envió el mensaje DatetimeOffset
desde — Metadatos del remitente objeto
datos de canal — Metadatos de mensajes adicionales objeto
token de continuación — — Token para recuperar la página siguiente de resultados DatetimeOffset

Introducción a las API de mensajería

  • Last updated on