Rufen Sie Konversationsvorlagen über die Perform & Engage 365 API ab

Die Perform & Engage 365 API ermöglicht Ihnen Folgendes:

• Rufen Sie eine Liste der Konversationsvorlagen ab.
• Rufen Sie die Details einer bestimmten Konversationsvorlage anhand ihrer ID ab.

Liste der Konversationsvorlagen abrufen

GET /api/v2/conversation_templates/

Mit dieser Anfrage können Sie anhand der Suchparameter eine Liste von Konversationsvorlagen abrufen.

Optionale Abfrageparameter

• Name (Zeichenkette). Der Name der Konversationsvorlage.
• name_icontains (Zeichenkette). Der Name der Konversationsvorlage ohne Berücksichtigung der Groß-/Kleinschreibung oder ein Teil davon.
• limit (Ganzzahl). Die maximale Anzahl an Konversationsvorlagen in der Antwort.
• offset (integer). Der Startindex, ab dem die Ergebnisse in der Antwort zurückgegeben werden.

Beispielanfrage

GET /api/v2/conversation_templates/?name=360%20Feedback

Parameter im Antworttext

Der Antworttext enthält:

• count (Ganzzahl). Die Anzahl der Ergebnisse.
• Weiter und Zurück (Zeichenketten). URLs zu den nächsten und vorherigen Seiten (falls Sie in der ursprünglichen Anfrage die Paginierung verwendet haben).
• results (Array). Die Liste der Konversationsvorlagen. Jede Konversationsvorlage hat diese Parameter:
  • api_id (string). Die ID der Konversationsvorlage. Sie können diese ID verwenden, um weitere Details zur Gesprächsvorlage abzurufen.
  • name (string). Der Name der Konversationsvorlage.
  • aktiv (boolean). Gibt an, ob die Konversationsvorlage aktiv (true) ist oder nicht (false).
  • draft (boolean). Gibt an, ob sich die Konversationsvorlage im Entwurfsstatus (true) befindet oder nicht (false).
  • gelöscht (boolean). Gibt an, ob die Konversationsvorlage gelöscht (true) ist oder nicht (false).
  • created_date (string). Erstellungsdatum und -uhrzeit der Konversationsvorlage.
  • updated_date (string). Datum und Uhrzeit der letzten Aktualisierung der Konversationsvorlage.

Beispiel für den Antwort-Body

Bei einer erfolgreichen 200-Antwort sieht der Body ähnlich aus:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "api_id": "580:58fe72fa-3553-4169-8e03-602568927908",
     "name": "360 Feedback",
     "active": false,
     "draft": true,
     "deleted": false,
     "created_date": "2025-04-04T12:19:58.162985+01:00",
     "updated_date": "2025-04-09T16:28:05.104675+01:00"
   }
 ]
}

Abrufen der Details einer bestimmten Konversationsvorlage anhand ihrer ID

GET api/v2/conversation_templates/{api_id}/

Nachdem Sie in der Antwort auf die previous request die Konversationsvorlagen-api_id erhalten haben, können Sie diese ID verwenden, um weitere Informationen zur Konversationsvorlage abzurufen.

Erforderlicher Pfadparameter

• api_id (string). Die ID der Gesprächsvorlage erhalten Sie, indem Sie die GET-Anfrage /api/v2/conversation_templates/ ausführen.

Beispielanfrage

GET /api/v2/conversation_templates/580%3A55a31458-d71a-4962-841a-048439073239/

Parameter des Response-Bodys

Der Response Body enthält:

• api_id (Zeichenkette). Die ID der Gesprächsvorlage.
• Name (Zeichenkette). Der Name der Gesprächsvorlage.
• aktiv (Boolesch). Gibt an, ob die Gesprächsvorlage aktiv (true) ist oder nicht (false).
• Entwurf (Boolesch). Gibt an, ob sich die Gesprächsvorlage im Entwurfsstatus befindet (true) oder nicht (false).
• gelöscht (Boolesch). Gibt an, ob die Gesprächsvorlage gelöscht (true) ist oder nicht (false).
• created_date (Zeichenkette). Datum und Uhrzeit der Erstellung der Gesprächsvorlage.
• updated_date (Zeichenkette). Datum und Uhrzeit der letzten Aktualisierung der Gesprächsvorlage.
• sections (Array). Die Liste der Abschnitte der Gesprächsvorlage. Jeder Abschnitt enthält seine api_id, seinen Titel, seine description, seine order sowie das elements-Array.

Beispiel für den Response-Body

Die erfolgreiche 200-Antwort gibt einen Body zurück, der in etwa so aussieht:

{
 "api_id": "580:55a31458-d71a-4962-841a-048439073239",
 "name": "Engagement-Umfrage",
 "active": false,
 "draft": true,
 "deleted": false,
 "created_date": "2021-05-26T12:28:59.961760+01:00",
 "updated_date": "2021-05-26T15:15:54.920102+01:00",
 "sections": [
   {
     "api_id": null,
     "title": "Engagement-Feedback",
     "description": "",
     "elements": [
       {
         "api_id": null,
         "title": "Bitte nehmen Sie sich ein paar Minuten Zeit, um diese Umfrage auszufüllen. 
         Ihre Antworten auf die folgenden Fragen und Aussagen sind wichtig,
         daher antworten Sie bitte ehrlich.",
         "element_type": "paragraph",
         "identifier": null,
         "initial_value": null,
         "range_low": null,
         "range_high": null,
         "increments": 1,
         "required": false,
         "order": 0,
         "allow_comment": false
       }
       ],
"order": 0
   }
 ]
}