Créer un lien de partage

Créez un lien de partage pour cet Agent via sa clé API. Les utilisateurs finaux peuvent ouvrir le lien pour dialoguer directement avec l’Agent. Il est possible de définir la durée de validité du lien, le nombre maximal d’utilisateurs, le nombre maximal de messages que chaque utilisateur peut envoyer, un mot de passe d’accès et si les suggestions de retour sont activées, avec le même effet que de créer le lien manuellement sur la page « Partage ».

• Les liens de partage créés seront synchronisés dans la liste des liens de partage de l’Agent. Il est possible de consulter le nombre d’utilisateurs et la consommation de crédits via la console, et de continuer à les éditer ou supprimer. Les membres de l’organisation disposant des droits d’édition/suppression des liens de partage peuvent gérer les liens créés via l’API.
• La consommation de crédits générée par le lien de partage est imputée à l’organisation à laquelle appartient l’Agent.
• Si l’organisation a lié un domaine personnalisé, l’adresse du lien de partage renvoyée utilisera ce domaine personnalisé.
• Seuls les Agents sont pris en charge ; l’appel avec une clé API de Workflow renverra un type de Bot incorrect.
• Si le site actuel n’a pas activé le canal d’intégration « Partage », l’appel renverra une opération non supportée.

Méthode de requête

POST

URL d’appel

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

Authentification de l’appel

Pour plus de détails, consultez la section sur les méthodes d’authentification dans Aperçu de l’API. Veuillez utiliser la clé API de l’Agent cible comme token.

Requête

Exemple de requête

                      
                      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
}'

                    

Tous les paramètres sont facultatifs. Lorsque le corps de la requête transmet {}, un lien de partage permanent, sans mot de passe, pour un maximum de 10 utilisateurs, chaque utilisateur pouvant envoyer jusqu'à 9999 messages, et sans retour d'avis sera créé. Si vous souhaitez restreindre l'accès, veuillez transmettre explicitement valid_days et password.

Tous les noms de champs sont en snake_case. Lorsque des champs non reconnus apparaissent dans le corps de la requête (par exemple écrits en camelCase comme validDays), l'interface renverra 40000 et listera ces champs dans le message d'erreur, sans créer de lien.

En-têtes de la requête

Paramètres de la requête

Réponse

Exemple de réponse

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

                    

Réponse réussie

Réponse échouée

Codes d'erreur