---
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


---

# NotifyConferenceUtil - スコープ指定、グローバル

# NotifyConferenceUtil - スコープ指定、グローバル {#ariaid-title1}

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

NotifyConferenceUtil API は、Zoom や Webex などのさまざまな電話サービスプロバイダーの通知カンファレンスコールと SMS メッセージを管理するためのメソッドを提供します。

NotifyConferenceUtil API を使用すると、次のことができます。  
* 新しいカンファレンスコールの作成
* 電話番号またはユーザー ID で参加者を追加
* カンファレンスコールからの参加者の削除
* カンファレンスコールで参加者をミュート状態にする
* カンファレンスの参加者のミュートを解除する
* 指定されたサービスプロバイダーの機能を取得する
* カンファレンスコールを終了
{#NotifyConferenceUtils__ul_qvb_kqy_4hb}

この API は、スコープ対象スクリプトとグローバルスクリプトの両方で使用できます。この API を使用するには、会議通知プラグイン (com.snc.notify) を有効にする必要があります。これには個別のサブスクリプションが必要です。このプラグインのアクティブ化の詳細については、「 [通知のアクティブ化](https://www.servicenow.com/docs/access?context=t_ActivateNotify&version=australia&pubname=australia-servicenow-platform&ft:locale=en-US)」を参照してください。

## NotifyConferenceUtils - NotifyConferenceUtils() {#ariaid-title2}

NotifyConferenceUtils オブジェクト (コンストラクター) をインスタンス化します。
{#NUtil-NotifyConferenceUtils__table_qy1_cym_d3b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 1. パラメーター]

{#NUtil-NotifyConferenceUtils__table_qy1_cym_d3b}  

    function () {
    	var confGR = new GlideRecord('notify_conference_call');
    	confGR.get('76d3364d0b5133008e64aabcb4673a6d');

    	var confUtils = new NotifyConferenceUtils();
    	var actionResult = confUtils.addToConferenceByPhoneNumber("+917799555331", confGR)
    	if (actionResult.status)
    		gs.info('Participant has been added to conference');
    	else {
    		gs.info('join operation failed');
    		actionResult.warnMessages.forEach(function (msg) {
    			gs.info(msg);
    		});
    		actionResult.errorMessages.forEach(function (msg) {
    			gs.info(msg);
    		})
    	}
    })();

## NotifyConferenceUtils - addToConferenceByPhoneNumber(文字列 toNumber, GlideRecord confGR) {#ariaid-title3}

参加者を識別するための電話番号を使用して、指定されたカンファレンスコールに参加者を追加します。
{#NUtil-addToConferenceByPhoneNumber_S_GR__table_lt1_kth_nhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| toNumber | 文字列 | カンファレンスに追加する参加者の電話番号。 |
| confGR | GlideRecord | 指定された参加者を追加するカンファレンスの GlideRecord。 テーブル:通知カンファレンスコール \[notify_conference_call\] |
[表 : 2. パラメーター]

{#NUtil-addToConferenceByPhoneNumber_S_GR__table_lt1_kth_nhb} {#NUtil-addToConferenceByPhoneNumber_S_GR__table_mt1_kth_nhb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 会議アクションの結果。 `<action>.status:`会議アクションのステータス。 * データタイプ：ブーリアン * 可能な値： * true:会議アクションが成功しました * false:会議アクションが失敗しました {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_w5y_hyt_b3b} {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_psg_gyt_b3b} `<action>.successMessages`: <var class="keyword varname">ステータス</var> が true の場合、成功メッセージ、それ以外の場合は空。 * データタイプ：文字列のアレイ {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_qm2_myt_b3b} `<action>.warnMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_xbz_nyt_b3b} `<action>.errorMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされたエラーメッセージ。 * データタイプ：文字列のアレイ {#NUtil-addToConferenceByPhoneNumber_S_GR__ul_tht_4yt_b3b} |
[表 : 3. 返される内容]

{#NUtil-addToConferenceByPhoneNumber_S_GR__table_mt1_kth_nhb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    function () {
    	var confGR = new GlideRecord('notify_conference_call');
    	confGR.get('76d3364d0b5133008e64aabcb4673a6d');

    	var confUtils = new NotifyConferenceUtils();
    	var actionResult = confUtils.addToConferenceByPhoneNumber("+917799555331", confGR)
    	if (actionResult.status)
    		gs.info('Participant has been added to conference');
    	else {
    		gs.info('join operation failed');
    		actionResult.warnMessages.forEach(function (msg) {
    			gs.info(msg);
    		});
    		actionResult.errorMessages.forEach(function (msg) {
    			gs.info(msg);
    		})
    	}
    })();

## NotifyConferenceUtils - addToConferenceByUserId(文字列 userId, GlideRecord confGR) {#ariaid-title4}

一意のユーザー識別子を使用して、渡された GlideRecord によって参照されるカンファレンスコールに参加者を追加します。
{#NUtil-addToConferenceByUserId_S_GR__table_xld_mwh_nhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| userId | 文字列 | 指定されたカンファレンスに追加する参加者の Sys ID。 テーブル： ユーザー \[sys_user\] |
| confGR | GlideRecord | 指定された参加者を追加するためのカンファレンスの GlideRecord。 テーブル:通知カンファレンスコール \[notify_conference_call\] |
[表 : 4. パラメーター]

{#NUtil-addToConferenceByUserId_S_GR__table_xld_mwh_nhb} {#NUtil-addToConferenceByUserId_S_GR__table_yld_mwh_nhb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 会議アクションの結果。 `<action>.status:`会議アクションのステータス。 * データタイプ：ブーリアン * 可能な値： * true:会議アクションが成功しました * false:会議アクションが失敗しました {#NUtil-addToConferenceByUserId_S_GR__ul_w5y_hyt_b3b} {#NUtil-addToConferenceByUserId_S_GR__ul_psg_gyt_b3b} `<action>.successMessages`: <var class="keyword varname">ステータス</var> が true の場合、成功メッセージ、それ以外の場合は空。 * データタイプ：文字列のアレイ {#NUtil-addToConferenceByUserId_S_GR__ul_qm2_myt_b3b} `<action>.warnMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NUtil-addToConferenceByUserId_S_GR__ul_xbz_nyt_b3b} `<action>.errorMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされたエラーメッセージ。 * データタイプ：文字列のアレイ {#NUtil-addToConferenceByUserId_S_GR__ul_tht_4yt_b3b} |
[表 : 5. 返される内容]

{#NUtil-addToConferenceByUserId_S_GR__table_yld_mwh_nhb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    (function () {
    	var confGR = new GlideRecord('notify_conference_call');
    	confGR.get('76d3364d0b5133008e64aabcb4673a6d');

    	var confUtils = new NotifyConferenceUtils();
    	var actionResult = confUtils.addToConferenceByUserId(gs.getUserID(), confGR)
    	if (actionResult.status)
    		gs.info('Participant has been added to conference');
    	else {
    		gs.info('join operation failed');
    		actionResult.warnMessages.forEach(function (msg) {
    			gs.info(msg);
    		});
    		actionResult.errorMessages.forEach(function (msg) {
    			gs.info(msg);
    		})
    	}
    })();

## NotifyConferenceUtils - doConferenceAction(文字列アクション, オブジェクトデータ) {#ariaid-title5}

カンファレンスの開始/終了、カンファレンスの参加者の参加、削除、ミュート、ミュート解除など、指定されたカンファレンスアクションを実行します。
新しいカンファレンスコールを開始し、このメソッドへの 1 回の呼び出しで参加者を追加することも、メソッドを複数回呼び出してコールを開始し、参加者を個別に管理することもできます。さらに、渡されたデータオブジェクトを使用して、メソッドを次のように構成できます。

* カンファレンスコールのディスカッションのトピックであるインシデントや問題など、特定のレコード (ソースレコード) への ポインタを カンファレンスレコードに保存します。
* ソースレコードに対する複数のカンファレンスコールを許可/禁止します。
* ソースレコードの \[作業メモ\] フィールドに、カンファレンスコールに参加した参加者を自動的に記録します。
* 参加者が会議からの発信コールに応答するときにメッセージを読み上げてもらいます。
{#NUtil-doConferenceAction_S_O__ul_rqn_z2y_vhb}
{#NUtil-doConferenceAction_S_O__table_qqs_vdv_nhb__entry__3}{#NUtil-doConferenceAction_S_O__data-entry-NConf}{#NUtil-doConferenceAction_S_O__data.addToWorkNotes-p-NConf}{#NUtil-doConferenceAction_S_O__data.allowMulticonference-p-NConf}{#NUtil-doConferenceAction_S_O__data.confId-p-NConf}{#NUtil-doConferenceAction_S_O__data.fromNumber-p-NConf}{#NUtil-doConferenceAction_S_O__data.isNewConference-p-NConf}{#NUtil-doConferenceAction_S_O__data.items-p-NConf}{#NUtil-doConferenceAction_S_O__data.message-p-NConf}{#NUtil-doConferenceAction_S_O__data.serviceProvider-p-NConf}{#NUtil-doConferenceAction_S_O__data.sys_id-p-NConf}{#NUtil-doConferenceAction_S_O__data.table-p-NConf}

| 名前 | タイプ | 説明 |
|-|-|-|
| アクション | 文字列 | 実行するカンファレンスアクションを定義します。 利用可能なカンファレンスアクションは次のとおりです。 * end: data.confIdで識別されたカンファレンスコールを終了します。 * join: data.items アレイで指定された参加者を、 data.confIdで識別されたカンファレンスに追加します。 * kick: data.items アレイで指定された参加者を、 data.confIdで識別されたカンファレンスから削除します。 * multiJoin: data.items アレイで指定された参加者を、 で識別されたカンファレンスに追加します data.confId * multiKick:data.confIdで識別されたカンファレンスからdata.itemsアレイで指定された参加者を削除します。 * multiMute:data.confIdで識別されたカンファレンスコールで、data.itemsアレイで指定された参加者をミュートします。 * multiUnmute:data.confIdで識別されたカンファレンスから、data.items アレイで指定された参加者のミュート状態を解除します。 * mute:data.confIdで識別されたカンファレンスコールで、data.itemsアレイで指定された参加者をミュートします。 * selfJoin:現在ログインしているユーザーをカンファレンスに追加します ( data.items へのエントリは不要です)。 * start: data.confIdで識別されたカンファレンスコールを開始します。 * unmute:data.confIdで識別されたカンファレンスから、data.itemsアレイで指定された参加者のミュートを解除します。 {#NUtil-doConferenceAction_S_O__ul_pq5_qfv_nhb} |
| データ | オブジェクト | カンファレンスコールを説明するオブジェクト。 |
| data.addToWorkNotes | ブーリアン | カンファレンスコールに含まれた参加者に関する情報を関連レコードの作業メモフィールドに追加するかどうかを示すフラグ。 この機能を機能させるには、 data.table パラメーターと data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、作業メモを追加するレコードを識別します。{#NUtil-doConferenceAction_S_O__data.addToWorkNotes2-p-NConf} デフォルト値：false このパラメーターが有効なアクション: * 参加 * マルチ結合 * selfJoin * 開始 {#NUtil-doConferenceAction_S_O__ul_kwg_ktx_vhb} |
| data.allowMulticonference | ブーリアン | 特定のレコードに対して一度に複数のカンファレンスコールを許可するかどうかを示すフラグ。 この機能を機能させるには、 data.table パラメーターと data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、複数のカンファレンスコールを持つことが許可されているレコードを識別します。{#NUtil-doConferenceAction_S_O__data.allowMulticonference2-p-NConf} デフォルト値：false このパラメーターが有効なアクション: * 開始 {#NUtil-doConferenceAction_S_O__ul_ay4_mtx_vhb} |
| data.confId | 文字列 | カンファレンスのSys_id。 テーブル:通知カンファレンスコール \[notify_conference_call\]{#NUtil-doConferenceAction_S_O__data.confId2-p-NConf} このパラメーターが必要なアクション: * 終了 * 参加 * マルチ結合 * selfJoin {#NUtil-doConferenceAction_S_O__ul_afs_qsx_vhb} 注: ミュート、ミュート解除、キックなどの参加者のアクションでは、メソッドが通知カンファレンス参加者 \[notify_participant\] テーブルからこの情報を取得するため、このパラメーターを設定する必要はありません。 |
| data.fromNumber | 文字列 | カンファレンスコールのためにコールするサービスプロバイダー番号。 通知電話番号 \[notify_number\] テーブルの \[番号\] 列または \[電話番号\] 列で、この値を見つけます。{#NUtil-doConferenceAction_S_O__data.fromNumber2-p-NConf} このパラメーターが必要なアクション: * 開始 {#NUtil-doConferenceAction_S_O__ul_exs_stx_vhb} |
| data.isNewConference | ブーリアン | これが新規か既存のカンファレンスかを示すフラグ。 有効な値： * true:新しいカンファレンスコール * false:既存のカンファレンスコール {#NUtil-doConferenceAction_S_O__ul_q1m_wbv_nhb} デフォルト値：false このパラメーターが有効なアクション: * 開始 {#NUtil-doConferenceAction_S_O__ul_d1d_stx_vhb} |
| data.items | アレイ | カンファレンスコールに含める各参加者の情報。 有効なアレイ値: * ID:ユーザーのSys_id。ユーザー \[sys_User\] テーブルにあります。有効なアクション:join、multiJoin、start * notifyParticipantId:通知参加者の Sys ID。通知参加者 \[notify_participant\] テーブルにあります。有効なアクション:join、kick、multiJoin、mute、start、unmute * phoneNumber:参加者の電話番号。この値が id または notifyParticipantIdのいずれかと組み合わせて渡される場合、この値はユーザー/参加者レコード内の電話番号よりも優先され、コールの発信に使用されます。 有効なアクション:join、multiJoin、start * email:参加者のメールアドレス。有効なアクション:join、multiJoin、start {#NUtil-doConferenceAction_S_O__ul_qzh_pqt_rhb} |
| data.message | 文字列 | ユーザーがコールに応答したときに読み上げられるメッセージ (例:「P1 インシデントが作成されました。インスタンスにログインしてください」など)。 このパラメーターが有効なアクション: * 参加 * マルチ結合 * 開始 {#NUtil-doConferenceAction_S_O__ul_jnl_ntx_vhb} |
| data.serviceProvider | 文字列 | 必須です。Zoom や Webex などの会議サービスプロバイダーの名前。 このパラメーターが必要なアクション: * すべて {#NUtil-doConferenceAction_S_O__ul_vwb_psx_vhb} |
| data.sysId | 文字列 | カンファレンスコールに関連付けるソースレコードのSys_id。 たとえば、特定のインシデントまたは問題について話し合うためにカンファレンスが開催される場合は、インシデントまたは問題レコードのsys_idをこの値に入力します。このsys_idは、NotifyConference Call \[notify_conference_call\] テーブルの \[ソース\] 列に保存され、後で追跡できます。 {#NUtil-doConferenceAction_S_O__data.sys_id-p2-NConf} このパラメーターは、 data.Table、 data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用します。{#NUtil-doConferenceAction_S_O__data.sys_id-p3-NConf} このパラメーターが有効なアクション: * 開始 {#NUtil-doConferenceAction_S_O__ul_h3l_qsx_vhb} |
| data.table | 文字列 | カンファレンスコールに関連付けるソースレコードを含むテーブル。ソースレコードには、「インシデント」や「問題」など、カンファレンスコールでの議論のトピックである任意のレコードを指定できます。 このテーブル名は、NotifyConference Call \[notify_conference_call\] テーブルの \[テーブル\] 列に格納され、追跡できます。{#NUtil-doConferenceAction_S_O__data.table-p2-NConf} このパラメーターは、 data.sysId、 data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用します。{#NUtil-doConferenceAction_S_O__data.table-p3-NConf} このパラメーターが有効なアクション: * 開始 {#NUtil-doConferenceAction_S_O__ul_mj1_4sx_vhb} |
[表 : 6. パラメーター]

{#NUtil-doConferenceAction_S_O__table_qqs_vdv_nhb} {#NUtil-doConferenceAction_S_O__table_rqs_vdv_nhb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 会議アクションの結果。 `<action>.status:`会議アクションのステータス。 * データタイプ：ブーリアン * 可能な値： * true:会議アクションが成功しました * false:会議アクションが失敗しました {#NUtil-doConferenceAction_S_O__ul_w5y_hyt_b3b} {#NUtil-doConferenceAction_S_O__ul_psg_gyt_b3b} `<action>.successMessages`: <var class="keyword varname">ステータス</var> が true の場合、成功メッセージ、それ以外の場合は空。 * データタイプ：文字列のアレイ {#NUtil-doConferenceAction_S_O__ul_qm2_myt_b3b} `<action>.warnMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NUtil-doConferenceAction_S_O__ul_xbz_nyt_b3b} `<action>.errorMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされたエラーメッセージ。 * データタイプ：文字列のアレイ {#NUtil-doConferenceAction_S_O__ul_tht_4yt_b3b} |
[表 : 7. 返される内容]

{#NUtil-doConferenceAction_S_O__table_rqs_vdv_nhb}  

    (function (confId) {
    	var confUtils = new NotifyConferenceUtils();
    	var data = confUtils.getConferenceInputDataTemplate();
    	data.table = 'incident';
    	data.sysId = '1234';
    	data.addToWorkNotes = false;
    	data.confId = confId;
    	data.message = 'p1 incident has been created';
    	data.fromNumber = 'twilio/Telephony driver number';
    	data.items.push({ id: 'user3SysId', phoneNumber: '+917799555332' });
    	data.items.push({ id: 'user4SysId', email: 'yln99518@gmail.com' });

    	var result = confUtils.doConferenceAction('start', data);
    	if (result.status) {
    		gs.info('Start conference action succeeded');
    	} else
    		gs.info('Start conference action failed');

    	result.errorMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    	result.warnMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    	result.successMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    })('activeConfSysId');

## NotifyConferenceUtils - getConferenceInputDataTemplate() {#ariaid-title6}

doConferenceAction() メソッドで使用する JSON データテンプレートを返します。このテンプレートを使用すると、データオブジェクトが自動的に構造化されるため、手動で作成する必要はありません。
doConferenceAction() メソッドを呼び出す前に、このメソッドを呼び出してください。目的のカンファレンスコールアクションに対して、テンプレート内で目的のパラメーターを設定し、 doConferenceAction() 呼び出しでテンプレートを渡します。各アクションの有効なパラメーターの詳細については、「 [doConferenceAction()」](https://servicenow-prod.fluidtopics.net/sHU8TTeHzCfgT~tRCb~byw#NotifyConferenceUtils "NotifyConferenceUtil API は、Zoom や Webex などのさまざまな電話サービスプロバイダーの通知カンファレンスコールと SMS メッセージを管理するためのメソッドを提供します。")を参照してください。  
注:  
これはヘルパーメソッドです。また、このオブジェクトを手動で構築し、そのオブジェクトを doConferenceAction() メソッドに渡すと、同じ結果が得られます。
{#NUtil-getConferenceInputDataTemplate__table_azh_qyg_nhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 8. パラメーター]

{#NUtil-getConferenceInputDataTemplate__table_azh_qyg_nhb} {#NUtil-getConferenceInputDataTemplate__table_c2h_cwd_vhb__entry__2}{#NUtil-getConferenceInputDataTemplate__data.addToWorkNotes-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.allowMulticonference-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.confId-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.fromNumber-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.isNewConference-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.items-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.message-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.serviceProvider-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.sys_id-p-NConf}{#NUtil-getConferenceInputDataTemplate__data.table-p-NConf}

| タイプ | 説明 |
|-|-|
| データ | カンファレンスコールを説明するオブジェクト。 |
| data.addToWorkNotes | カンファレンスコールに含まれた参加者に関する情報を関連レコードの作業メモフィールドに追加するかどうかを示すフラグ。 この機能を機能させるには、 data.table パラメーターと data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、作業メモを追加するレコードを識別します。{#NUtil-getConferenceInputDataTemplate__data.addToWorkNotes2-p-NConf} デフォルト値：false このパラメーターが有効なアクション: * 参加 * マルチ結合 * selfJoin * 開始 {#NUtil-getConferenceInputDataTemplate__ul_kwg_ktx_vhb} |
| data.allowMultconference | 特定のレコードに対して一度に複数のカンファレンスコールを許可するかどうかを示すフラグ。 この機能を機能させるには、 data.table パラメーターと data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、複数のカンファレンスコールを持つことが許可されているレコードを識別します。{#NUtil-getConferenceInputDataTemplate__data.allowMulticonference2-p-NConf} デフォルト値：false このパラメーターが有効なアクション: * 開始 {#NUtil-getConferenceInputDataTemplate__ul_ay4_mtx_vhb} |
| data.confId | カンファレンスのSys_id。 テーブル:通知カンファレンスコール \[notify_conference_call\]{#NUtil-getConferenceInputDataTemplate__data.confId2-p-NConf} このパラメーターが必要なアクション: * 終了 * 参加 * マルチ結合 * selfJoin {#NUtil-getConferenceInputDataTemplate__ul_afs_qsx_vhb} 注: ミュート、ミュート解除、キックなどの参加者のアクションでは、メソッドが通知カンファレンス参加者 \[notify_participant\] テーブルからこの情報を取得するため、このパラメーターを設定する必要はありません。 |
| data.fromNumber | カンファレンスコールのためにコールするサービスプロバイダー番号。 通知電話番号 \[notify_number\] テーブルの \[番号\] 列または \[電話番号\] 列で、この値を見つけます。{#NUtil-getConferenceInputDataTemplate__data.fromNumber2-p-NConf} このパラメーターが必要なアクション: * 開始 {#NUtil-getConferenceInputDataTemplate__ul_exs_stx_vhb} |
| data.isNewConference | これが新規か既存のカンファレンスかを示すフラグ。 有効な値： * true:新しいカンファレンスコール * false:既存のカンファレンスコール {#NUtil-getConferenceInputDataTemplate__ul_q1m_wbv_nhb} デフォルト値：false このパラメーターが有効なアクション: * 開始 {#NUtil-getConferenceInputDataTemplate__ul_d1d_stx_vhb} |
| data.items | カンファレンスコールに含める各参加者の情報。 有効なアレイ値: * ID:ユーザーのSys_id。ユーザー \[sys_User\] テーブルにあります。有効なアクション:join、multiJoin、start * notifyParticipantId:通知参加者の Sys ID。通知参加者 \[notify_participant\] テーブルにあります。有効なアクション:join、kick、multiJoin、mute、start、unmute * phoneNumber:参加者の電話番号。この値が id または notifyParticipantIdのいずれかと組み合わせて渡される場合、この値はユーザー/参加者レコード内の電話番号よりも優先され、コールの発信に使用されます。 有効なアクション:join、multiJoin、start * email:参加者のメールアドレス。有効なアクション:join、multiJoin、start {#NUtil-getConferenceInputDataTemplate__ul_qzh_pqt_rhb} |
| data.message | ユーザーがコールに応答したときに読み上げられるメッセージ (例:「P1 インシデントが作成されました。インスタンスにログインしてください」など)。 このパラメーターが有効なアクション: * 参加 * マルチ結合 * 開始 {#NUtil-getConferenceInputDataTemplate__ul_jnl_ntx_vhb} |
| data.serviceProvider | 必須です。Zoom や Webex などの会議サービスプロバイダーの名前。 このパラメーターが必要なアクション: * すべて {#NUtil-getConferenceInputDataTemplate__ul_vwb_psx_vhb} |
| data.sysId | カンファレンスコールに関連付けるソースレコードのSys_id。 たとえば、特定のインシデントまたは問題について話し合うためにカンファレンスが開催される場合は、インシデントまたは問題レコードのsys_idをこの値に入力します。このsys_idは、NotifyConference Call \[notify_conference_call\] テーブルの \[ソース\] 列に保存され、後で追跡できます。 {#NUtil-getConferenceInputDataTemplate__data.sys_id-p2-NConf} このパラメーターは、 data.Table、 data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用します。{#NUtil-getConferenceInputDataTemplate__data.sys_id-p3-NConf} このパラメーターが有効なアクション: * 開始 {#NUtil-getConferenceInputDataTemplate__ul_h3l_qsx_vhb} |
| data.table | カンファレンスコールに関連付けるソースレコードを含むテーブル。ソースレコードには、「インシデント」や「問題」など、カンファレンスコールでの議論のトピックである任意のレコードを指定できます。 このテーブル名は、NotifyConference Call \[notify_conference_call\] テーブルの \[テーブル\] 列に格納され、追跡できます。{#NUtil-getConferenceInputDataTemplate__data.table-p2-NConf} このパラメーターは、 data.sysId、 data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用します。{#NUtil-getConferenceInputDataTemplate__data.table-p3-NConf} このパラメーターが有効なアクション: * 開始 {#NUtil-getConferenceInputDataTemplate__ul_mj1_4sx_vhb} |
[表 : 9. 返される内容]

{#NUtil-getConferenceInputDataTemplate__table_c2h_cwd_vhb}  

    (function (confId) {
    	var confUtils = new NotifyConferenceUtils();
    	var data = confUtils.getConferenceInputDataTemplate();
    	data.confId = confId;
    	var result = confUtils.doConferenceAction('end', data);
    	if (result.status) {
    		gs.info('Conference call has been ended');
    	} else
    		gs.info('End conference call action failed');

    	result.errorMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    	result.warnMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    	result.successMessages.forEach(function (msg) {
    		gs.info(msg);
    	});
    })('activeConfSysId');

## NotifyConferenceUtils - getServiceProvidersCapabilities() {#ariaid-title7}

インスタンス内のすべての電話通信サービスプロバイダードライバーの機能を返します。
可能な機能は次のとおりです。

* アーカイブ:会議の終了後にアーカイブします。
* beepOnLeave:参加者がカンファレンスコールから退出すると「ビープ音」を鳴らします
* beepOnJoin:参加者がカンファレンスコールに参加すると「ビープ」音を鳴らします
* 終了:識別されたカンファレンスコールを終了します
* ファイル共有:参加者間でのファイル共有を許可します
* 参加:カンファレンスコールに参加者を追加します
* 除外:カンファレンスから参加者を削除します
* multiJoin:カンファレンスコールに複数の参加者を追加します
* multiKick:カンファレンスコールから複数の参加者を削除
* muteOnJoin:参加者が最初にカンファレンスコールに参加したときに参加者をミュートします
* multiUnmute:カンファレンスの複数の参加者のミュート状態を解除します
* レコード:レコードのカンファレンスコール
* 記録:カンファレンスコールが記録されているときに画面上にインジケーターが表示されます
* screenSharing:参加者の画面をグループと共有できます
* selfJoin:現在ログインしているユーザーをカンファレンスに追加します
* 話している人:現在話している人に関するメッセージを画面に表示します
* 開始:識別されたカンファレンスコールを開始します
* unmute:カンファレンスの参加者のミュート状態を解除します
{#NUtil-getServiceProvidersCapabilities__ul_pq5_qfv_nhb}
{#NUtil-getServiceProvidersCapabilities__table_azh_qyg_nhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 10. パラメーター]

{#NUtil-getServiceProvidersCapabilities__table_azh_qyg_nhb} {#NUtil-getServiceProvidersCapabilities__table_bzh_qyg_nhb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 各ドライバー機能の状態のキーと値のペア。 有効な値： * isSupported = 0:機能はサポートされていません * isSupported = 1:機能はサポートされています {#NUtil-getServiceProvidersCapabilities__ul_jbq_mdt_rhb} |
[表 : 11. 返される内容]

{#NUtil-getServiceProvidersCapabilities__table_bzh_qyg_nhb}  
インスタンス内のすべての電話通信サービスプロバイダードライバーのドライバー機能を一覧表示します。

    (function () {
    	var confUtils = new NotifyConferenceUtils();
    	var providerToCapability = confUtils.getServiceProvidersCapabilites();
    	for (var provider in providerToCapability) {
    		gs.info('{0} supported capabilities \n\n', provider);
    		var capabilities = providerToCapability[provider]
    		for (var cap in capabilities)
    			if(confUtils.isActionSupported(capabilities[cap].isSupported))
    				gs.info('"{0}" action supported', cap);
    			else
    				gs.info("'{0}' action is not supported by this conference driver", cap);
    	}
    })();

出力:このメソッドは、インスタンス内のアクティブな電話通信サービスプロバイダーごとに、次のようなノードを返します。

    {
        "Telephony": {
            "start": {
                "isSupported": 1,
                "meta": {}
            },
            "end": {
                "isSupported": 1,
                "meta": {}
            },
            "selfJoin": {
                "isSupported": 1,
                "meta": {}
            },
            "join": {
                "isSupported": 1,
                "meta": {}
            },
            "multiJoin": {
                "isSupported": 1,
                "meta": {}
            },
            "mute": {
                "isSupported": 1,
                "meta": {}
            },
            "multiMute": {
                "isSupported": 1,
                "meta": {}
            },
            "unmute": {
                "isSupported": 1,
                "meta": {}
            },
            "multiUnmute": {
                "isSupported": 1,
                "meta": {}
            },
            "kick": {
                "isSupported": 1,
                "meta": {}
            },
            "multiKick": {
                "isSupported": 1,
                "meta": {}
            },
            "record": {
                "isSupported": 0,
                "meta": {}
            },
            "speaking": {
                "isSupported": 0,
                "meta": {}
            },
            "recording": {
                "isSupported": 0,
                "meta": {}
            },
            "screenSharing": {
                "isSupported": 0,
                "meta": {}
            },
            "fileSharing": {
                "isSupported": 0,
                "meta": {}
            },
            "archive": {
                "isSupported": 0,
                "meta": {}
            },
            "muteOnJoin": {
                "isSupported": 0,
                "meta": {}
            },
            "beepOnJoin": {
                "isSupported": 0,
                "meta": {}
            },
            "beepOnLeave": {
                "isSupported": 0,
                "meta": {}
            }
        }
    }

## NotifyConferenceUtils - isActionSupported(数値アクション) {#ariaid-title8}

通知会議アクションが電話通信サービスプロバイダーによってサポートされているかどうかを決定します。
このメソッドを使用するには、最初に getServiceProviderCapabilities() メソッドを呼び出す必要があります。このメソッドは、インスタンスで構成された各サービスプロバイダーに対して考えられる各通知会議アクションの可用性に関する情報を含むオブジェクトを返します。

例：  

    {
        "Telephony": {
            "start": {
                "isSupported": 1,
                "meta": {}
            },
            "end": {
                "isSupported": 1,
                "meta": {}
            },
            "selfJoin": {
                "isSupported": 1,
                "meta": {}
            },
            "join": {
                "isSupported": 1,
                "meta": {}
            },
            "multiJoin": {
                "isSupported": 1,
                "meta": {}
            },
            "mute": {
                "isSupported": 1,
                "meta": {}
            },
            "multiMute": {
                "isSupported": 1,
                "meta": {}
            },
            "unmute": {
                "isSupported": 1,
                "meta": {}
            },
            "multiUnmute": {
                "isSupported": 1,
                "meta": {}
            },
            "kick": {
                "isSupported": 1,
                "meta": {}
            },
            "multiKick": {
                "isSupported": 1,
                "meta": {}
            },
            "record": {
                "isSupported": 0,
                "meta": {}
            },
            "speaking": {
                "isSupported": 0,
                "meta": {}
            },
            "recording": {
                "isSupported": 0,
                "meta": {}
            },
            "screenSharing": {
                "isSupported": 0,
                "meta": {}
            },
            "fileSharing": {
                "isSupported": 0,
                "meta": {}
            },
            "archive": {
                "isSupported": 0,
                "meta": {}
            },
            "muteOnJoin": {
                "isSupported": 0,
                "meta": {}
            },
            "beepOnJoin": {
                "isSupported": 0,
                "meta": {}
            },
            "beepOnLeave": {
                "isSupported": 0,
                "meta": {}
            }
        }
    }

{#NUtil-isActionSupported_N__table_gsw_vd2_vhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| action | 番号 | 特定のアクションとサービスプロバイダーの getServiceProvidersCapabilities() メソッドによって返されるisSupportedパラメーターの値。 注: isSupported値はブール値のように見えますが、実際には数値です。ケイパビリティをブール値として評価しないでください。関連する値は将来のバージョンで拡張される可能性があるため、このメソッドを使用します。 |
[表 : 12. パラメーター]

{#NUtil-isActionSupported_N__table_gsw_vd2_vhb} {#NUtil-isActionSupported_N__table_hsw_vd2_vhb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 電話通信サービスプロバイダーが指定されたアクションをサポートしているかどうかを示すフラグ。 有効な値： * true:アクションはサービスプロバイダーによってサポートされています * false:アクションはサービスプロバイダーによってサポートされていません {#NUtil-isActionSupported_N__ul_pkt_mf2_vhb} |
[表 : 13. 返される内容]

{#NUtil-isActionSupported_N__table_hsw_vd2_vhb}  

    (function () {
      var confUtils = new NotifyConferenceUtils();
      var providerToCapability = confUtils.getServiceProvidersCapabilites();
        for (var provider in providerToCapability) {
          gs.info('{0} supported capabilities \n\n', provider);
          var capabilities = providerToCapability[provider]
          for (var cap in capabilities)
            if (confUtils.isActionSupported(capabilities[cap].isSupported))
              gs.info('"{0}" action supported', cap);
            else
              gs.info("'{0}' action is not supported by this conference driver", cap);
        }
    })();

## NotifyConferenceUtils - kickByParticipantGR(GlideRecord notifyParticipantGR) {#ariaid-title9}

渡された GlideRecord に関連付けられた参加者を現在のカンファレンスから削除します。
{#NUtil-kickByParticipantGR_GR__table_inj_thh_nhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| notifyParticipantGR | GlideRecord | カンファレンスから削除する参加者の GlideRecord オブジェクト。 テーブル:参加者に通知 \[notify_participant\] |
[表 : 14. パラメーター]

{#NUtil-kickByParticipantGR_GR__table_inj_thh_nhb} {#NUtil-kickByParticipantGR_GR__table_jnj_thh_nhb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 会議アクションの結果。 `<action>.status:`会議アクションのステータス。 * データタイプ：ブーリアン * 可能な値： * true:会議アクションが成功しました * false:会議アクションが失敗しました {#NUtil-kickByParticipantGR_GR__ul_w5y_hyt_b3b} {#NUtil-kickByParticipantGR_GR__ul_psg_gyt_b3b} `<action>.successMessages`: <var class="keyword varname">ステータス</var> が true の場合、成功メッセージ、それ以外の場合は空。 * データタイプ：文字列のアレイ {#NUtil-kickByParticipantGR_GR__ul_qm2_myt_b3b} `<action>.warnMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NUtil-kickByParticipantGR_GR__ul_xbz_nyt_b3b} `<action>.errorMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされたエラーメッセージ。 * データタイプ：文字列のアレイ {#NUtil-kickByParticipantGR_GR__ul_tht_4yt_b3b} |
[表 : 15. 返される内容]

{#NUtil-kickByParticipantGR_GR__table_jnj_thh_nhb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    (function () {
        var confUtils = new NotifyConferenceUtils();
        var participantGR = new GlideRecord('notify_participant');  // Participant record contains conf call ID
        participantGR.get('validParticipantSysId');
        var actionResult = confUtils.kickByParticipantGR(participantGR);
        if (actionResult.status)
            gs.info('Participant has been kicked out of conference');
        else {
            gs.info('kick operation failed');
            actionResult.warnMessages.forEach(function (msg) {
                gs.info(msg);
            });
            actionResult.errorMessages.forEach(function (msg) {
                gs.info(msg);
            })
        }
    })()

## NotifyConferenceUtils - muteByParticipantGR(GlideRecord notifyParticipantGR) {#ariaid-title10}

現在のカンファレンスコールで渡された GlideRecord に関連付けられた参加者をミュートします。
{#NUtil-muteByParticipantGR_GR__table_vpk_ckh_nhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| notifyParticipantGR | オブジェクト | ミュートする参加者の GlideRecord オブジェクト。 テーブル:参加者に通知 \[notify_participant\] |
[表 : 16. パラメーター]

{#NUtil-muteByParticipantGR_GR__table_vpk_ckh_nhb} {#NUtil-muteByParticipantGR_GR__table_wpk_ckh_nhb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 会議アクションの結果。 `<action>.status:`会議アクションのステータス。 * データタイプ：ブーリアン * 可能な値： * true:会議アクションが成功しました * false:会議アクションが失敗しました {#NUtil-muteByParticipantGR_GR__ul_w5y_hyt_b3b} {#NUtil-muteByParticipantGR_GR__ul_psg_gyt_b3b} `<action>.successMessages`: <var class="keyword varname">ステータス</var> が true の場合、成功メッセージ、それ以外の場合は空。 * データタイプ：文字列のアレイ {#NUtil-muteByParticipantGR_GR__ul_qm2_myt_b3b} `<action>.warnMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NUtil-muteByParticipantGR_GR__ul_xbz_nyt_b3b} `<action>.errorMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされたエラーメッセージ。 * データタイプ：文字列のアレイ {#NUtil-muteByParticipantGR_GR__ul_tht_4yt_b3b} |
[表 : 17. 返される内容]

{#NUtil-muteByParticipantGR_GR__table_wpk_ckh_nhb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    (function () {
        var confUtils = new NotifyConferenceUtils();
        var participantGR = new GlideRecord('notify_participant');
        participantGR.get('validSysId');
        var actionResult = confUtils.muteByParticipantGR(participantGR);
        if (actionResult.status)
            gs.info('Participant has been muted');
        else {
            gs.info('mute operation failed');
            actionResult.warnMessages.forEach(function (msg) {
                gs.info(msg);
            });
            actionResult.errorMessages.forEach(function (msg) {
                gs.info(msg);
            })
        }
    })()

## NotifyConferenceUtils - unmuteByParticipantGR(GlideRecord notifyParticipantGR) {#ariaid-title11}

現在のカンファレンスコールで渡された GlideRecord に関連付けられた参加者のミュート状態を解除します。
{#NUtil-unmuteByParticipantGR_GR__table_byp_zqh_nhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| notifyParticipantGR | GlideRecord | ミュートを解除する参加者の GlideRecord オブジェクト。これらのレコードは、通知参加者 \[notify_participant\] テーブルにあります。 |
[表 : 18. パラメーター]

{#NUtil-unmuteByParticipantGR_GR__table_byp_zqh_nhb} {#NUtil-unmuteByParticipantGR_GR__table_cyp_zqh_nhb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 会議アクションの結果。 `<action>.status:`会議アクションのステータス。 * データタイプ：ブーリアン * 可能な値： * true:会議アクションが成功しました * false:会議アクションが失敗しました {#NUtil-unmuteByParticipantGR_GR__ul_w5y_hyt_b3b} {#NUtil-unmuteByParticipantGR_GR__ul_psg_gyt_b3b} `<action>.successMessages`: <var class="keyword varname">ステータス</var> が true の場合、成功メッセージ、それ以外の場合は空。 * データタイプ：文字列のアレイ {#NUtil-unmuteByParticipantGR_GR__ul_qm2_myt_b3b} `<action>.warnMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NUtil-unmuteByParticipantGR_GR__ul_xbz_nyt_b3b} `<action>.errorMessages`: <var class="keyword varname">ステータス</var> が false の場合、処理中にスローされたエラーメッセージ。 * データタイプ：文字列のアレイ {#NUtil-unmuteByParticipantGR_GR__ul_tht_4yt_b3b} |
[表 : 19. 返される内容]

{#NUtil-unmuteByParticipantGR_GR__table_cyp_zqh_nhb}  

    (function () {
        var confUtils = new NotifyConferenceUtils();
        var participantGR = new GlideRecord('notify_participant');
        participantGR.get('validSysId');
        var actionResult = confUtils.unmuteByParticipantGR(participantGR);
        if (actionResult.status)
            gs.info('Participant has been Unmuted');
        else {
            gs.info('Unmute operation failed');
            actionResult.warnMessages.forEach(function (msg) {
                gs.info(msg);
            });
            actionResult.errorMessages.forEach(function (msg) {
                gs.info(msg);
            })
        }
    })();