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


---

# NotifyOnTaskClient - クライアント

# NotifyOnTaskClient - クライアント {#ariaid-title1}

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

NotifyOnTaskClient API は、Zoom や Webex などのさまざまな電話通信サービスプロバイダーに対して、SMS メッセージを送信したり、カンファレンスコールを開始/管理したりするためのメソッドを提供します。

NotifyOnTaskClient UI スクリプトを明示的に含めることで、任意の UI で NotifyOnTaskClient API を使用できます。

NotifyOnTaskClient API を使用すると、次のことができます。  
* カンファレンスの開始
* カンファレンスコールを終了
* 参加者の追加
* 次のような、電話ドライバーから利用可能なアクションを実行します。
  * 参加者をミュート/ミュート解除
  * カンファレンスコールからの参加者の削除
  * カンファレンスへの参加者の追加
  * カンファレンスの開始
  * カンファレンスコールを終了
  {#NotifyOnTaskClient__ul_e5f_pqy_4hb}
{#NotifyOnTaskClient__ul_qvb_kqy_4hb}

通知 (com.snc.notify) プラグインには別のサブスクリプションが必要です。通知プラグインのアクティブ化の詳細については、「 [通知のアクティブ化](https://www.servicenow.com/docs/access?context=t_ActivateNotify&version=australia&pubname=australia-servicenow-platform&ft:locale=en-US)」を参照してください。

## NotifyOnTaskClient - addParticipants(オブジェクトデータ) {#ariaid-title2}

指定された参加者を指定されたカンファレンスに追加します。
{#NClient-addParticipants_O__dataObject-table-NConf__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| データ | オブジェクト | カンファレンスコールを説明するオブジェクト。 |
| data.addToWorkNotes | ブーリアン | カンファレンスコールに含まれた参加者に関する情報を関連レコードの作業メモフィールドに追加するかどうかを示すフラグ。 この機能を機能させるには、 data.table パラメーターと data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、作業メモを追加するレコードを識別します。 デフォルト値：false |
| data.confId | 文字列 | カンファレンスのSys_id。 テーブル:通知カンファレンスコール \[notify_conference_call\] |
| data.items | アレイ | カンファレンスコールに含める各参加者の情報。 "items": [ "email": "String", "id": "String", "notifyParticipantId": "String", "phoneNumber": "String" ] |
| data.items.email | 文字列 | 参加者のメールアドレス。 |
| data.items.id | 文字列 | ユーザー sys_id。 テーブル:ユーザー \[sys_User\] |
| data.items.notifyParticipantId | 文字列 | 参加者のsys_id。 テーブル:参加者に通知 \[notify_participant\] |
| data.items.phoneNumber | 文字列 | 参加者の電話番号。この値が id パラメーターまたは notifyParticipantId パラメーターと一緒に渡される場合、この値はユーザー/参加者レコードの電話番号よりも優先され、コールの発信に使用されます。 |
| data.message | 文字列 | ユーザーがコールに応答したときに読み上げられるメッセージ (例:「P1 インシデントが作成されました。インスタンスにログインしてください」など)。 |
| data.serviceProvider | 文字列 | 必須です。Zoom や Webex などの会議サービスプロバイダーの名前。 |
| data.sysId | 文字列 | カンファレンスコールに関連付けるソースレコードのSys_id。 たとえば、特定のインシデントまたは問題について話し合うためにカンファレンスが開催される場合は、インシデントまたは問題レコードのsys_idをこの値に入力します。このsys_idは、NotifyConference Call \[notify_conference_call\] テーブルの \[ソース\] 列に保存され、後で追跡できます。 このパラメーターは、 data.Table、 data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用します。 この値は、カンファレンスが最初に「開始」アクションによって作成されるときに設定する必要があります。必要に応じて、このメソッドを使用してこの値を設定することもできます。 |
| data.table | 文字列 | カンファレンスコールに関連付けるソースレコードを含むテーブル。ソースレコードには、「インシデント」や「問題」など、カンファレンスコールでの議論のトピックである任意のレコードを指定できます。 このテーブル名は、NotifyConference Call \[notify_conference_call\] テーブルの \[テーブル\] 列に格納され、追跡できます。 このパラメーターは、 data.sysId、 data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用します。 この値は、カンファレンスが最初に「開始」アクションによって作成されるときに設定する必要があります。必要に応じて、このメソッドを使用してこの値を設定することもできます。 |
[表 : 1. パラメーター]

{#NClient-addParticipants_O__dataObject-table-NConf} {#NClient-addParticipants_O__table_rpj_1y5_nhb__entry__2}

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

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

    function addToConferenceCall() {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
        data.confId = 'Active conference sysId';
        data.items.push({ id: 'userSysId' });
        data.items.push({ phoneNumber: '+917799555331' });
        data.items.push({ email: 'yln99518@gmail.com' });

        NotifyOnTaskClient.addParticipants(data).then(function (result) {
            var joinActionResult = result[0];
            if(joinActionResult.status) {
                joinActionResult.successMessages.forEach(function(msg) {
                    console.log(msg);
                });
                return;
            }

            joinActionResult.warnMessages.forEach(function(msg) {
                console.warn(msg);
            });
            joinActionResult.errorMessages.forEach(function(msg) {
                console.error(msg);
            });
        }, function (errMsg) {
            console.log(errMsg);
        });
    }

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

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

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

{#NClient-doConferenceAction_S_O__table_qqs_vdv_nhb} {#NClient-doConferenceAction_S_O__table_rqs_vdv_nhb__entry__2}

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

{#NClient-doConferenceAction_S_O__table_rqs_vdv_nhb}  
次の例は、doConferenceAction() を呼び出して、アクションと参加者を渡してカンファレンスの参加者を操作する関数を作成する方法を示しています。


    /**
     * 
     * @param {string} action - action to perform on the conference object or participant object
     * @param {Array} participants;
     */
    function doConferenceAction(action, participants) {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
        data.confId = 'Active conference sysId';
        data.items = participants;

        NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {
            var kickActionResult = result[0];
            if (kickActionResult.status)
                console.log(action + ' succeeded');
            else {
                kickActionResult.warnMessages.forEach(function (msg) {
                    console.warn(msg);
                });
                kickActionResult.errorMessages.forEach(function (msg) {
                    console.error(msg);
                });
            }
        }, function (errMsg) {
                console.log(errMsg)
        });
    }

    // kick participants

    doConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);

    // kick multiple participants

    doConferenceAction('multiKick',
        [{notifyParticipantId: 'notifyParticipantSysId'},
        {notifyParticipantId: 'notifyParticipantSysId'}]);

    // Mute participants
    doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
    doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);

    doConferenceAction('multiMute',
        [{notifyParticipantId: 'notifyParticipantSysId'},
        {notifyParticipantId: 'notifyParticipantSysId'}]);

    // self join to any confernece. 
    doConferenceAction('selfJoin', [{id: 'logged in userId'}]);

## NotifyOnTaskClient - endConference(オブジェクトデータ) {#ariaid-title4}

指定されたカンファレンスコールを終了します。
{#NClient-endConference_O__entry__3}{#NClient-endConference_O__data-row-NConf}{#NClient-endConference_O__data.confId-row-NConf}

| 名前 | タイプ | 説明 |
|-|-|-|
| データ | オブジェクト | カンファレンスコールを説明するオブジェクト。 |
| data.confId | 文字列 | カンファレンスのSys_id。 |
| data.serviceProvider | 文字列 | 必須です。Zoom や Webex などの会議サービスプロバイダーの名前。 |
[表 : 5. パラメーター]

{#NClient-endConference_O__table_dqd_qcv_nhb__entry__2}

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

{#NClient-endConference_O__table_dqd_qcv_nhb}  

    function endConferenceCall() {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
        data.confId = 'Active conference sysId';

        NotifyOnTaskClient.endConference(data).then(function (result) {
            var endActionResult = result[0];
            if (endActionResult.status)
                console.log('Conference has been ended');
            else {
                endActionResult.warnMessages.forEach(function (msg) {
                    console.warn(msg);
                });
                endActionResult.errorMessages.forEach(function (msg) {
                    console.error(msg);
                });
            }
        }, function (errMsg) {
            console.log(errMsg);
        });
    }

## NotifyOnTaskClient - getNotifyActionTemplate() {#ariaid-title5}

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

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

{#NClient-getNotifyActionTemplate__table_azh_qyg_nhb} {#NClient-getNotifyActionTemplate__table_c2h_cwd_vhb__entry__2}{#NClient-getNotifyActionTemplate__data.addToWorkNotes-p-NConf}{#NClient-getNotifyActionTemplate__data.allowMulticonference-p-NConf}{#NClient-getNotifyActionTemplate__data.confId-p-NConf}{#NClient-getNotifyActionTemplate__data.fromNumber-p-NConf}{#NClient-getNotifyActionTemplate__data.isNewConference-p-NConf}{#NClient-getNotifyActionTemplate__data.items-p-NConf}{#NClient-getNotifyActionTemplate__data.message-p-NConf}{#NClient-getNotifyActionTemplate__data.serviceProvider-p-NConf}{#NClient-getNotifyActionTemplate__data.sys_id-p-NConf}{#NClient-getNotifyActionTemplate__data.table-p-NConf}

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

{#NClient-getNotifyActionTemplate__table_c2h_cwd_vhb}  
次の例は、getNotifyActionTemplate() を呼び出して、doConferenceAction() のアクションを定義するために必要なデータテンプレートを取得する方法を示しています。


    /**
     * 
     * @param {string} action - action to perform on the conference object or participant object
     * @param {Array} participants;
     */
    function doConferenceAction(action, participants) {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
        data.confId = 'Active conference sysId';
        data.items = participants;

        NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {
            var kickActionResult = result[0];
            if (kickActionResult.status)
                console.log(action + ' succeeded');
            else {
                kickActionResult.warnMessages.forEach(function (msg) {
                    console.warn(msg);
                });
                kickActionResult.errorMessages.forEach(function (msg) {
                    console.error(msg);
                });
            }
        }, function (errMsg) {
                console.log(errMsg)
        });
    }

    // kick participants

    doConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);

    // kick multiple participants

    doConferenceAction('multiKick',
        [{notifyParticipantId: 'notifyParticipantSysId'},
        {notifyParticipantId: 'notifyParticipantSysId'}]);

    // Mute participants
    doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
    doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);

    doConferenceAction('multiMute',
        [{notifyParticipantId: 'notifyParticipantSysId'},
        {notifyParticipantId: 'notifyParticipantSysId'}]);

    // self join to any confernece. 
    doConferenceAction('selfJoin', [{id: 'logged in userId'}]);

## NotifyOnTaskClient - start(オブジェクトデータ) {#ariaid-title6}

新しいカンファレンスコールを開始します。
{#NClient-start_O__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| データ | オブジェクト | カンファレンスコールを説明するオブジェクト。 |
| data.addToWorkNotes | ブーリアン | オプション。カンファレンスコールに含まれた参加者に関する情報を関連レコードの作業メモフィールドに追加するかどうかを示すフラグ。 この機能を機能させるには、 data.table パラメーターと data.sysId パラメーターの値も指定して、作業メモを追加するレコードを識別する必要があります。{#NClient-start_O__data.addToWorkNotes2-p-NConf} デフォルト値：false |
| data.allowMulticonference | ブーリアン | オプション。 特定のレコードに対して一度に複数のカンファレンスコールを許可するかどうかを示すフラグ。 この機能を機能させるには、 data.table パラメーターと data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、複数のカンファレンスコールを持つことが許可されているレコードを識別します。 デフォルト値：false |
| data.fromNumber | 文字列 | 必須です。 カンファレンスコールのためにコールするサービスプロバイダー番号。 通知電話番号 \[notify_number\] テーブルの \[番号\] 列または \[電話番号\] 列で、この値を見つけます。 |
| data.items | アレイ | オプション。 カンファレンスコールに含める各参加者の情報。 "items": [ "email": "String", "id": "String", "notifyParticipantId": "String", "phoneNumber": "String" ] |
| data.items.email | 文字列 | 参加者のメールアドレス。 |
| data.items.id | 文字列 | ユーザー sys_id。 テーブル:ユーザー \[sys_User\] |
| data.items.notifyParticipantId | 文字列 | 参加者のsys_id。 テーブル:参加者に通知 \[notify_participant\] |
| data.items.phoneNumber | 文字列 | 参加者の電話番号。この値が id パラメーターまたは notifyParticipantId パラメーターと一緒に渡される場合、この値はユーザー/参加者レコードの電話番号よりも優先され、コールの発信に使用されます。 |
| data.message | 文字列 | オプション。 ユーザーがコールに応答したときに読み上げられるメッセージ (例:「P1 インシデントが作成されました。インスタンスにログインしてください」など)。 |
| data.serviceProvider | 文字列 | 必須です。Zoom や Webex などの会議サービスプロバイダーの名前。 |
| data.sysId | 文字列 | オプション。 カンファレンスコールに関連付けるソースレコードのSys_id。 たとえば、特定のインシデントまたは問題について話し合うためにカンファレンスが開催される場合は、インシデントまたは問題レコードのsys_idをこの値に入力します。このsys_idは、NotifyConference Call \[notify_conference_call\] テーブルの \[ソース\] 列に保存され、後で追跡できます。 このパラメーターは、 data.Table、 data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用します。 |
| data.table | 文字列 | オプション。 カンファレンスコールに関連付けるソースレコードを含むテーブル。ソースレコードには、「インシデント」や「問題」など、カンファレンスコールでの議論のトピックである任意のレコードを指定できます。 このテーブル名は、NotifyConference Call \[notify_conference_call\] テーブルの \[テーブル\] 列に格納され、追跡できます。 このパラメーターは、 data.sysId、 data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用します。 |
[表 : 9. パラメーター]

{#NClient-start_O__table_jrr_133_nhb__entry__2}

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

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

    function startConferenceCall() {
        var data = NotifyOnTaskClient.getNotifyActionTemplate();
        data.table = 'incident';
        data.sysId = '1234';
        data.serviceProvider = serviceProvider;
        data.addToWorkNotes = true;
        data.fromNumber = 'Telephony Number';
        data.items.push({ id: 'userSysId' });
        data.items.push({ phoneNumber: '+917799555332' });
        data.items.push({ email: 'yln99517@gmail.com' });

        NotifyOnTaskClient.start(data).then(function (result) {
            var startActionResult = result[0];
            if(startActionResult.status) {
                startActionResult.successMessages.forEach(function(msg) {
                    console.log(msg);
                });
                return;
            }

            startActionResult.warnMessages.forEach(function(msg) {
                console.warn(msg);
            });
            startActionResult.errorMessages.forEach(function(msg) {
                console.error(msg);
            });
        }, function (errMsg) {
            console.log(errMsg);
        });
    }