Voice Interaction Resource API

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む34読むのに数分

    • 音声対話 API を使用すると、電話での会話中にエージェントと発信者の間の音声対話を書き起こして保存できます。チャットと連携 仮想エージェント して ライブエージェント 機能します。

    この API を使用して、進行中の電話からの文字起こしされたメッセージをリアルタイムで保持したり、履歴目的で既存の音声会話録音を書き起こして保存したりできます。文字起こしされたメッセージは エージェントワークスペースに表示され、エージェントは発信者と話しながらエージェント支援や検索などの機能を活用できます。文字起こしされたメッセージは、会話メッセージ [sys_cs_message] テーブルに保持されます。

    Agent Workspace で文字起こしされたメッセージ

    コールフロー

    次の通話フローは、 音声インタラクション API を使用して音声インタラクションレコードを作成し、その音声会話内のメッセージを文字起こしして保存してから、音声会話レコードを閉じる方法を示しています。ビジネスルールやその他のスクリプトを使用してこの機能を実行することもできますが、このタイプの実装についてはこのセクションでは説明しません。
    1. まず、エンドポイントを呼び出して 音声インタラクションリソース - POST /cs/voice-interactions 、インタラクション [interaction] テーブルに音声インタラクションレコードを作成します。
    2. 次に、エンドポイントを呼び出して、音声インタラクションリソース - POST /cs/voice-interactions/{interactionId}/messages音声会話から翻訳されたメッセージを会話メッセージテーブルに保存します。リアルタイム会話を処理している場合は、メッセージが エージェントワークスペース タイムリーに表示されるように、このエンドポイントを頻繁に呼び出す必要があります。履歴目的で記録を処理する場合は、1 回のエンドポイント呼び出しですべてのメッセージを渡すことができます。
    3. ボイス メッセージの永続化が完了したら、エンドポイントを呼び出して 音声インタラクションリソース - PATCH /cs/voice-interactions/{interactionId}/state キャプチャを終了し、音声対話レコードを閉じます。

    可用性

    この API はベース ServiceNow システムで利用できます。アクセスは、インタラクション [interaction] テーブルと会話 [sys_cs_conversation] テーブルに適用される ACL によって制限されます。

    音声インタラクションリソース - PATCH /cs/voice-interactions/{interactionId}/state

    指定された音声対話を終了します。一度呼び出されると、電話での会話用に追加のボイス メッセージが変換および保存されることはありません。

    URL 形式

    バージョニングされた URL:/ api/now/{api_version}/cs/voice-interactions/{interactionId}/state

    デフォルトの URL:/ api/now/v1/cs/voice-interactions/{interactionId}/state

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    interactionId 音声インタラクションを終了するインタラクションレコードのSys_id。インタラクション [interaction] テーブルにあり、 音声インタラクションリソース - POST /cs/voice-interactions エンドポイントによって返されます。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    recordingURL 元の音声録音が保存されている URL。

    そのように構成されている場合、この URL は エージェントワークスペースに表示されます。

    データタイプ：文字列

    デフォルト：なし
    ステータス 必須です。音声インタラクションのステータス。

    サポートされている値のみ:closed_complete

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不正な形式の JSON または必要なパラメーターが渡されませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    結果 操作のステータス。
    可能な値：
    • 成功
    • 失敗

    エラーが発生した場合は、エラーを説明するメッセージも戻されます。エラーがインスタンスにある場合 ServiceNow 、インスタンスは関連するスタックトレースをログに記録します。

    cURL 要求

    次の例は、音声インスタンスを終了する方法を示しています。

    curl "http://instance.servicenow.com/api/now/v1/ cs/voice-interactions/86837a386f0331003b3c498f5d3ee4ca/state" \ 
--request PATCH \
--header "Content-Type: application/json" \
--header "Accept:application/json" \
--user 'username':'password' \
-d {
  "state": "closed_complete",
  "recordingURL": "https: //zoom_instance/rec/QbF7XmPFHPlX1LG"
}’

    応答：

    {
  "result": "Success"
}

    音声インタラクションリソース - POST /cs/voice-interactions

    インタラクション [interaction] テーブル内に音声インタラクションレコードを作成します。

    文字起こしされた音声メッセージを保存する前に、このレコードを作成する必要があります。このエンドポイントを使用して、特定のユーザー ID を渡すことによって、特定のエージェントにコールを割り当てることもできます。

    URL 形式

    バージョニングされた URL:/ api/now/{api_version}/cs/voice-interactions

    デフォルトの URL:/ api/now/v1/cs/voice-interactions

    サポートされている要求パラメーター

    表 : 7. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    agentId 音声インタラクションをアサインするエージェントの一意の識別子。ユーザー [sys_user] テーブルのユーザー ID フィールドにあります。

    データタイプ：文字列

    デフォルト:仮想エージェントの呼び出し
    callerPhoneNumber 発信者のコールバック電話番号。これは、コールが切断された場合にエージェントが発信者に連絡するために使用する番号です。

    データタイプ：文字列

    フォーマット:E.164 規格準拠

    デフォルト：なし
    clientSessionId この電話を追跡するために使用される外部システム内のレコードの一意の識別子。この情報は、2 つのシステム間でレコードをリンクします。

    データタイプ：文字列

    デフォルト：なし
    inboundId 音声サービスのアプリケーションプロバイダーの一意の識別子。プロバイダーチャネルアプリケーション [sys_cs_provider_application] テーブルの受信 ID フィールドにあります。

    データタイプ：文字列

    デフォルト:チャットからプル
    userId 必須です。音声トランザクションに関連付けられたコールを発信した発信者の電話番号。

    データタイプ：文字列

    形式:音声会話スクリプトを作成したソフトウェアによって定義されます。通常、E.164 標準に準拠しています。

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不正な形式の JSON または必要なパラメーターが渡されませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    interactionId 新しく作成された音声インタラクションレコードのSys_id。インタラクション [interaction] テーブルにあります。
    このsys_idは次の場合に使用します。

    データタイプ：文字列

    cURL 要求

    次のコード例は、音声対話を開始し、特定のエージェントにコールを転送する方法を示しています。

    curl "http://instance.servicenow.com/api/now/v1/cs/voice-interactions" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password' \ 
--header "Content-Type: application/json"\ 
-d '{ 
  "userId": "+14089178877",
  "agentId": "beth.anglin",
  "callerPhoneNumber": "+14089178878",
  "clientSessionId": "f8453abb-a33d-45b7-bf01-52b7a821e99z"
}'

    応答：

    {
  "result": {
    "interactionId": "4462cb4753751110b6e8ddeeff7b12ca"
  }
}

    音声インタラクションリソース - POST /cs/voice-interactions/{interactionId}/conversation

    指定されたインタラクションの会話 [sys_cs_conversation] テーブル内に会話レコードを作成します。

    URL 形式

    バージョニングされた URL:/ api/now/{api_version}/cs/voice-interactions/{interactionId}/conversation

    デフォルトの URL:/ api/now/v1/cs/voice-interactions/{interactionId}/conversation

    サポートされている要求パラメーター

    表 : 13. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    interactionId 会話レコードを作成するインタラクションレコードSys_id。この値はエンドポイントによって返され、 音声インタラクションリソース - POST /cs/voice-interactions インタラクション [interaction] テーブルに保存されます。

    データタイプ：文字列
    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    agentId 音声インタラクションをアサインするエージェントの一意の識別子。ユーザー [sys_user] テーブルのユーザー ID フィールドにあります。

    データタイプ：文字列

    デフォルト:仮想エージェントの呼び出し
    callerPhoneNumber 発信者のコールバック電話番号。これは、コールが切断された場合にエージェントが発信者に連絡するために使用する番号です。

    データタイプ：文字列

    フォーマット:E.164 規格準拠

    デフォルト：なし
    clientSessionId この電話を追跡するために使用される外部システム内のレコードの一意の識別子。この情報は、2 つのシステム間でレコードをリンクします。

    データタイプ：文字列

    デフォルト：なし
    inboundId 音声サービスのアプリケーションプロバイダーの一意の識別子。プロバイダーチャネルアプリケーション [sys_cs_provider_application] テーブルの受信 ID フィールドにあります。

    データタイプ：文字列

    デフォルト:チャットからプル
    userId 必須です。音声トランザクションに関連付けられたコールを発信した発信者の電話番号。

    データタイプ：文字列

    形式:音声会話スクリプトを作成したソフトウェアによって定義されます。通常、E.164 標準に準拠しています。

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不正な形式の JSON または必要なパラメーターが渡されませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    conversationId 新しく作成された会話レコードのSys_id。会話 [sys_cs_conversation] テーブルにあります。

    cURL 要求

    次のコード例は、このエンドポイントを呼び出す方法を示しています。

    curl "http://instance.servicenow.com/api/now/v1/cs/voice-interactions/7662cb4721751ea0b6e8dda1b27b131f/conversation" \  
--request POST \  
--header "Accept:application/json" \  
--user 'username':'password' \  
--header "Content-Type: application/json"\  
-d '{  
  "userId": "+14089178877", 
  "agentId": "admin@example.com", 
  "callerPhoneNumber": "+14089178878", 
  "clientSessionId": "f8453abb-a33d-45b7-bf01-52b7a821e99z" 
}'

    応答：

    { 
  "result": "a47e1afdb7471110b6e8bc15ae11a934" 
}

    音声インタラクションリソース - POST /cs/voice-interactions/{interactionId}/messages

    指定された音声会話メッセージを指定された音声トランザクションレコードに追加します。通常、これらのメッセージはサードパーティベンダーのソフトウェアを使用して生成されます。現在、Amazon Connect のみがサポートされています。

    このエンドポイントは、呼び出しのリアルタイム文字起こし中に複数回呼び出すことも、履歴目的で呼び出しを文字起こしする場合は 1 回の呼び出しですべてのメッセージを渡すこともできます。リアルタイム会話を処理している場合は、メッセージが エージェントワークスペース タイムリーに表示されるように、このエンドポイントを頻繁に呼び出す必要があります。メッセージは、通話の開始に関連する開始時刻と終了時刻に基づいて順序付けされます。

    URL 形式

    バージョニングされた URL:/ api/now/{api_version}/cs/voice-interactions/{interactionId}/messages

    デフォルトの URL:/ api/now/v1/cs/voice-interactions/{interactionId}/messages

    サポートされている要求パラメーター

    表 : 19. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    interactionId 指定されたメッセージを追加するインタラクションレコードのSys_id。この値はエンドポイントによって返され、 音声インタラクションリソース - POST /cs/voice-interactions インタラクション [interaction] テーブルに保存されます。

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (Amazon Connect)
    名前 説明
    <json_string>
    指定した音声インタラクションに添付するメッセージのリスト。
    "<json_string>":[
  {
    "attributes": [Array],
    "beginOffsetMillis": Long,
    "content": "String"
    "endOffsetMillis": Long,
    "id": "String",
    "isEvent": Boolean,
    "isInternalMessage": Boolean,
    "loudnessScore": "Number",
    "participantId": "String",
    "sentiment": "String"
  }
]
    &lt;json_string>.attributes
    音声インタラクションに関連付けるキーと値のペア。

    これらは、単純なオブジェクトから複雑な複合オブジェクトまで、任意のタイプのデータオブジェクトにすることができます。これらは、Amazon Web サービス API を呼び出すときに一意の識別子として使用されます。

    データタイプ：オブジェクトのアレイ

    デフォルト：なし
    &lt;json_string>.beginOffsetMillis 必須です。音声インタラクションの開始と関連メッセージの開始の間の時間オフセット。例:&quot;beginOffsetMillis&quot;: 2650

    データタイプ：長整数

    単位：ミリ秒
    &lt;json_string>.content 必須です。音声インタラクションに追加するメッセージのテキスト。

    データタイプ：文字列
    &lt;json_string>.endOffsetMillis 必須です。音声対話の開始とメッセージの終了の間の時間オフセット。例:&quot;endOffsetMillis&quot;: 9380

    データタイプ：長整数

    単位：ミリ秒
    &lt;json_string>.id この音声会話のソースのメッセージ UUID (AmazonConnect など)。[ソースメッセージ ID] 列の値を設定します。

    データタイプ：文字列

    デフォルト：なし
    &lt;json_string>.isEvent
    Amazon Connect によって設定されますが、現在メソッドで使用されていません。関連付けられたメッセージがイベントかどうかを示すフラグ。
    有効な値：
    • true:メッセージはイベントです。
    • false:メッセージはイベントではありません。

    データタイプ：ブーリアン

    デフォルト：false
    &lt;json_string>.isInternalMessage
    これが内部メッセージであり、呼び出し元に表示しないかどうかを示すフラグ。

    通常、文字起こしは内部メッセージと見なされ、エージェントにのみ表示され、発信者には表示されません。さらに、エージェントウィスパーは、サイレントなサードパーティが発信者に知られずにチャットしている場合や電話での会話を開始し、エージェントにアドバイスを提供する場合に使用されます。発信者にはこれらのメッセージが聞こえたり見たりしませんが、エージェントには聞こえます。

    有効な値：
    • true:内部メッセージ。発信者に表示されません。
    • false:内部メッセージではなく、発信者に表示します。

    データタイプ：ブーリアン

    デフォルト：false
    &lt;json_string>.loudnessScore
    通話中に顧客またはエージェントが話している大きさの測定。

    Contact Lens は、会話の分析を表示し、大声で話していて否定的な感情を持っている可能性がある場所を示します。

    データタイプ：数値

    範囲: -1.0 (負) から 1.0 (正)

    デフォルト：Null
    &lt;json_string>.participantId
    必須です。メッセージに関連付けられた参加者。
    有効な値：
    • 顧客
    • エージェント

    データタイプ：文字列
    &lt;json_string>.sentiment
    メッセージの感情。

    この値は、サードパーティプロバイダーによって生成されます。インスタンス構成設定に基づいて ServiceNow 、この値は正、負、またはどちらでもないのいずれかに変換され、会話およびインタラクションレコードに保存されます。

    有効な値：
    • 負
    • 中立
    • 正

    データタイプ：文字列

    デフォルト：Null

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不正な形式の JSON または必要なパラメーターが渡されませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    結果 コールの結果を説明するメッセージ。

    データタイプ：文字列
    会話 ID 作成された音声対話メッセージレコードのSys_id。音声トランスクリプト会話メッセージ [sys_cs_message_voice_transcript] テーブルにあります。

    データタイプ：文字列

    cURL 要求

    次の例は、既存の音声インタラクションレコードにメッセージを追加する方法を示しています。

    curl "http://instance.servicenow.com/api/now/v1/cs/voice-interactions/86837a386f0331003b3c498f5d3ee4ca/messages" \ 
--request POST \
--header "Accept:application/json" \
--header "Content-Type: application/json"\ 
--user 'username':'password' \
-d ' [ 
  { 
    "isEvent": "false",  
    "isInternalMessage": "false",  
    "beginOffsetMillis": 10000,  
    "content": "This is John. How can I help you?",  
    "endOffsetMillis": 15000,  
    "id": "954c4edc-31a8-48b0-8f6e-7fa0c4ca00a8",  
    "participantId": "AGENT",  
    "sentiment": "NEUTRAL",  
    "loudnessScore": "null",  
    "attributes": [{  
      "key": "key1",  
      "value": "value1"  
      }, {  
      "key": "key2",  
      "value": "value2"  
    }] 
  },  
  {  
    "isEvent": "false",  
    "isInternalMessage": "false",  
    "beginOffsetMillis": 20000,  
    "content": "Uh, yes, John. Um, I'm a little very frustrated right now.",  
    "endOffsetMillis": 25000,  
    "id": "18bcf19c-4a9b-4af1-9bd7-7bfb5ba53b9f",  
    "participantId": "CUSTOMER",  
    "sentiment": "NEGATIVE"  
  },  
  {  
    "isEvent": "false",  
    "isInternalMessage": "false",  
    "beginOffsetMillis": 30000,  
    "content": "I am sorry to hear that",  
    "endOffsetMillis": 35000,  
    "id": "18bcf19c-4a9b-4af1-9bd7-7bfb5ba53b9f",  
    "participantId": "AGENT",  
    "sentiment": "NEGATIVE",  
 
  },  
  {  
    "isEvent":"false",
    "isInternalMessage":"false",
    "beginOffsetMillis":40000,
    "content":"Can you help me with my insurance? My ssn is 123-12-1234",
    "endOffsetMillis":45000,
    "id":"ab09b3b6-23fd-4e41-be05-6b2b53c19059",
    "participantId":"CUSTOMER",
    "sentiment":"NEUTRAL" 
  },  
  {  
    "isEvent":"False",
    "isInternalMessage":"False",
    "beginOffsetMillis":50000, 
    "content":"Of course, let me check your account",
    "endOffsetMillis":55000,
    "id":"18bcf19c-4a9b-4af1-9bd7-7bfb5ba53b9f",
    "participantId":"AGENT",
    "sentiment":"NEUTRAL" 
  }  
]'

    応答：

    { 
  "result": "Voice conversation transcript has been successfully saved. Conversation id: 8439d3c753b51110b6e8ddeeff7b12e2" 
}

    音声インタラクションリソース - POST /cs/voice-interactions/transcript

    通話が完了した後、既存の音声対話にメッセージを追加します。この API を使用して、エージェントと発信者間の音声通話の文字起こし済みメッセージを添付できます。

    URL 形式

    バージョニングされた URL:/ api/now/{api_version}/cs/voice-interactions/{interactionId}/transcript

    デフォルトの URL:/ api/now/v1/cs/voice-interactions/{interactionId}/transcript

    サポートされている要求パラメーター

    表 : 25. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    なし
    表 : 27. 要求本文パラメーター (XML または JSON)
    名前 説明
    会話開始済み 会話の開始時間インタラクション [interaction] テーブルにあります。

    データタイプ：文字列

    形式：YYYY-MM-DD HH:MM:SS
    interactionId 指定されたメッセージを追加するインタラクションレコードのSys_id。この値はエンドポイントによって返され、 音声インタラクションリソース - POST /cs/voice-interactions インタラクション [interaction] テーブルに保存されます。

    データタイプ：文字列
    source 会話インタラクションの転写を最初に作成したチャネルの名前。

    現在サポートされている値は Amazon Connect のみです。

    データタイプ：文字列
    トラン スクリプト 指定した音声インタラクションに添付するメッセージのリスト。
    "transcript":[
  {
    "attributes": [Array],
    "beginOffsetMillis": Long,
    "content": "String"
    "endOffsetMillis": Long,
    "id": "String",
    "isEvent": Boolean,
    "isInternalMessage": Boolean,
    "loudnessScore": "String",
    "participantId": "String",
    "sentiment": "String"
  }
]

    データタイプ：オブジェクトのアレイ
    transcript.attributes
    音声インタラクションに関連付けるキーと値のペア。

    これらは、単純なオブジェクトから複雑な複合オブジェクトまで、任意のタイプのデータオブジェクトにすることができます。これらは、Amazon Web サービス API を呼び出すときに一意の識別子として使用されます。

    データタイプ：オブジェクトのアレイ

    デフォルト：なし
    transcript.beginOffsetMillis 必須です。音声インタラクションの開始と関連メッセージの開始の間の時間オフセット。例:&quot;beginOffsetMillis&quot;: 2650

    データタイプ：長整数

    単位：ミリ秒
    transcript.content 必須です。音声インタラクションに追加するメッセージのテキスト。

    データタイプ：文字列
    transcript.endOffsetMillis 必須です。音声対話の開始とメッセージの終了の間の時間オフセット。例:&quot;endOffsetMillis&quot;: 9380

    データタイプ：長整数

    単位：ミリ秒
    transcript.id この音声会話のソースのメッセージ UUID (AmazonConnect など)。[ソースメッセージ ID] 列の値を設定します。

    データタイプ：文字列

    デフォルト：なし
    transcript.isEvent
    Amazon Connect によって設定されますが、現在メソッドで使用されていません。関連付けられたメッセージがイベントかどうかを示すフラグ。
    有効な値：
    • true:メッセージはイベントです。
    • false:メッセージはイベントではありません。

    データタイプ：ブーリアン

    デフォルト：false
    transcript.isInternalMessage
    これが内部メッセージであり、呼び出し元に表示しないかどうかを示すフラグ。

    通常、文字起こしは内部メッセージと見なされ、エージェントにのみ表示され、発信者には表示されません。さらに、エージェントウィスパーは、サイレントなサードパーティが発信者に知られずにチャットしている場合や電話での会話を開始し、エージェントにアドバイスを提供する場合に使用されます。発信者にはこれらのメッセージが聞こえたり見たりしませんが、エージェントには聞こえます。

    有効な値：
    • true:内部メッセージ。発信者に表示されません。
    • false:内部メッセージではなく、発信者に表示します。

    データタイプ：ブーリアン

    デフォルト：false
    transcript.loudnessScore
    通話中に顧客またはエージェントが話している大きさの測定。

    Contact Lens は、会話の分析を表示し、大声で話していて否定的な感情を持っている可能性がある場所を示します。

    データタイプ：数値

    範囲: -1.0 (負) から 1.0 (正)

    デフォルト：Null
    transcript.participantId
    必須です。メッセージに関連付けられた参加者。
    有効な値：
    • 顧客
    • エージェント

    データタイプ：文字列
    transcript.sentiment
    メッセージの感情。

    この値は、サードパーティプロバイダーによって生成されます。インスタンス構成設定に基づいて ServiceNow 、この値は正、負、またはどちらでもないのいずれかに変換され、会話およびインタラクションレコードに保存されます。

    有効な値：
    • 負
    • 中立
    • 正

    データタイプ：文字列

    デフォルト：Null

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 28. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不正な形式の JSON または必要なパラメーターが渡されませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    結果 コールの結果を説明するメッセージ。

    データタイプ：文字列
    会話 ID メッセージが添付された音声会話テーブルのSys_id。会話 [sys_cs_message_conversation] テーブルにあります。

    データタイプ：文字列

    cURL 要求

    次の例は、既存の音声インタラクションレコードにメッセージを追加する方法を示しています。

    curl "http://instance.servicenow.com/api/now/v1/cs/voice-interactions/transcript" \  
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type: application/json"\  
--user 'username':'password' \ 
-d ' { 
  "interactionId": "e67a6c30c7233010967a34c91dc26068", 
  "source": "Amazon Connect", 
  "conversationStarted": "2021-08-06 15:07:51", 
  "transcript": [ 
    { 
      "isEvent": "False", 
      "isInternalMessage": "False", 
      "beginOffsetMillis": 100000, 
      "content": "This is John. How can I help you?", 
      "endOffsetMillis": 150000, 
      "id": "954c4edc-31a8-48b0-8f6e-7fa0c4ca00a8", 
      "participantId": "AGENT", 
      "sentiment": "NEUTRAL" 
    }, 
    { 
      "isEvent": "False",
      "isInternalMessage": "False", 
      "beginOffsetMillis": 200000, 
      "content": "Uh, yes, John. Um, I'm a little frustrated right now.", 
      "endOffsetMillis": 25000, 
      "id": "18bcf19c-4a9b-4af1-9bd7-7bfb5ba53b9f", 
      "participantId": "CUSTOMER", 
      "sentiment": "NEGATIVE" 
    } 
  ] 
} ' 

    応答：

    {  
  "result": "Voice conversation transcript has been successfully saved. Conversation id: 8439d3c753b51110b6e8ddeeff7b12e2"  
}