Ferndesk

Créer un playbook

Ajoute un playbook : une situation que votre équipe gère d’une manière définie, ainsi que les étapes que l’agent IA suit dans ce contexte. Un nouveau playbook est désactivé, sauf si enabled vaut true.

POST /v1/playbooks
Jeton Bearer portée settings:write

Corps

requis application/json
id string

Identifiant du playbook (pb_...). Omettez-le pour en ajouter un. Un identifiant qui n’existe pas encore dans cet espace de travail permet d’ajouter le playbook avec cet identifiant ; une nouvelle tentative n’en crée donc jamais deux.

name string · min length: 1· max length: 120

Nécessaire pour ajouter un playbook.

when string · max length: 300

La situation qu’il couvre, en termes simples.

steps array of string · max items: 20

Ce que fait l’agent, dans l’ordre. Conservez les jetons de mention tels que @[custom.plan-lookup].

enabled boolean

Seuls les playbooks activés sont accessibles à l’agent. Un nouveau playbook est désactivé, sauf si cette valeur est vraie.

conditions any

Ce à quoi une conversation doit satisfaire pour être visible par l’agent : { all: [...] } de { field, op, values, not? }. Champs : channel (email, chat, slack ; chat correspond au widget et au centre d’aide), priority, tag (identifiants des libellés), property ({ field: "property", key, op, values }, propriétés du client, clients vérifiés uniquement), customerGroup (identifiants des groupes de clients). Les conditions portant sur un même champ élargissent le résultat ; celles portant sur des champs différents le restreignent ; not masque le résultat. Null l’applique à toutes les conversations ; si la valeur est omise, le réglage existant est conservé.

Réponses