Crear enlace de compartición

Cree un enlace de compartición para el Agente mediante la clave API del Agente; los usuarios finales podrán abrir el enlace y chatear directamente con el Agente. Se pueden configurar la vigencia del enlace, el número máximo de usuarios, el número máximo de mensajes que cada usuario puede enviar, la contraseña de acceso y si se habilitan sugerencias de retroalimentación. El efecto es completamente idéntico a crear un enlace de compartición manualmente en la página de «Compartir».

• Los enlaces de compartición creados se sincronizarán en la lista de enlaces de compartición del Agente; puede ver el número de usuarios y el consumo de créditos en la consola, y continuar editando o eliminando. Los miembros de la organización que tengan permisos para editar/eliminar enlaces de compartición pueden operar los enlaces creados mediante la API.
• El consumo de créditos generado por los enlaces de compartición se contabiliza en la organización a la que pertenece el Agente.
• Si la organización ha vinculado un dominio personalizado, la dirección del enlace de compartición devuelto utilizará el dominio personalizado.
• Solo se admite Agente; el uso de la clave API de Workflow devolverá un tipo de Bot incorrecto.
• Si el sitio actual no tiene habilitado el canal de integración de «Compartir», la llamada devolverá que la operación no es compatible.

Método de solicitud

POST

URL de la solicitud

https://api-${endpoint}.gptbots.ai/v1/agent/share/create

Verificación de la llamada

Para más detalles, consulte la explicación sobre la autenticación en la sección Descripción general de la API. Use la clave API del Agente objetivo como token.

Solicitud

Ejemplo de solicitud

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/agent/share/create' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
        "name": "官网试用链接",
        "valid_days": 7,
        "user_limit": 10,
        "user_question_limit": 9999,
        "password": "Vc3h",
        "feedback_enabled": true
}'

                    

Todos los parámetros son opcionales. Si el cuerpo de la solicitud envía {}, se creará un enlace para compartir permanentemente válido, sin necesidad de contraseña, con un máximo de 10 usuarios, hasta 9999 mensajes por usuario, y sin habilitar sugerencias de retroalimentación. Si desea restringir el acceso, debe enviar explícitamente valid_days y password.

Los nombres de los campos usan notación con guion bajo (snake_case). Si aparecen campos en el cuerpo de la solicitud que no se reconocen (por ejemplo, escritos en camelCase como validDays), la API devolverá 40000 y listará estos campos en el mensaje de error, sin crear el enlace.

Encabezado de la solicitud

Parámetros de la solicitud

Respuesta

Ejemplo de respuesta

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "share_id": "66f8c2a1e4b0a93c5d7f1a20",
    "link": "https://www.gptbots.ai/s/csAbC123",
    "expire_time": 1760112000000
  }
}

                    

Respuesta Exitosa

Respuesta Fallida

Códigos de Error