Visión general

La API de chat facilita la obtención de chatbots y permite a los usuarios interactuar con ellos publicando mensajes.

URL base

https://app.openspokenai.com/api

Autenticación

Los clientes deben autenticarse con una cabecera de autorización básica para cada solicitud:

Autorización: Basic {authString}

Donde {authString} es la cadena codificada en base64 con el formato username:password.

Ejemplo de uso: 

curl -X GET "https://app.openspokenai.com/api/chat" -H "Authorization: Basic {authString}"

Puntos finales

GET /chat

Recupera una lista de chats activos disponibles para interactuar.

Parámetros de consulta:

grupo (opcional): Filtra los chats por un grupo especificado.

Respuesta satisfactoria:

{

    "mensaje": "éxito",

    "datos": [

        {

            "nombre": "cadena",

            "chat_code": "string",

            "descripción": "cadena",

            "grupo": "cadena"

        }

    ]

}

No se ha encontrado contenido:

{

    "mensaje": "error",

    "datos": {

        "mensaje": "No se ha encontrado ningún chatbot para el grupo especificado".

    }

}

POST /chat

Envía un mensaje a un chat específico y recibe una respuesta.

Cabeceras:

Content-Type: application/json

Autorización: Basic {authString}

Carga útil requerida:

prompt: (cadena) El texto de entrada para la respuesta del chat.

request_id: (cadena) Un ID único para rastrear la solicitud.

webhook_url (opcional): (URL) El punto final al que se debe enviar la respuesta a través de webhook.

Respuesta satisfactoria:

{

    "mensaje": "éxito",

    "datos": {

        "request_id": "string",

        "mensaje": "cadena"

    }

}

Respuestas de error:

Créditos insuficientes:

{

    "mensaje": "error",

    "datos": {

        "mensaje": "Te has quedado sin créditos para generar palabras. Por favor, recargue e inténtelo de nuevo".

    }

}

Chatbot no encontrado:

{

    "mensaje": "error",

    "datos": {

        "Mensaje": "Chatbot no encontrado".

    }

}

Fallo del webhook:

{

    "mensaje": "error",

    "datos": {

        "mensaje": "Error al enviar la respuesta al webhook".

    }

}