--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # NotifyOnTaskClient - クライアント # NotifyOnTaskClient - クライアント {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：30分 NotifyOnTaskClient API は、Zoom や Webex などのさまざまなテレフォニーサービスプロバイダーに対して、SMS メッセージを送信したり、電話会議を開始/管理したりするためのメソッドを提供します。 NotifyOnTaskClient UI スクリプトを明示的に含めることで、どの UI でも NotifyOnTaskClient API を使用できます。 NotifyOnTaskClient API を使用すると、次のことが可能になります。 * 電話会議の開始 * 電話会議を終了 * 参加者の追加 * 電話通信ドライバーで可能な以下のアクションの実行 * 参加者をミュート/ミュート解除する * 電話会議から参加者を除外する * 電話会議に参加者を追加する * 電話会議を開始する * 電話会議を終了する {#NotifyOnTaskClient__ul_e5f_pqy_4hb} {#NotifyOnTaskClient__ul_qvb_kqy_4hb} Notify (com.snc.notify) プラグインには個別のサブスクリプションが必要です。通知プラグインのアクティブ化の詳細については、「 [通知のアクティブ化](https://www.servicenow.com/docs/access?context=t_ActivateNotify&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)」を参照してください。 ## NotifyOnTaskClient - addParticipants(オブジェクト data) {#ariaid-title2} 指定された参加者を指定された電話会議に追加します。 {#NClient-addParticipants_O__dataObject-table-NConf__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | data | オブジェクト | 電話会議を説明するオブジェクト。 | | data.addToWorkNotes | ブーリアン | 関連するレコードの作業メモフィールドに電話会議に含まれた参加者に関する情報を追加するかどうかを示すフラグ。 この機能を動作させるには、data.table および data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、作業メモを追加するレコードを識別します。 デフォルト値：false | | data.confId | 文字列 | 必須です。 電話会議の sys ID。 会議の sys ID は Notify 電話会議 \[notify_conference_call\] テーブルにあります。 | | data.items | アレイ | 必須です。 電話会議に含める各参加者に関する情報。 有効なアレイ値： * id：ユーザーのSys ID。ユーザー \[sys_User\] テーブルにあります。 * notifyParticipantId：参加者のSys ID。Notify 参加者 \[notify_participant\] テーブルにあります。 * phoneNumber：参加者の電話番号。この値が id または notifyParticipantId とともに渡された場合、この値はユーザー/参加者レコードの電話番号より優先され、通話を発信するために使用されます。 * email：参加者のメールアドレス。 {#NClient-addParticipants_O__ul_qzh_pqt_rhb} | | data.message | 文字列 | ユーザーがコールに応答したときに読み上げられるメッセージ (「P1 インシデントが作成されました。インスタンスにログインしてください」など)。 | | data.serviceProvider | 文字列 | 必須です。Zoom や Webex などの会議サービスプロバイダーの名前。 | | data.sysId | 文字列 | 電話会議に関連付けるソースレコードの Sys ID。 たとえば、特定のインシデントまたは問題について話し合うために電話会議が行われる場合は、インシデントまたは問題レコードの Sys ID をこの値に入力します。この Sys ID は NotifyConference コール \[notify_conference_call\] テーブルの \[Source\] 列に保存され、後で追跡できます。 このパラメーターは、data.Table、data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用されます。 この値は、「開始」アクションを使用して最初に電話会議を作成するときに設定する必要があります。必要に応じて、このメソッドを使用して値を設定することもできます。 | | data.table | 文字列 | 電話会議に関連付けるソースレコードのを含むテーブル。ソースレコードは、「インシデント」や「問題」など、電話会議でのディスカッションのトピックである任意のレコードです。 このテーブル名は NotifyConference コール \[notify_conference_call\] テーブルの \[Table\] 列に保存され、追跡できます。 このパラメーターは、data.sysId、data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用されます。 この値は、「開始」アクションを使用して最初に電話会議を作成するときに設定する必要があります。必要に応じて、このメソッドを使用して値を設定することもできます。 | [表 : 1. パラメーター] {#NClient-addParticipants_O__dataObject-table-NConf} {#NClient-addParticipants_O__table_rpj_1y5_nhb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | 会議アクションの結果。 `.status`：会議アクションのステータス。 * データタイプ：ブール * 有効な値： * true：会議アクションが成功しました * false：会議アクションに失敗しました {#NClient-addParticipants_O__ul_w5y_hyt_b3b} {#NClient-addParticipants_O__ul_psg_gyt_b3b} `.successMessages`：ステータス が true の場合は成功メッセージ、それ以外の場合は空です。 * データタイプ：文字列のアレイ {#NClient-addParticipants_O__ul_qm2_myt_b3b} `.warnMessages`： ステータスが false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NClient-addParticipants_O__ul_xbz_nyt_b3b} `.errorMessages`： ステータスが 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(文字列 action, オブジェクト data) {#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} | 名前 | タイプ | 説明 | |-|-|-| | action | 文字列 | 実行する電話会議アクションを定義します。 利用可能な電話会議アクションは次のとおりです。 * start：data.confId で識別された電話会議を開始します。 * end：data.confId で識別された電話会議を終了します。 * join：data.items アレイで指定された参加者を data.confId で識別された電話会議に追加します。 * multiJoin：data.items アレイで指定された複数の参加者を data.confId で識別された電話会議に追加します。 * selfJoin：現在ログインしているユーザーを電話会議に追加します (data.items のエントリは必要ありません) * kick：data.items アレイで指定された参加者を data.confId で識別された電話会議から削除します。 * multiKick：data.items アレイで指定された複数の参加者を data.confId で識別された電話会議から削除します。 * mute：data.items アレイで指定された参加者を data.confId で識別された電話会議でミュートします。 * multiMute：data.items アレイで指定された複数の参加者を data.confId で識別された電話会議でミュートします。 * unmute：data.items アレイで指定された参加者を data.confId で識別された電話会議でミュート状態を解除します。 * multiUnmute：data.items アレイで指定された複数の参加者を data.confId で識別された電話会議でミュート状態を解除します。 {#NClient-doConferenceAction_S_O__ul_pq5_qfv_nhb} | | data | オブジェクト | 電話会議を説明するオブジェクト。 | | data.addToWorkNotes | ブール | 関連するレコードの作業メモフィールドに電話会議に含まれた参加者に関する情報を追加するかどうかを示すフラグ。 この機能を動作させるには、data.table および data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、作業メモを追加するレコードを識別します。{#NClient-doConferenceAction_S_O__data.addToWorkNotes2-p-NConf} デフォルト値：false このパラメーターが有効なアクション： * start * join * multiJoin * selfJoin {#NClient-doConferenceAction_S_O__ul_kwg_ktx_vhb} | | data.allowMulticonference | ブール | 特定のレコードに対して一度に複数の電話会議を許可するかどうかを示すフラグ。 この機能を動作させるには、data.table および data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、複数の電話会議を許可されているレコードを識別します。{#NClient-doConferenceAction_S_O__data.allowMulticonference2-p-NConf} デフォルト値：false このパラメーターが有効なアクション： * start {#NClient-doConferenceAction_S_O__ul_ay4_mtx_vhb} | | data.confId | 文字列 | 電話会議の sys ID。 会議の sys ID は Notify 電話会議 \[notify_conference_call\] テーブルにあります。{#NClient-doConferenceAction_S_O__data.confId2-p-NConf} このパラメーターが必要なアクション： * end * join * multiJoin * selfJoin {#NClient-doConferenceAction_S_O__ul_afs_qsx_vhb} 注: ミュート、ミュート解除、除外などの参加者アクションでは、メソッドが Notify 電話会議参加者 \[notify_participant\] テーブルからこの情報を取得するために、このパラメーターを設定する必要はありません。 | | data.fromNumber | 文字列 | 電話会議のために呼び出すサービスプロバイダーの番号。 この値は、Notify 電話番号 \[notify_number\] テーブルの \[Number\] または \[ Phone number\] 列で見つけます。{#NClient-doConferenceAction_S_O__data.fromNumber2-p-NConf} このパラメーターが必要なアクション： * start {#NClient-doConferenceAction_S_O__ul_exs_stx_vhb} | | data.isNewConference | ブール | 新規の電話会議か既存の電話会議かを示すフラグ。 有効な値： * true：新規の電話会議 * false：既存の電話会議 {#NClient-doConferenceAction_S_O__ul_q1m_wbv_nhb} デフォルト値：false このパラメーターが有効なアクション： * start {#NClient-doConferenceAction_S_O__ul_d1d_stx_vhb} | | data.message | 文字列 | ユーザーがコールに応答したときに読み上げられるメッセージ (「P1 インシデントが作成されました。インスタンスにログインしてください」など)。 このパラメーターが有効なアクション： * start * join * multiJoin {#NClient-doConferenceAction_S_O__ul_jnl_ntx_vhb} | | data.items | アレイ | 電話会議に含める各参加者に関する情報。 有効なアレイ値： * id：ユーザーの sys ID。ユーザー \[sys_User\] テーブルにあります。有効なアクション：join、multiJoin、start * notifyParticipantId：Notify 参加者の Sys ID。Notify 参加者 \[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 コール \[notify_conference_call\] テーブルの \[Source\] 列に保存され、後で追跡できます。{#NClient-doConferenceAction_S_O__data.sys_id-p2-NConf} このパラメーターは、data.Table、data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用されます。{#NClient-doConferenceAction_S_O__data.sys_id-p3-NConf} このパラメーターが有効なアクション： * start {#NClient-doConferenceAction_S_O__ul_h3l_qsx_vhb} | | data.table | 文字列 | 電話会議に関連付けるソースレコードのを含むテーブル。ソースレコードは、「インシデント」や「問題」など、電話会議でのディスカッションのトピックである任意のレコードです。 このテーブル名は NotifyConference コール \[notify_conference_call\] テーブルの \[Table\] 列に保存され、追跡できます。{#NClient-doConferenceAction_S_O__data.table-p2-NConf} このパラメーターは、data.sysId、data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用されます。{#NClient-doConferenceAction_S_O__data.table-p3-NConf} このパラメーターが有効なアクション： * start {#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} | タイプ | 説明 | |-|-| | オブジェクト | 会議アクションの結果。 `.status`：会議アクションのステータス。 * データタイプ：ブール * 有効な値： * true：会議アクションが成功しました * false：会議アクションに失敗しました {#NClient-doConferenceAction_S_O__ul_w5y_hyt_b3b} {#NClient-doConferenceAction_S_O__ul_psg_gyt_b3b} `.successMessages`：ステータス が true の場合は成功メッセージ、それ以外の場合は空です。 * データタイプ：文字列のアレイ {#NClient-doConferenceAction_S_O__ul_qm2_myt_b3b} `.warnMessages`： ステータスが false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NClient-doConferenceAction_S_O__ul_xbz_nyt_b3b} `.errorMessages`： ステータスが 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(オブジェクト data) {#ariaid-title4} 指定された電話会議を終了します。 {#NClient-endConference_O__entry__3}{#NClient-endConference_O__data-row-NConf}{#NClient-endConference_O__data.confId-row-NConf} | 名前 | タイプ | 説明 | |-|-|-| | data | オブジェクト | 電話会議を説明するオブジェクト。 | | data.confId | 文字列 | 電話会議の sys ID。 | | data.serviceProvider | 文字列 | 必須です。Zoom や Webex などの会議サービスプロバイダーの名前。 | [表 : 5. パラメーター] {#NClient-endConference_O__table_dqd_qcv_nhb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | 会議アクションの結果。 `.status`：会議アクションのステータス。 * データタイプ：ブール * 有効な値： * true：会議アクションが成功しました * false：会議アクションに失敗しました {#NClient-endConference_O__ul_w5y_hyt_b3b} {#NClient-endConference_O__ul_psg_gyt_b3b} `.successMessages`：ステータス が true の場合は成功メッセージ、それ以外の場合は空です。 * データタイプ：文字列のアレイ {#NClient-endConference_O__ul_qm2_myt_b3b} `.warnMessages`： ステータスが false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NClient-endConference_O__ul_xbz_nyt_b3b} `.errorMessages`： ステータスが 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/SBE0B3Er3was~vW9nWZWkA#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 | 電話会議を説明するオブジェクト。 | | data.addToWorkNotes | 関連するレコードの作業メモフィールドに電話会議に含まれた参加者に関する情報を追加するかどうかを示すフラグ。 この機能を動作させるには、data.table および data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、作業メモを追加するレコードを識別します。{#NClient-getNotifyActionTemplate__data.addToWorkNotes2-p-NConf} デフォルト値：false このパラメーターが有効なアクション： * start * join * multiJoin * selfJoin {#NClient-getNotifyActionTemplate__ul_kwg_ktx_vhb} | | data.allowMultconference | 特定のレコードに対して一度に複数の電話会議を許可するかどうかを示すフラグ。 この機能を動作させるには、data.table および data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、複数の電話会議を許可されているレコードを識別します。{#NClient-getNotifyActionTemplate__data.allowMulticonference2-p-NConf} デフォルト値：false このパラメーターが有効なアクション： * start {#NClient-getNotifyActionTemplate__ul_ay4_mtx_vhb} | | data.confId | 電話会議の sys ID。 会議の sys ID は Notify 電話会議 \[notify_conference_call\] テーブルにあります。{#NClient-getNotifyActionTemplate__data.confId2-p-NConf} このパラメーターが必要なアクション： * end * join * multiJoin * selfJoin {#NClient-getNotifyActionTemplate__ul_afs_qsx_vhb} 注: ミュート、ミュート解除、除外などの参加者アクションでは、メソッドが Notify 電話会議参加者 \[notify_participant\] テーブルからこの情報を取得するために、このパラメーターを設定する必要はありません。 | | data.fromNumber | 電話会議のために呼び出すサービスプロバイダーの番号。 この値は、Notify 電話番号 \[notify_number\] テーブルの \[Number\] または \[ Phone number\] 列で見つけます。{#NClient-getNotifyActionTemplate__data.fromNumber2-p-NConf} このパラメーターが必要なアクション： * start {#NClient-getNotifyActionTemplate__ul_exs_stx_vhb} | | data.isNewConference | 新規の電話会議か既存の電話会議かを示すフラグ。 有効な値： * true：新規の電話会議 * false：既存の電話会議 {#NClient-getNotifyActionTemplate__ul_q1m_wbv_nhb} デフォルト値：false このパラメーターが有効なアクション： * start {#NClient-getNotifyActionTemplate__ul_d1d_stx_vhb} | | data.items | 電話会議に含める各参加者に関する情報。 有効なアレイ値： * id：ユーザーの sys ID。ユーザー \[sys_User\] テーブルにあります。有効なアクション：join、multiJoin、start * notifyParticipantId：Notify 参加者の Sys ID。Notify 参加者 \[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 インシデントが作成されました。インスタンスにログインしてください」など)。 このパラメーターが有効なアクション： * start * join * multiJoin {#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 コール \[notify_conference_call\] テーブルの \[Source\] 列に保存され、後で追跡できます。{#NClient-getNotifyActionTemplate__data.sys_id-p2-NConf} このパラメーターは、data.Table、data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用されます。{#NClient-getNotifyActionTemplate__data.sys_id-p3-NConf} このパラメーターが有効なアクション： * start {#NClient-getNotifyActionTemplate__ul_h3l_qsx_vhb} | | data.table | 電話会議に関連付けるソースレコードのを含むテーブル。ソースレコードは、「インシデント」や「問題」など、電話会議でのディスカッションのトピックである任意のレコードです。 このテーブル名は NotifyConference コール \[notify_conference_call\] テーブルの \[Table\] 列に保存され、追跡できます。{#NClient-getNotifyActionTemplate__data.table-p2-NConf} このパラメーターは、data.sysId、data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用されます。{#NClient-getNotifyActionTemplate__data.table-p3-NConf} このパラメーターが有効なアクション： * start {#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(オブジェクト data) {#ariaid-title6} 新しい電話会議を開始します。 {#NClient-start_O__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | data | オブジェクト | 電話会議を説明するオブジェクト。 | | data.addToWorkNotes | ブーリアン | オプション。関連するレコードの作業メモフィールドに電話会議に含まれた参加者に関する情報を追加するかどうかを示すフラグ。 この機能を動作させるには、data.table および data.sysId パラメーターに値を指定して、作業メモを追加するレコードを特定する必要があります。{#NClient-start_O__data.addToWorkNotes2-p-NConf} デフォルト値：false | | data.allowMulticonference | ブーリアン | オプション。 特定のレコードに対して一度に複数の電話会議を許可するかどうかを示すフラグ。 この機能を動作させるには、data.table および data.sysId パラメーターにも値を指定する必要があります。これらのパラメーターは、複数の電話会議を許可されているレコードを識別します。 デフォルト値：false | | data.fromNumber | 文字列 | 必須です。 電話会議のために呼び出すサービスプロバイダーの番号。 この値は、Notify 電話番号 \[notify_number\] テーブルの \[Number\] または \[ Phone number\] 列で見つけます。 | | data.items | アレイ | オプション。 電話会議に含める各参加者に関する情報。 有効なアレイ値： * id：ユーザーのSys ID。ユーザー \[sys_User\] テーブルにあります。 * notifyParticipantId：参加者のSys ID。Notify 参加者 \[notify_participant\] テーブルにあります。 * phoneNumber：参加者の電話番号。この値が id または notifyParticipantId とともに渡された場合、この値はユーザー/参加者レコードの電話番号より優先され、通話を発信するために使用されます。 * email：参加者のメールアドレス。 {#NClient-start_O__ul_qzh_pqt_rhb} | | data.message | 文字列 | オプション。 ユーザーがコールに応答したときに読み上げられるメッセージ (「P1 インシデントが作成されました。インスタンスにログインしてください」など)。 | | data.serviceProvider | 文字列 | 必須です。Zoom や Webex などの会議サービスプロバイダーの名前。 | | data.sysId | 文字列 | オプション。 電話会議に関連付けるソースレコードの Sys ID。 たとえば、特定のインシデントまたは問題について話し合うために電話会議が行われる場合は、インシデントまたは問題レコードの Sys ID をこの値に入力します。この Sys ID は NotifyConference コール \[notify_conference_call\] テーブルの \[Source\] 列に保存され、後で追跡できます。 このパラメーターは、data.Table、data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用されます。 | | data.table | 文字列 | オプション。 電話会議に関連付けるソースレコードのを含むテーブル。ソースレコードは、「インシデント」や「問題」など、電話会議でのディスカッションのトピックである任意のレコードです。 このテーブル名は NotifyConference コール \[notify_conference_call\] テーブルの \[Table\] 列に保存され、追跡できます。 このパラメーターは、data.sysId、data.addToWorkNotes、および allowMulticonference パラメーターと組み合わせて使用されます。 | [表 : 9. パラメーター] {#NClient-start_O__table_jrr_133_nhb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | 会議アクションの結果。 `.status`：会議アクションのステータス。 * データタイプ：ブール * 有効な値： * true：会議アクションが成功しました * false：会議アクションに失敗しました {#NClient-start_O__ul_w5y_hyt_b3b} {#NClient-start_O__ul_psg_gyt_b3b} `.successMessages`：ステータス が true の場合は成功メッセージ、それ以外の場合は空です。 * データタイプ：文字列のアレイ {#NClient-start_O__ul_qm2_myt_b3b} `.warnMessages`： ステータスが false の場合、処理中にスローされた警告メッセージ。 * データタイプ：文字列のアレイ {#NClient-start_O__ul_xbz_nyt_b3b} `.errorMessages`： ステータスが 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); }); }