UIP 会話型のやり取り、メッセージ、トランク、ユーザー設定

「uip conversational」での会話履歴とフィードバック (やり取り、メッセージ)、音声チャネル ルーティング (トランク)、およびプロファイル設定 (ユーザー設定) の構文とオプション。

uip conversationalツールの一部です。このページでは、次の 4 つのコマンド グループについて説明します。 やり取り と メッセージ では、会話の履歴を読み取って、やり取りを評価できます。 trunks は、音声対応の会話型エージェントが応答またはダイヤルする SIP 電話番号を管理します。 user-settings は、現在のユーザーの会話プロファイルを管理します。これらはいずれも会話を生み出したり、促進したりするものではありません。詳しくは、chat、agents、conversationsの親ページをご覧ください。

概念

• Exchange — 会話内で 1 回の要求/応答の往復 (ユーザー メッセージの受信、アシスタント メッセージ (コンテンツ パート、ツールの呼び出し、引用を含む) の送信。chat ( 親ページ) は Exchange をライブで推進します。このページの exchanges/messages 動詞は、後で読み戻します。
• メッセージ → コンテンツ パーツ — メッセージは、1 つ以上のコンテンツ パーツ (テキスト/マークダウン チャンク、ツール呼び出しレコード) のコンテナーです。messages get-content-part は 1 つの部分を直接取得します。直接ルックアップが失敗した場合、CLI は、あきらめる前に親メッセージのフェッチとその contentParts 配列の検索にフォールバックします。
• トランク — インスタンスの管理の [電話番号] で接続された SIP 電話番号です。発信が有効なトランクは、音声フローの [発信コールの作成(Create Outgoing Call)] アクティビティによってダイヤルされます。受信が有効なトランクは、 trunks assignを介して着信呼び出しを、パブリッシュ済みのフロー プロセス リリースにルーティングします。

概要

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 会話でのやり取り

会話のやり取りを取得してフィードバックを提供する

UIP 会話型やり取りのリスト

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。

オプション

長押し	値 (Value)	説明
--limit <number>	正の整数	ページあたりの交換数
--exchange-sort <order>	ascending|descending	交換の並べ替え順序。
--message-sort <order>	ascending|descending	各やり取り内のメッセージの並べ替え順序。
--cursor <token>	string	次のページのページネーション カーソルです。

例

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

データシェイプ(--output json)

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

UIP 会話型交換は を取得します。

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。
<exchange-id>	○	UUID を交換します。

オプション

長押し	値 (Value)	説明
--message-sort <order>	ascending|descending	返されるやり取りに含まれるメッセージの並べ替え順序です。

例

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

データシェイプ(--output json)

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

UIP 会話型交換のフィードバック

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。
<exchange-id>	○	UUID を交換します。

オプション

長押し	値 (Value)	Required	説明
--rating <rating>	positive|negative	○	フィードバックの評価。その他の値は、ネットワーク呼び出しの前にクライアント側で失敗します。
--comment <comment>	string	×	任意のフィードバック コメント。

例

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

データシェイプ(--output json)

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

UIP の会話メッセージ

会話メッセージとそのコンテンツ部分を取得します。

UIP 会話メッセージの取得

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。
<exchange-id>	○	UUID を交換します。
<message-id>	○	メッセージ: UUID。

例

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

データシェイプ(--output json)

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

uip 会話メッセージ get-content-part

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。
<exchange-id>	○	UUID を交換します。
<message-id>	○	メッセージ: UUID。
<content-part-id>	○	コンテンツ部分 UUID。

直接のコンテンツ・パート・ルックアップが失敗した場合、CLI は、親メッセージをフェッチし、その contentParts 配列で一致する id または contentPartId を検索して、エラーを報告することによって自動的に再試行します。

例

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

データシェイプ(--output json)

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

UIP 会話型トランク

会話型音声用に設定されているテナントの SIP トランク (電話番号) を調べてルーティングします。

UIP 会話トランクのリスト

オプション

長押し	値 (Value)	説明
--direction <direction>	inbound|outbound	このコール方向に対して有効なトランクのみ。すべてのトランクのリストは省略します。その他の値はクライアント側では失敗します。

例

uip conversational trunks list --direction inbound

データシェイプ(--output json)

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

UIP 会話型トランクの割り当て

トランクの受信呼び出しをパブリッシュ済みのフロー プロセス リリースにルーティングするか、 を使用してルーティングをクリア --clear。プロセスがデプロイ済みのフロー リリースである必要があり、そのフローは 着信呼び出し トリガーから開始されます。フローにそのようなトリガーが 1 つしかない場合、 --entry-point は省略でき、自動的に解決されます。複数ある場合は --entry-point が必要になり、コマンドは有効な ID のリストが表示されて失敗します。

引数

名前	Required	目的
<trunk>	○	E.164 形式のトランク ID (GUID) またはその電話番号 (例:[phone])。

オプション

長押し	値 (Value)	説明
--process-key <key>	GUID	デプロイされたフロー プロセスの Orchestrator リリース キー (uip or processes list には Keyと表示されます。--clearの場合を除き、必須です。
--folder-key <key>	GUID	リリースが存在する Orchestrator フォルダーのキーです。--clearの場合を除き、必須です。
--entry-point <id>	string	フロー パッケージ内の着信コール エントリ ポイント ID。フローに 1 つしかない場合は自動的に解決されます。それ以外の場合は必須です (およびリリースの実際のエントリ ポイントに対して検証されています)。
--clear	フラグ	トランクの受信プロセス ルーティングを削除します。--process-key/--folder-key/--entry-pointと相互に排他的です。これらを組み合わせると、クライアント側では失敗します。
-y, --yes	フラグ	すでに受信ルーティングがあるトランクの再ルーティングまたはクリアを確認します。その場合は必須です。CLI はプロンプトを送信しません。

検証順序: --clear と、プロセス/フォルダーのペアが最初にチェックされます。次に、トランクは実際に inboundEnabled する必要があります(送信専用トランクでのルーティング試行は失敗し、 trunks list --direction inboundを指しています)。次に、トランクに既にバインディングがある場合は、 -y が必要です。次に、リリースの実際の着信呼び出しエントリ ポイントがプラットフォームから一覧表示され、バインディングが書き込まれる前に --entry-point に対して検証 (または自動解決) されます (書き込みは all-or nothing です)。

例

# 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

データシェイプ(--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 は { processKey: null, folderKey: null, entryPoint: null }を書き込みます。

UIP 会話型 user-settings

現在のユーザーの会話プロファイル設定を管理します。

uip 会話型ユーザー設定 get

グローバル値以外のオプションはありません。

例

uip conversational user-settings get

データシェイプ(--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" }
}

UI 会話型ユーザー設定の更新

少なくとも 1 つのオプションが必要です。7 つすべてを省略すると、ネットワーク呼び出しの前にクライアント側で失敗します。

オプション

長押し	値 (Value)	説明
--name <name>	string	ユーザー名。
--email <email>	string	を割り当てられました。
--role <role>	string	ユーザー ロール。
--department <department>	string	部署。
--company <company>	string	会社。
--country <country>	string	国。
--timezone <timezone>	string	タイムゾーン。

例

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

データシェイプ(--output json)

getの回答と同じ形Code: "UserSettingsUpdated"。

関連

• uip conversational — chat、 agents、 conversations。

参照

• グローバル オプション
• 終了コード