Crear Agente

Crea un nuevo agente en tu workspace.

POST https://api.platica.mx/v1/agents

Cuerpo de la solicitud

{
  "name": "Mi Asistente",
  "channel": "whatsapp",
  "systemPrompt": "Eres un asistente especializado en atención al cliente...",
  "channelId": ["channel-123"],
  "phoneNumber": ["+1234567890"],
  "imageUrl": "/images/mi-asistente.png",
  "status": "active",
  "supportInformation": {
    "supportPhone": "+1234567890",
    "supportEmail": "soporte@miempresa.com",
    "supportAddress": "Calle Principal #123",
    "outOfServiceBehavior": "limited",
    "serviceHours": {
      "monday": {
        "availability": "Abierto",
        "start": "9:00am",
        "end": "5:00pm"
      },
      "tuesday": {
        "availability": "Abierto",
        "start": "9:00am",
        "end": "5:00pm"
      },
      "saturday": {
        "availability": "Cerrado",
        "start": "Cerrado",
        "end": "Cerrado"
      },
      "sunday": {
        "availability": "Cerrado",
        "start": "Cerrado",
        "end": "Cerrado"
      }
    }
  },
  "assistanceTriggers": "",
  "assistanceEnabled": true,
  "recallLastConversation": false
}

Parámetros del cuerpo

ParámetroTipoDescripciónRequeridoValor por defecto
namestringNombre del agente (1-100 caracteres)
channelstringPlataforma del agente"whatsapp"
systemPromptstringPrompt del sistema para el agente""
channelIdstring | arrayID(s) del canal de comunicación. Puede ser un ID interno o array de IDs.null
phoneNumberstring | arrayNúmero(s) de teléfono (formato internacional) o array de números.null
imageUrlstringURL de la imagen del agente"/images/campaignCreator.png"
statusstringEstado del agente"inactive"
supportInformationobjectInformación de soporte y horarios. Ver detalles abajo.Configuración por defecto (ver abajo)
assistanceTriggersstringDisparadores de asistencia""
waitMessagestringMensaje de espera""
assistanceEnabledbooleanSi la asistencia está habilitadatrue
recallLastConversationbooleanSi debe recordar la última conversaciónfalse
{
  "supportAddress": "",
  "supportEmail": null,
  "supportPhone": null,
  "outOfServiceBehavior": "limited",
  "serviceHours": {
    "monday": { "availability": "Abierto", "start": "9:00am", "end": "5:00pm" },
    "tuesday": { "availability": "Abierto", "start": "9:00am", "end": "5:00pm" },
    "wednesday": { "availability": "Abierto", "start": "9:00am", "end": "5:00pm" },
    "thursday": { "availability": "Abierto", "start": "9:00am", "end": "5:00pm" },
    "friday": { "availability": "Abierto", "start": "9:00am", "end": "5:00pm" },
    "saturday": { "availability": "Cerrado", "start": "Cerrado", "end": "Cerrado" },
    "sunday": { "availability": "Cerrado", "start": "Cerrado", "end": "Cerrado" }
  }
}
ValorDescripción
whatsappCanal de WhatsApp Business
telegramCanal de Telegram
instagramCanal de Instagram Direct
facebookCanal de Facebook Messenger
smsCanal de mensajes SMS

Respuesta

{
  "status": "success",
  "message": "Agent created successfully",
  "data": {
    "id": "agent_abc123"
  }
}