UIP-Konversationsaustausch, Nachrichten, Instanzen, Benutzereinstellungen

Syntax und Optionen für Konversationsverlauf und Feedback (Austausch, Nachrichten), Sprachkanal-Routing (Trusts) und Profileinstellungen (User-Settings) unter „uip Conversational“.

Teil des Tools uip conversational . Diese Seite enthält vier Befehlsgruppen: Austausch und Nachrichten lesen den Verlauf einer Konversation und ermöglichen Ihnen, Austauschbewertungen zu bewerten; verwaltet die SIP-Telefonnummern, von denen ein spracheaktivierter Konversationsagent antwortet oder wählt; Benutzereinstellungen verwalten das Konversationsprofil des aktuellen Benutzers. Keines davon erstellt oder steuert eine Konversation – siehe die übergeordnete Seite für chat, agents und conversations.

Konzepte

• Exchange – eine Anforderungs-/Antwort-Round steuern innerhalb einer Konversation: eine Benutzernachricht in, eine Assistentennachricht (mit Inhaltsteilen, Toolaufrufen, Zitaten) aus. chat (auf der übergeordneten Seite) regelt den Austausch live; Die Verben exchanges/messages dieser Seite lesen sie anschließend zurück.
• Nachricht → Inhaltsteil – Eine Nachricht ist ein Container für einen oder mehrere Inhaltsteile (Text-/Markdown-Teile, Toolaufrufdatensätze). messages get-content-part ruft einen Teil direkt ab; Wenn die direkte Suche fehlschlägt, ruft die CLI wieder die übergeordnete Nachricht ab und durchsucht ihr contentParts -Array, bevor sie aufgibt.
• Taste – eine SIP-Telefonnummer, die in der Instanzverwaltung unter Telefonnummern verbunden ist. Für ausgehende Verbindungen werden durch die Funktion „Ausgehenden Anruf erstellen“ eines Sprachflusses gewählt Aktivität; eingehend aktivierte Instanzen leiten eingehende Aufrufe über trunks assign an ein veröffentlichtes Flow-Prozessrelease weiter.

Zusammenfassung

uip conversational exchanges list <conversation-id> [--limit <n>] [--exchange-sort <order>] [--message-sort <order>] [--cursor <token>]
uip conversational exchanges get <conversation-id> <exchange-id> [--message-sort <order>]
uip conversational exchanges feedback <conversation-id> <exchange-id> --rating positive|negative [--comment <text>]
uip conversational messages get <conversation-id> <exchange-id> <message-id>
uip conversational messages get-content-part <conversation-id> <exchange-id> <message-id> <content-part-id>
uip conversational trunks list [--direction inbound|outbound]
uip conversational trunks assign <trunk> [--process-key <key> --folder-key <key> [--entry-point <id>] | --clear] [-y]
uip conversational user-settings get
uip conversational user-settings update [--name <name>] [--email <email>] [--role <role>] [--department <department>] [--company <company>] [--country <country>] [--timezone <timezone>]

UIP-Konversationsaustausch

Abrufen und Feedback dazu geben.

Liste der UIP-Konversationsaustausche

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.

Optionen

Long	Wert	Beschreibung
--limit <number>	positiver Integer	Austausch pro Seite.
--exchange-sort <order>	ascending|descending	Sortierreihenfolge für Austausch.
--message-sort <order>	ascending|descending	Sortierreihenfolge für Nachrichten innerhalb jedes Austauschs.
--cursor <token>	string	Paginierungscursor für die nächste Seite.

Beispiel

uip conversational exchanges list b2c3d4e5-0000-0000-0000-000000000001 --limit 20

Datenform (--output json)

{
  "Result": "Success",
  "Code": "ExchangeList",
  "Data": {
    "items": [{ "id": "e1e2e3e4-0000-0000-0000-000000000001", "...": "raw exchange record" }],
    "nextCursor": null
  }
}

UIP-Konversationsaustausch

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.
<exchange-id>	ja	Exchange-UUID.

Optionen

Long	Wert	Beschreibung
--message-sort <order>	ascending|descending	Sortierreihenfolge für Nachrichten im zurückgegebenen Austausch.

Beispiel

uip conversational exchanges get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001

Datenform (--output json)

{ "Result": "Success", "Code": "Exchange", "Data": { "id": "e1e2e3e4-0000-0000-0000-000000000001", "messages": [] } }

UIP-Konversation austauscht Feedback

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.
<exchange-id>	ja	Exchange-UUID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--rating <rating>	positive|negative	ja	Feedback-Bewertung. Jeder andere Wert schlägt auf der Clientseite vor einem Netzwerkaufruf fehl.
--comment <comment>	string	nein	Optionaler Feedbackkommentar.

Beispiel

uip conversational exchanges feedback b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 --rating positive --comment "Resolved quickly"

Datenform (--output json)

{ "Result": "Success", "Code": "FeedbackCreated", "Data": { "rating": "positive", "comment": "Resolved quickly" } }

UIP-Konversationsnachrichten

Rufen Sie Konversationsnachrichten und deren Inhaltsteile ab.

Abrufen von UIP-Konversationsnachrichten

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.
<exchange-id>	ja	Exchange-UUID.
<message-id>	ja	Nachrichten-UUID.

Beispiel

uip conversational messages get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001

Datenform (--output json)

{ "Result": "Success", "Code": "Message", "Data": { "id": "f1f2f3f4-0000-0000-0000-000000000001", "contentParts": [] } }

„get-content-part“ für UIP-Konversationsnachrichten

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.
<exchange-id>	ja	Exchange-UUID.
<message-id>	ja	Nachrichten-UUID.
<content-part-id>	ja	UUID des Inhaltsteils.

Wenn die direkte Suche nach einem Inhaltsteil fehlschlägt, versucht die CLI automatisch einen erneuten Versuch, indem sie die übergeordnete Nachricht abruft und deren contentParts -Array nach einem übereinstimmenden id oder contentPartId durchsucht, bevor ein Fehler gemeldet wird.

Beispiel

uip conversational messages get-content-part b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001 a1a2a3a4-0000-0000-0000-000000000001

Datenform (--output json)

{ "Result": "Success", "Code": "ContentPart", "Data": { "id": "a1a2a3a4-0000-0000-0000-000000000001", "isText": true, "data": "..." } }

UIP-Konversationszeichenfolgen

Überprüfen und leiten Sie die SIP- führte (Telefonnummern) des Mandanten, die für Konversationssprache konfiguriert sind.

UIP-Konversationszeichenfolgenliste

Optionen

Long	Wert	Beschreibung
--direction <direction>	inbound|outbound	Nur Dienstverbindungen für diese Anrufrichtung aktiviert. Lassen Sie es weg, jeden Stamm aufzulisten. Jeder andere Wert schlägt auf der Clientseite fehl.

Beispiel

uip conversational trunks list --direction inbound

Datenform (--output json)

{
  "Result": "Success",
  "Code": "SipTrunkList",
  "Data": [
    { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "[phone]", "inboundEnabled": true, "outboundEnabled": false, "processKey": null }
  ]
}

Zuweisung von uip-Konversationsläufen

Leiten Sie die eingehenden Aufrufe eines Wählens an eine veröffentlichte Flow-Prozessversion weiter oder löschen Sie das Routing mit --clear. Der Prozess muss ein bereitgestelltes Flow-Release sein, dessen Flow mit einem Trigger für einen eingehenden Aufruf beginnt; Wenn der Flow genau einen solchen Trigger hat, kann --entry-point weggelassen werden und wird automatisch aufgelöst – wenn mehrere vorhanden sind, ist --entry-point erforderlich und der Befehl listet die gültigen IDs nicht auf.

Argumente

Name	Erforderlich	Zweck
<trunk>	ja	Stamm-ID (GUID) oder deren Telefonnummer im E.164-Formular (z. B [phone]).

Optionen

Long	Wert	Beschreibung
--process-key <key>	GUID	Orchestrator-Versionsschlüssel des bereitgestellten Flow-Prozesses (uip or processes list zeigt ihn als Key an). Erforderlich, außer --clear.
--folder-key <key>	GUID	Schlüssel des Orchestrator-Ordners, in dem sich das Release befindet. Erforderlich, außer --clear.
--entry-point <id>	string	ID des Einstiegspunkts für eingehende Anrufe innerhalb des Flow-Pakets. Wird automatisch aufgelöst, wenn der Flow genau einen hat; erforderlich (und anhand der echten Einstiegspunkte des Release validiert), andernfalls.
--clear	Markieren	Entfernen Sie das eingehende Prozess Routing des Stammes. Sich gegenseitig mit --process-key/--folder-key/--entry-point ausschließen – ihre Kombination schlägt auf Clientseite fehl.
-y, --yes	Markieren	Bestätigen Sie die Umleitung oder das Löschen eines Hauptteils, der bereits eingehendes Routing hat. In diesem Fall erforderlich – die CLI fordert Sie nie auf.

Validierungsreihenfolge: --clear vs. das Prozess-/Ordnerpaar wird zuerst geprüft; dann muss der Hauptteil tatsächlich inboundEnabled sein (ein Routing-Versuche für einen nur ausgehenden Hauptteil schlägt fehl und verweist auf trunks list --direction inbound); dann, wenn der Stamm bereits eine Bindung hat, ist -y erforderlich; dann werden die echten Incoming-Call-Einstiegspunkte des Release von der Plattform aufgelistet und gegen --entry-point validiert (oder automatisch aufgelöst), bevor die Bindung geschrieben wird – der Schreibvorgang ist alles oder nichts.

Beispiele

# Auto-resolve the entry point (release has exactly one Incoming call trigger)
uip conversational trunks assign [phone] --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --folder-key a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e

# Clear inbound routing on a bound trunk
uip conversational trunks assign [phone] --clear -y

Datenform (--output json)

{
  "Result": "Success",
  "Code": "SipTrunkAssign",
  "Data": { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "[phone]", "processKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09", "folderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e", "entryPoint": "..." }
}

--clear schreibt { processKey: null, folderKey: null, entryPoint: null }.

Benutzereinstellungen für UIP-Konversation

Verwalten Sie die Konversationsprofileinstellungen des aktuellen Benutzers.

Abrufen der UIP-Konversationsbenutzereinstellungen

Keine Optionen über globale Optionen hinaus.

Beispiel

uip conversational user-settings get

Datenform (--output json)

{
  "Result": "Success",
  "Code": "UserSettings",
  "Data": { "name": "Jane Doe", "email": "[e-mail]", "role": "Support Lead", "department": "Support", "company": "Acme", "country": "US", "timezone": "America/New_York" }
}

Aktualisierung der UIP-Konversationsbenutzereinstellungen

Mindestens eine Option ist erforderlich – das Auslassen aller sieben schlägt auf Clientseite vor einem Netzwerkaufruf fehl.

Optionen

Long	Wert	Beschreibung
--name <name>	string	Benutzername.
--email <email>	string	dieselbe E-Mail-Adresse erhält.
--role <role>	string	Benutzerrolle.
--department <department>	string	Abteilung.
--company <company>	string	Unternehmen.
--country <country>	string	Land.
--timezone <timezone>	string	Zeitzone.

Beispiel

uip conversational user-settings update --timezone "America/Los_Angeles"

Datenform (--output json)

Die gleiche Form wie die Antwort von get, Code: "UserSettingsUpdated".

Zugehörig

• uip conversational – chat, agents, conversations.

Siehe auch

• Globale Optionen
• Exitcodes