---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# 音声インタラクションリソース API

# 音声インタラクションリソース API {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：34分

音声インタラクション API は、電話会話中にエージェントと発信者間の音声インタラクションを文字起こしして保存するためのエンドポイントを提供します。仮想エージェントチャットやライブエージェントチャットと連携して機能します。
この API を使用して、進行中の通話からの文字起こしされたメッセージをリアルタイムで保持したり、履歴目的で既存の音声会話録音を文字起こしして保存したりできます。文字起こしされたメッセージは エージェントワークスペースに表示されるため、エージェントは発信者と話しているときにエージェントアシストや検索などの機能を活用できます。トランスクリプトされたメッセージは、会話メッセージ \[sys_cs_message\] テーブルに保持されます。

## コールフロー

次の呼び出しフローは、 音声インタラクション API を使用して音声インタラクションレコードを作成し、その音声会話内でメッセージを文字起こしして保存してから、音声会話レコードを閉じる方法を示しています。ビジネスルールやその他のスクリプトを使用してこの機能を実行することもできますが、このタイプの実装についてはこのセクションでは説明しません。

1. まず、 [音声インタラクションリソース:POST /cs/voice-interactions](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-POST-voice_inter "インタラクション [interaction] テーブル内に音声インタラクションレコードを作成します。") エンドポイントを呼び出して、インタラクション \[interaction\] テーブルに音声インタラクションレコードを作成します。
2. 次に、 [音声インタラクションリソース:POST /cs/voice-interactions/{interactionId}/messages](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-POST-voice_inter-messages "指定された音声会話メッセージを指定された音声トランザクションレコードに追加します。これらのメッセージは通常、サードパーティベンダーのソフトウェアを使用して生成されます。現在、Amazon Connect のみがサポートされています。") エンドポイントを呼び出して、音声会話から翻訳されたメッセージを会話メッセージテーブルに保存します。リアルタイム会話を処理している場合は、メッセージがタイムリーに エージェントワークスペース に表示されるように、このエンドポイントを頻繁に呼び出す必要があります。履歴目的で記録を処理する場合は、単一のエンドポイント呼び出しですべてのメッセージを渡すことができます。
3. 音声メッセージの永続化が完了したら、 [音声インタラクションリソース:PATCH /cs/voice-interactions/{interactionId}/state](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-PATCH-voice_inter-state "指定された音声インタラクションを終了します。一度呼び出しが行われると、追加の音声メッセージは翻訳されて、電話での会話用に保存されません。") エンドポイントを呼び出してキャプチャを終了し、音声インタラクションレコードを閉じます。

## 可用性

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

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

指定された音声インタラクションを終了します。一度呼び出しが行われると、追加の音声メッセージは翻訳されて、電話での会話用に保存されません。
<br />

### URL 形式

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

デフォルト URL: /api/now/v1/cs/voice-interactions/{interactionId}/state  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#vir-PATCH-voice_inter-state__entry__2}{#vir-PATCH-voice_inter-state__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| interactionId | 音声インタラクションを終了するインタラクションレコードのSys_id。[音声インタラクションリソース:POST /cs/voice-interactions](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-POST-voice_inter "インタラクション [interaction] テーブル内に音声インタラクションレコードを作成します。") エンドポイントによって返されます。 データタイプ：文字列 テーブル:インタラクション \[interaction\] |
[表 : 1. パスパラメーター]

{#vir-PATCH-voice_inter-state__entry__8}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 2. クエリパラメーター]

{#vir-PATCH-voice_inter-state__entry__12}

| 名前 | 説明 |
|-|-|
| 記録 URL | 元の音声録音が配置されている URL。 そのように設定されている場合、この URL は エージェントワークスペースに表示されます。 データタイプ：文字列 デフォルト：なし |
| 状況 | 必須です。音声インタラクションのステータス。 サポートされている値:closed_complete のみ データタイプ：文字列 |
[表 : 3. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#vir-PATCH-voice_inter-state__entry__18}{#vir-PATCH-voice_inter-state__accept-RESTAPI}{#vir-PATCH-voice_inter-state__content_type-RESTAPI}

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

{#vir-PATCH-voice_inter-state__entry__24}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 5. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#vir-PATCH-voice_inter-state__entry__28}{#vir-PATCH-voice_inter-state__entry-200-status-code}{#vir-PATCH-voice_inter-state__entry-500-status-code}

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

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

{#vir-PATCH-voice_inter-state__entry__36}

| 名前 | 説明 |
|-|-|
| result | 操作のステータス。 可能な値： * 成功 * 失敗 エラーが発生した場合は、エラーを説明するメッセージも返されます。エラーが 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 {#ariaid-title3}

インタラクション \[interaction\] テーブル内に音声インタラクションレコードを作成します。
文字起こしされた音声メッセージを保存する前に、このレコードを作成する必要があります。このエンドポイントを使用して、特定のユーザー ID を渡して特定のエージェントにコールをアサインすることもできます。

### URL 形式

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

デフォルト URL: /api/now/v1/cs/voice-interactions  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#vir-POST-voice_inter__entry__2}{#vir-POST-voice_inter__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 7. パスパラメーター]

{#vir-POST-voice_inter__entry__6}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 8. クエリパラメーター]

{#vir-POST-voice_inter__entry__10}

| 名前 | 説明 |
|-|-|
| agentId | 音声インタラクションをアサインするエージェントの一意の識別子。 データタイプ：文字列 デフォルト:仮想エージェントを呼び出す |
| 発信者の電話番号 | 発信者のコールバック電話番号。これは、コールが切断された場合にエージェントが発信者に連絡するために使用する番号です。 データタイプ：文字列 形式:E.164標準準拠 デフォルト：なし |
| clientSessionId | この通話を追跡するために使用される外部システム内のレコードの一意の識別子。この情報は、2 つのシステム間のレコードをリンクします。 データタイプ：文字列 デフォルト：なし |
| inboundId | 音声サービスのアプリケーションプロバイダーの一意の識別子。 データタイプ：文字列 デフォルト:チャットから取得 |
| userId | 必須です。音声トランザクションに関連付けられたコールを発信した発信者の電話番号。 データタイプ：文字列 形式:音声会話スクリプトを作成したソフトウェアによって定義されます。通常、E.164 標準に準拠しています。 |
[表 : 9. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#vir-POST-voice_inter__entry__22}{#vir-POST-voice_inter__accept-RESTAPI}{#vir-POST-voice_inter__content_type-RESTAPI}

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

{#vir-POST-voice_inter__entry__28}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 11. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#vir-POST-voice_inter__entry__32}{#vir-POST-voice_inter__entry-200-status-code}{#vir-POST-voice_inter__entry-500-status-code}

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

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

{#vir-POST-voice_inter__entry__40}

| 名前 | 説明 |
|-|-|
| interactionId | 新しく作成された音声インタラクションレコードのSys_id。 このsys_idは次の場合に使用します。 * [音声インタラクションリソース:POST /cs/voice-interactions/{interactionId}/messages](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-POST-voice_inter-messages "指定された音声会話メッセージを指定された音声トランザクションレコードに追加します。これらのメッセージは通常、サードパーティベンダーのソフトウェアを使用して生成されます。現在、Amazon Connect のみがサポートされています。") エンドポイントを呼び出して、音声インタラクションにメッセージを追加します。 * [音声インタラクションリソース:PATCH /cs/voice-interactions/{interactionId}/state](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-PATCH-voice_inter-state "指定された音声インタラクションを終了します。一度呼び出しが行われると、追加の音声メッセージは翻訳されて、電話での会話用に保存されません。") エンドポイントを呼び出して音声インタラクションを終了します。 データタイプ：文字列 テーブル:インタラクション \[interaction\] |
[ ]

### 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 {#ariaid-title4}

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

### URL 形式

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

デフォルト URL: /api/now/v1/cs/voice-interactions/{interactionId}/conversation  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#vir-POST-voice_inter-conver__entry__2}{#vir-POST-voice_inter-conver__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| interactionId | 会話レコードを作成するインタラクションレコードのSys_id。この値は [音声インタラクションリソース:POST /cs/voice-interactions](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-POST-voice_inter "インタラクション [interaction] テーブル内に音声インタラクションレコードを作成します。") エンドポイントによって返され、インタラクション \[interaction\] テーブルに格納されます。 データタイプ：文字列 |
[表 : 13. パスパラメーター]

{#vir-POST-voice_inter-conver__entry__8}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 14. クエリパラメーター]

{#vir-POST-voice_inter-conver__entry__12}

| 名前 | 説明 |
|-|-|
| agentId | 音声インタラクションをアサインするエージェントの一意の識別子。 データタイプ：文字列 デフォルト:仮想エージェントを呼び出す |
| 発信者の電話番号 | 発信者のコールバック電話番号。これは、コールが切断された場合にエージェントが発信者に連絡するために使用する番号です。 データタイプ：文字列 形式:E.164標準準拠 デフォルト：なし |
| clientSessionId | この通話を追跡するために使用される外部システム内のレコードの一意の識別子。この情報は、2 つのシステム間のレコードをリンクします。 データタイプ：文字列 デフォルト：なし |
| inboundId | 音声サービスのアプリケーションプロバイダーの一意の識別子。 データタイプ：文字列 デフォルト:チャットからプル |
| userId | 必須です。音声トランザクションに関連付けられたコールを発信した発信者の電話番号。 データタイプ：文字列 形式:音声会話スクリプトを作成したソフトウェアによって定義されます。通常、E.164 標準に準拠しています。 |
[表 : 15. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#vir-POST-voice_inter-conver__entry__24}{#vir-POST-voice_inter-conver__accept-RESTAPI}{#vir-POST-voice_inter-conver__content_type-RESTAPI}

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

{#vir-POST-voice_inter-conver__entry__30}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 17. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#vir-POST-voice_inter-conver__entry__34}{#vir-POST-voice_inter-conver__entry-200-status-code}{#vir-POST-voice_inter-conver__entry-500-status-code}

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

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

{#vir-POST-voice_inter-conver__entry__42}

| 名前 | 説明 |
|-|-|
| 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 {#ariaid-title5}

指定された音声会話メッセージを指定された音声トランザクションレコードに追加します。これらのメッセージは通常、サードパーティベンダーのソフトウェアを使用して生成されます。現在、Amazon Connect のみがサポートされています。
コールのリアルタイム文字起こし中にこのエンドポイントを複数回呼び出すことも、履歴目的でコールを文字起こしする場合は、1 回のコールですべてのメッセージを渡すこともできます。リアルタイム会話を処理している場合は、メッセージがタイムリーに エージェントワークスペース に表示されるように、このエンドポイントを頻繁に呼び出す必要があります。メッセージは、コールの開始に対する開始時間と終了時間に基づいて順序付けされます。

### URL 形式

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

デフォルト URL: /api/now/v1/cs/voice-interactions/{interactionId}/messages  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#vir-POST-voice_inter-messages__entry__2}{#vir-POST-voice_inter-messages__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| interactionId | 指定されたメッセージを追加するインタラクションレコードのSys_id。この値は [音声インタラクションリソース:POST /cs/voice-interactions](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-POST-voice_inter "インタラクション [interaction] テーブル内に音声インタラクションレコードを作成します。") エンドポイントによって返され、インタラクション \[interaction\] テーブルに格納されます。 データタイプ：文字列 |
[表 : 19. パスパラメーター]

{#vir-POST-voice_inter-messages__entry__8}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 20. クエリパラメーター]

{#vir-POST-voice_inter-messages__entry__12}

| 名前 | 説明 |
|-|-|
| \<json_string\> | 指定された音声インタラクションに添付するメッセージのリスト。 "<json_string>":[ { "attributes": [Array], "beginOffsetMillis": Long, "content": "String" "endOffsetMillis": Long, "id": "String", "isEvent": Boolean, "isInternalMessage": Boolean, "loudnessScore": "Number", "participantId": "String", "sentiment": "String" } ] |
| \<json_string\>.attributes | 音声インタラクションに関連付けるキーと値のペア。 単純なオブジェクトから複雑な複合オブジェクトまで、あらゆるタイプのデータオブジェクトにすることができます。これらは、Amazon Web Services API を呼び出すときに一意の識別子として使用されます。 データタイプ：オブジェクトのアレイ デフォルト：なし |
| \<json_string\>.beginOffsetMillis | 必須です。音声インタラクションの開始と関連するメッセージの開始の間の時間オフセット。例:"beginOffsetMillis": 2650。 データタイプ:長 単位：ミリ秒 |
| \<json_string\>.content | 必須です。音声インタラクションに追加するメッセージのテキスト。 データタイプ：文字列 |
| \<json_string\>.endOffsetMillis | 必須です。音声インタラクションの開始とメッセージの終了の間の時間オフセット。例:"endOffsetMillis": 9380。 データタイプ:長 単位：ミリ秒 |
| \<json_string\>.id | この音声会話のソースのメッセージ UUID (AmazonConnect など)。ソースメッセージ ID 列の値を設定します。 データタイプ：文字列 デフォルト：なし |
| \<json_string\>.isEvent | Amazon Connect によって設定されますが、メソッドで現在使用されていません。関連付けられたメッセージがイベントであるかどうかを示すフラグ。 有効な値： * true:メッセージはイベントです。 * false:メッセージはイベントではありません。 データタイプ：ブーリアン デフォルト値：false |
| \<json_string\>.isInternalMessage | これが内部メッセージであり、発信者に表示してはならないかどうかを示すフラグ。 転写は通常、内部メッセージと見なされ、エージェントにのみ表示され、発信者には表示されません。さらに、エージェントウィスパーは、サイレントサードパーティが発信者に気づかれずにチャット中であるか、電話会話に参加してエージェントにアドバイスを提供するときに使用されます。発信者はこれらのメッセージを聞いたり見たりしませんが、エージェントは聞いたり見たりします。 有効な値： * true:内部メッセージ。発信者には表示されません。 * false:内部メッセージではありません。発信者に表示されます。 {#vir-POST-voice_inter-messages__ul_sdw_bf3_vvb} データタイプ：ブーリアン デフォルト値：false |
| \<json_string\>.loudnessScore | 通話中に顧客またはエージェントが話している大音量に関する測定値。 Contact Lens には、相手が大声で話している可能性があり、否定的な感情を持っている可能性がある場所を示す会話の分析が表示されます。 データタイプ：数値 範囲:-1.0 (負) から 1.0 (正) デフォルト：Null |
| \<json_string\>.participantId | 必須です。メッセージに関連付けられた参加者。 有効な値： * エージェント * 顧客 データタイプ：文字列 |
| \<json_string\>.sentiment | メッセージの感情。 この値はサードパーティプロバイダーによって生成されます。ServiceNowインスタンス構成設定に基づいて、この値は正、負、またはどちらかに変換され、会話とインタラクションのレコードに保存されます。 有効な値： * 否定的 * ニュートラル * ポジティブ データタイプ：文字列 デフォルト：Null |
[表 : 21. 要求本文パラメーター (Amazon Connect)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#vir-POST-voice_inter-messages__entry__36}{#vir-POST-voice_inter-messages__accept-RESTAPI}{#vir-POST-voice_inter-messages__content_type-RESTAPI}

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

{#vir-POST-voice_inter-messages__entry__42}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 23. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#vir-POST-voice_inter-messages__entry__46}{#vir-POST-voice_inter-messages__entry-200-status-code}{#vir-POST-voice_inter-messages__entry-500-status-code}

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

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

{#vir-POST-voice_inter-messages__entry__54}

| 名前 | 説明 |
|-|-|
| result | コールの結果を説明するメッセージ。 データタイプ：文字列 |
| 会話 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 {#ariaid-title6}

コールの完了後に、既存の音声インタラクションにメッセージを追加します。この API を使用して、エージェントと発信者間の音声通話の文字起こしされたメッセージを添付できます。
<br />

### URL 形式

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

デフォルト URL: /api/now/v1/cs/voice-interactions/{interactionId}/transcript  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#vir-POST-voice_inter-transcript__entry__2}{#vir-POST-voice_inter-transcript__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 25. パスパラメーター]

{#vir-POST-voice_inter-transcript__entry__6}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 26. クエリパラメーター]

{#vir-POST-voice_inter-transcript__entry__10}{#vir-POST-voice_inter-transcript__vto-interactionId-REST-entry}

| 名前 | 説明 |
|-|-|
| 会話開始済み | 会話の開始時間。 データタイプ：文字列 形式:YYYY-MM-DD HH:MM:SS テーブル:インタラクション \[interaction\] |
| interactionId | 指定されたメッセージを追加するインタラクションレコードのSys_id。この値は、 [音声インタラクションリソース:POST /cs/voice-interactions](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-POST-voice_inter "インタラクション [interaction] テーブル内に音声インタラクションレコードを作成します。") エンドポイントによって返されます。 データタイプ：文字列 テーブル:インタラクション \[interaction\] |
| ソース | 最初に会話インタラクションのトランスクリプトを作成したチャネルの名前。 現在サポートされている値は `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 Services API を呼び出すときに一意の識別子として使用されます。 データタイプ：オブジェクトのアレイ デフォルト：なし |
| transcript.beginOffsetMillis | 必須です。音声インタラクションの開始と関連するメッセージの開始の間の時間オフセット。例:"beginOffsetMillis": 2650。 データタイプ:長 単位：ミリ秒 |
| transcript.content | 必須です。音声インタラクションに追加するメッセージのテキスト。 データタイプ：文字列 |
| transcript.endOffsetMillis | 必須です。音声インタラクションの開始とメッセージの終了の間の時間オフセット。例:"endOffsetMillis": 9380。 データタイプ:長 単位：ミリ秒 |
| transcript.id | この音声会話のソースのメッセージ UUID (AmazonConnect など)。ソースメッセージ ID 列の値を設定します。 データタイプ：文字列 デフォルト：なし |
| transcript.isEvent | Amazon Connect によって設定されますが、メソッドで現在使用されていません。関連付けられたメッセージがイベントであるかどうかを示すフラグ。 有効な値： * true:メッセージはイベントです。 * false:メッセージはイベントではありません。 データタイプ：ブーリアン デフォルト値：false |
| transcript.isInternalMessage | これが内部メッセージであり、発信者に表示してはならないかどうかを示すフラグ。 転写は通常、内部メッセージと見なされ、エージェントにのみ表示され、発信者には表示されません。さらに、エージェントウィスパーは、サイレントサードパーティが発信者に気づかれずにチャット中であるか、電話会話に参加してエージェントにアドバイスを提供するときに使用されます。発信者はこれらのメッセージを聞いたり見たりしませんが、エージェントは聞いたり見たりします。 有効な値： * true:内部メッセージ。発信者には表示されません。 * false:内部メッセージではありません。発信者に表示されます。 {#vir-POST-voice_inter-transcript__ul_sdw_bf3_vvb} データタイプ：ブーリアン デフォルト値：false |
| transcript.loudnessScore | 通話中に顧客またはエージェントが話している大音量に関する測定値。 Contact Lens には、相手が大声で話している可能性があり、否定的な感情を持っている可能性がある場所を示す会話の分析が表示されます。 データタイプ：数値 範囲:-1.0 (負) から 1.0 (正) デフォルト：Null |
| transcript.participantId | 必須です。メッセージに関連付けられた参加者。 有効な値： * エージェント * 顧客 データタイプ：文字列 |
| transcript.sentiment | メッセージの感情。 この値はサードパーティプロバイダーによって生成されます。ServiceNowインスタンス構成設定に基づいて、この値は正、負、またはどちらかに変換され、会話とインタラクションのレコードに保存されます。 有効な値： * 否定的 * ニュートラル * ポジティブ データタイプ：文字列 デフォルト：Null |
[表 : 27. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#vir-POST-voice_inter-transcript__entry__40}{#vir-POST-voice_inter-transcript__accept-RESTAPI}{#vir-POST-voice_inter-transcript__content_type-RESTAPI}

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

{#vir-POST-voice_inter-transcript__entry__46}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 29. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#vir-POST-voice_inter-transcript__entry__50}{#vir-POST-voice_inter-transcript__entry-200-status-code}{#vir-POST-voice_inter-transcript__entry-500-status-code}

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

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

{#vir-POST-voice_inter-transcript__entry__58}

| 名前 | 説明 |
|-|-|
| result | コールの結果を説明するメッセージ。 データタイプ：文字列 |
| 会話 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"  
    }