Obtener un Agente

Obtiene la información detallada de un agente específico.

GET https://api.platica.mx/v1/agents/{agentId}

Parámetros de URL

ParámetroTipoDescripciónRequerido
agentIdstringIdentificador único del agente

Respuesta

{
  "workspaces": [
    {
      "id": "ws_001",
      "name": "Soporte Técnico",
      "agents": [
        {
          "id": "agent_789def",
          "name": "Asistente Técnico",
          "status": "active",
          "channel": "whatsapp",
          "owners": [
            "soporte@empresa.com"
          ],
          "comunicationChannel": {
            "channelId": ["channel-1", "channel-2"],
            "phoneNumber": ["phoneNumber-1"]
          },
          "systemPrompt": "Eres un asistente técnico especializado...",
          "imageUrl": "/images/campaignCreator.png",
          "supportInformation": {
            "supportAddress": "Avenida principal #1",
            "supportEmail": "soporte@platica.mx",
            "supportPhone": "12345689101",
            "serviceHours": {
              "monday": {
                "start": "12:00am",
                "end": "11:59pm",
                "availability": "Abierto"
              }
            }
          },
          "assistanceTriggers": "",
          "waitMessage": "",
          "assistanceEnabled": true,
          "recallLastConversation": false,
          "creationDate": null,
          "lastUpdate": "2025-03-14T12:00:00Z"
        }
      ],
      "agentsCount": 1
    }
  ]
}

Campos de la respuesta

CampoDescripción
idID interno del agente
nameNombre del agente
statusEstado del agente: active o inactive
channelPlataforma del agente
ownersLista de correos de usuarios responsables
comunicationChannel.channelIdIDs del canal, siempre como arreglo
comunicationChannel.phoneNumberNúmeros telefónicos, siempre como arreglo
systemPromptPrompt del sistema
imageUrlURL de imagen
supportInformationConfiguración de soporte y horarios
assistanceTriggersDisparadores de asistencia
waitMessageMensaje de espera
assistanceEnabledSi la asistencia está habilitada
recallLastConversationSi recuerda la última conversación
creationDateFecha de creación en formato ISO 8601
lastUpdateFecha de última actualización en formato ISO 8601