Skip to main content

Endpoint

POST https://api.jelou.ai/v1/bots/{botId}/messages

Parámetros de Ruta

botId
string
required
Identificador único del bot que envía el mensaje.

Cuerpo de la Solicitud

type
string
required
Debe ser "contacts".
contacts
array
required
Array de objetos de contacto. Cada contacto puede incluir nombre, números de teléfono, correos electrónicos y direcciones.
userId
string
required
Identificador único del usuario que recibirá el mensaje.

Estructura del Objeto de Contacto

Ejemplos de Solicitud

cURL
curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/messages \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "contacts",
    "userId": "USER_ID",
    "contacts": [
      {
        "name": {
          "formatted_name": "Juan Pérez",
          "first_name": "Juan",
          "last_name": "Pérez"
        },
        "phones": [
          {
            "phone": "+1234567890",
            "type": "Mobile",
            "wa_id": "1234567890"
          }
        ],
        "emails": [
          {
            "email": "[email protected]",
            "type": "Work"
          }
        ],
        "addresses": [
          {
            "street": "Calle Principal 123",
            "city": "Ciudad de México",
            "state": "CDMX",
            "zip": "01000",
            "country": "México",
            "country_code": "MX",
            "type": "Office"
          }
        ]
      }
    ]
  }'

Respuesta

success
boolean
Indica si el mensaje fue enviado exitosamente.
messageId
string
Identificador único del mensaje enviado.

Ejemplo de Respuesta

{
  "success": true,
  "messageId": "msg_123456789"
}

Notas Importantes

Formato de Teléfono: Siempre usa formato E.164 para números de teléfono (ej: +1234567890) para asegurar compatibilidad entre diferentes regiones.
Completitud del Contacto: Aunque todos los campos son opcionales, proporcionar información completa del contacto (nombre, teléfono, email) mejora la experiencia del usuario y hace los contactos más útiles.

Casos de Uso

  • Compartir información de contacto de soporte
  • Referir usuarios a miembros específicos del equipo
  • Proporcionar información de tarjetas de presentación
  • Compartir contactos de emergencia