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

Mit der Perform & Engage 365 API können Sie:

• Eine Liste der Konversationstarife abrufen.
• Rufen Sie die Details eines bestimmten Konversationstarifs anhand seiner ID ab.

Liste der Konversationstarife abrufen

GET /api/v2/conversation_plans/

Mit dieser Anfrage können Sie basierend auf den Suchparametern eine Liste der Konversationstarife abrufen.

Optionale Abfrageparameter

• name (string). Der Name des Konversationstarifs.
• Vorlage_name (string). Der Name der Konversationsvorlage.
• limit (integer). Die maximale Anzahl an Konversationstarifen in der Antwort.
• offset (integer). Der Startindex, ab dem die Ergebnisse in der Antwort zurückgegeben werden.

Beispielanfrage

GET /api/v2/conversation_plans/?name=Engagement%20survey&
template_name=Engagement%20Survey

Parameter im Antworttext

Der Antworttext umfasst:

• count (integer). Die Anzahl der Ergebnisse.
• next und previous (strings). URLs zu den nächsten und vorherigen Seiten (wenn Sie in der ursprünglichen Anfrage Paginierung verwendet haben).
• results (array). Die Liste der Gesprächstarife. Jeder Gesprächst arif hat folgende Parameter:
  • Name (string). Der Name des Gesprächst arifs.
  • api_id (string). Die ID des Gesprächst arifs. Sie können diese ID verwenden, um weitere Details zum Gesprächst arif abzurufen.
  • Vorlagenname (Zeichenfolge). Der Name der Gesprächsvorlage.
  • template_api_id (Zeichenfolge). Die ID der Gesprächsvorlage. Sie können diese ID verwenden, um weitere Details zur Gesprächsvorlage abzurufen.
  • Status (string). Der Status des Gesprächst arifs. Die möglichen Status sind draft und aktiv.
  • frequency (string). Wenn der Gesprächst arif wiederkehrend ist, zeigt die Häufigkeit, wie oft der Gesprächst arif stattfindet.

Beispiel für den Response-Body

Die erfolgreiche 200-Antwort enthält einen Body, der etwa so aussieht:

{
 "count": 1,
 "next": null,
 "previous": null,
 "results": [
   {
     "name": "Engagement-Umfrage",
     "api_id": "580:58f96337-f9c3-4ea0-88ed-7ad612670078",
     "template_name": "Engagement-Umfrage",
     "template_api_id": "580:55a31458-d71a-4962-841a-048439073239",
     "status": "Entwurf",
     "frequency": "Alle 4 Wochen"
   }
 ]
}

Rufen Sie die Details eines bestimmten Gesprächst arifs anhand seiner ID ab

GET api/v2/conversation_plans/{api_id}/

Nachdem Sie die api_id des Gesprächst arifs in der Antwort auf die vorherige Anfrage erhalten haben, können Sie diese ID verwenden, um weitere Informationen zum Gesprächst arif abzurufen.

Erforderlicher Pfadparameter

• api_id (string). Die ID des Gesprächsttarifs können Sie erhalten, indem Sie die GET-Anfrage /api/v2/conversation_plans/ senden.

Beispielanfrage

GET /api/v2/conversation_plans/580%3A58f96337-f9c3-4ea0-88ed-7ad612670078/

Parameter des Antwort-Body

Der Antworttext enthält:

• name (string). Der Name des Gesprächstarifs.
• api_id (string). Die ID des Gesprächstarifs.
• Vorlage_name (string). Der Name der Gesprächsvorlage.
• Vorlage_api_id (string). Die ID der Gesprächsvorlage. Sie können diese ID verwenden, um weitere Details zur Gesprächsvorlage abzurufen.
• Status (string). Der Status des Gesprächstarifs. Die möglichen Status sind draft und active.
• frequency (string). Wenn der Gesprächstarif wiederkehrend ist, zeigt die Frequenz an, wie oft der Gesprächstarif stattfindet.
• assigned_users (array). Die Liste der Benutzer, die dem Gesprächstarif zugewiesen sind. Jeder Benutzer hat diese Parameter:
  • api_id (string). Die ID des Benutzers.
  • Name (string). Der vollständige Name des Benutzers.
  • E-Mail (String). Die E-Mail-Adresse des Benutzers.
• assigned_departments (String). Die Liste der Abteilungen, die dem Konversationsplan zugewiesen sind. Jede Abteilung hat diese Parameter:
  • api_id (String). Die Abteilungs-ID.
  • Name (String). Der Name der Abteilung.

Beispiel für den Antworttextkörper

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

{
 "name": "Engagement survey",
 "api_id": "580:58f96337-f9c3-4ea0-88ed-7ad612670078",
 "template_name": "Engagement Survey",
 "template_api_id": "580:55a31458-d71a-4962-841a-048439073239",
 "status": "draft",
 "frequency": null,
 "assigned_users": [
   {
     "api_id": "582:8a1fc17e-d1f5-4d6b-924e-dea3912814e3",
     "name": "Joanne Stefani",
     "email": "jstefani@test.com"
   }
],
 "assigned_departments": [ 
  { 
     "api_id": "442:8a1fc17e-d1f5-4d6b-924e-dea3912814e3",
     "name": "Senior Developers" 
  } 
]
}