このドキュメントでは、チャット文字起こしのメタデータを構造化するために使用される JSON スキーマについて説明します。このスキーマは、チャットの会話を正確に表現して処理するために必要です。
チャットの文字起こしメタデータのスキーマ
このスキーマは、チャット文字起こしデータのデータ構造を記述します。コア コンポーネントについては、以降のセクションで説明します。
コアの文字起こし情報
次のプロパティは、文字起こし自体に関する基本的な情報を提供します。
comm_type（文字列）。この文字起こしが属するコミュニケーションのタイプ。SMS 機能が統合された通話の場合、チャットまたは通話になります。comm_id（整数）。この文字起こしに関連するコミュニケーション（チャットや通話など）の識別子。transcript_version（文字列）。文字起こし形式のバージョン。これは、文字起こしを解析する際の下位互換性のために必要です。assigned_at（文字列、日時）。チャットが割り当てられたときのタイムスタンプ。timezone（文字列）。チャットが行われたタイムゾーン。
メッセージ定義
definitions セクションには、トランスクリプト内のさまざまなメッセージ タイプの構造を定義する再利用可能なスキーマ コンポーネントが含まれています。これにより、さまざまなコンテンツ形式を柔軟に処理できます。
text（オブジェクト）: テキスト メッセージを表しますtype（文字列）: 「text」である必要がありますcontent（文字列）: メッセージの実際のテキスト コンテンツlang（文字列）: テキスト コンテンツの言語
text_template（オブジェクト）: テンプレート化されたテキスト メッセージを表しますtype（文字列）:text_templateである必要がありますcontent（文字列）: テキスト テンプレートのコンテンツ。プレースホルダを含めることができます。
markdown（オブジェクト）: Markdown 形式を使用してメッセージを表しますtype（文字列）:Markdownである必要がありますcontent（文字列）: Markdown テンプレートのコンテンツ
markdown_template（オブジェクト）: テンプレート化された Markdown メッセージを表しますtype（文字列）:markdown_templateでなければなりません。content（文字列）: マークダウン テンプレートのコンテンツ（プレースホルダを含む場合もあります）
photo（オブジェクト）: 写真を含むメッセージを表しますtype（文字列）:photoである必要がありますmedia_id（整数）: 写真のメディア ファイルの ID
video（オブジェクト）: 動画を含むメッセージを表しますtitle（文字列）: 動画のタイトルvideo（オブジェクト）: 動画の詳細url（文字列）: 動画の URLtext（文字列）: 動画 URL のテキスト代替
media_id（整数）: 動画 URL が直接指定されていない場合に取得するメディア ID
image（オブジェクト）: 画像を含むメッセージを表します。title（文字列）: 画像のタイトルimage（オブジェクト）: 画像の詳細url（文字列）: 画像の URLtext（文字列）: 画像 URL の代替テキスト
document（オブジェクト）: ドキュメントを含むメッセージを表しますtitle（文字列）: ドキュメントのタイトルdocument（オブジェクト）: ドキュメントの詳細url（文字列）: ドキュメントの URL。text（文字列）: ドキュメント URL の代替テキスト
inline_button（オブジェクト）: インライン ボタンのセットを表しますtitle（文字列）: インライン ボタン セットのタイトルbuttons（配列）: ボタン オブジェクトの配列title（文字列）: ボタンのタイトルaction（文字列）: ボタンで示されるアクションの名前link（文字列）: クイック返信リンク アクションの URL リンク
sticky_button（オブジェクト）: 固定ボタンのセットを表しますtitle（文字列）: 固定ボタン セットのタイトルbuttons（配列）: ボタン オブジェクトの配列title（文字列）: ボタンのタイトルaction（文字列）: ボタンで示されるアクションの名前link（文字列）: クイック返信リンク アクションの URL リンク
content_card（オブジェクト）: コンテンツ カードを表しますcards（配列）: コンテンツ カード オブジェクトの配列title（文字列）: コンテンツ カードのタイトルbody（文字列）: コンテンツ カードの本文
server_message（オブジェクト）: サーバーから取得されたメッセージを表します。message_id（整数）: 保存されたサーバー メッセージの IDcontent（文字列）: サーバーから取得したメッセージの内容
action（オブジェクト）: チャット中に行われたアクションを表します。次のいずれかになります。action_escalation（オブジェクト）: エスカレーション アクションを表しますaction（文字列）: 「escalation」である必要がありますescalation_reason（文字列）: エスカレーションの理由。menu_id（整数）: コミュニケーションをエスカレーションする IDlanguage（文字列）: エスカレーション先のキューの ISO 689 言語コード
action_deflection（オブジェクト）: 転送アクションを表しますaction（文字列）:deflectionである必要がありますdeflection_type（文字列）: 偏向のタイプsip_parameters（オブジェクトまたは null）: 転送の一部として転送する SIP パラメータ（存在する場合）
action_end（オブジェクト）: 終了アクションを表しますaction（文字列）:endである必要があります
noti（オブジェクト）: 通知メッセージを表します。さまざまな通知タイプがあります。noti_transfer_started（オブジェクト）: 転送開始の通知。type（文字列）:notiである必要がありますevent（文字列）: 「transferStarted」である必要がありますtarget（文字列）: 転送の宛先（メニューやエージェントなど）。agent（オブジェクト）: 転送を開始したエージェントid（整数）: エージェントの IDemail（文字列）: エージェントのメールアドレスname（文字列）: エージェントの名前
noti_verification_requested（オブジェクト）: 確認リクエストの通知type（文字列）:notiである必要がありますevent（文字列）:verificationRequestedである必要がありますagent（オブジェクト）: 確認をリクエストしているエージェントid（整数）: 確認をリクエストしているエージェントの IDemail（文字列）: 確認をリクエストしているエージェントのメールアドレスname（文字列）: 検証をリクエストするエージェントの名前
noti_end_user_verified（オブジェクト）: エンドユーザーが確認されたときの通知type（文字列）:notiである必要がありますevent（文字列）:endUserVerifiedである必要があります
他の
noti_\*タイプは、写真リクエスト、動画リクエスト、コブラウジング イベント、タスク仮想エージェント イベント、エージェントの参加、転送またはエスカレーションのステータスの変更など、さまざまなイベントの通知を定義します。noti_custom（オブジェクト）: カスタム通知を表します。type（文字列）:notiである必要がありますevent（文字列）:customである必要がありますdetail（オブジェクト）: カスタム イベントの詳細key（文字列）: カスタム イベントの詳細を表すキーdata（オブジェクト）: カスタム定義のイベント ペイロード
文字起こしエントリ
entries（配列）: オブジェクトの配列。各オブジェクトは、チャットで送信された個々のメッセージを表します。timestamp（文字列）: メッセージ送信時のタイムスタンプtype（文字列）: メッセージのタイプ。前に説明した定義のいずれかを参照します（text、photo、notiなど）。body（オブジェクト）: メッセージのタイプで定義された構造に準拠したメッセージのコンテンツ。oneOfを使用して、さまざまなボディタイプに対応しています。role（文字列）: メッセージを送信した参加者のロール。有効な値は、end_user、agent、manager、virtual_agent、external_agent、task_virtual_agent、systemです。user_data（オブジェクト）: エンドユーザーまたはシステム メッセージでない限り、メッセージを送信したユーザーのデータ。name（文字列）: ユーザーの名前id（整数）: ユーザーの一意の ID
avatar_url（文字列）: ユーザーのアバターのストレージ URL