NotifyJsTelephonyDriver - グローバル

Yokohama API リファレンス

Release

yokohama

ft:locale

ja-JP

ft:publication_title

Yokohama API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

NotifyJsTelephonyDriver - グローバル

リリースバージョン: Yokohama

更新日 2025年01月30日

所要時間：19分

NotifyJsTelephonyDriver API は、関連付けられた電話通信ドライバーの機能に関する情報を取得するために使用できるメソッドを提供します。

これはスクリプト化された拡張ポイントであり、オブジェクトが別のメソッド ( NotifyUtil - getTelephonyDriverFromNotifyNumber() など) によって返された場合にのみ使用できます。この API を直接呼び出すことはできません。呼び出し元メソッドは、特定のドライバーをインターフェイスに関連付け、ドライバーを決定する詳細を抽象化します。使用可能な各ドライバーは、 NotifyJsTelephonyDriver API によって定義されている同じインターフェイスを実装しています。

次のコード例では、 getTelephonyDriverFromNotifyNumber() メソッドがこの API の実装を返します。ドライバーインターフェイスは、TwilioNotifyJsTelephonyDriver などの渡された電話番号によって決定されます。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        driverName: driver.getName(),
        supportsCall: driver.supportsCall(),
        supportsSMS: driver.supportsSms()
      } 
    }
}

NotifyJsTelephonyDriver 拡張ポイントに関連付けられているドライバーを確認するには、[ システム拡張ポイント]>global に移動します。NotifyJsTelephonyDriver です。関連するすべてのドライバー実装が [ 実装 ] タブに表示されます。

スクリプト化された拡張ポイントの詳細については、「拡張ポイントを使用したアプリケーション機能ポイントの拡張」を参照してください。

この API を使用するには、通知 (com.snc.notify) プラグインを有効にする必要があります。Twillo などの特定のドライバー実装をアクティブ化するには、その特定のプラグインをアクティブ化する必要があります。

NotifyJsTelephonyDriver - call(オブジェクト notifyPhoneNumber, 文字列 phoneNumber)

指定された電話番号に電話をかけます。

表 : 1. パラメーター
名前	タイプ	説明
notifyPhoneNumber	NotifyPhoneNumber - グローバル	コールの発信元である通知電話番号が含まれている NotifyPhoneNumber レコード。テーブル:通知電話番号 [notify_number] テーブル。
toPhoneNumber	文字列	発信先の電話番号。フォーマット:E.164

表 : 2. 戻り値
タイプ	説明
なし

NotifyJsTelephonyDriver - getCapabilities()

テレフォニードライバーの機能のリストを返します。

表 : 3. パラメーター
名前	タイプ	説明
なし

表 : 4. 戻り値
タイプ	説明
なし

この例では、関連付けられているテレフォニードライバーの機能を返します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
       capabilities: driver.getCapabilities()
      } 
    }
}

NotifyJsTelephonyDriver - getMaxSizeForBulkSms(文字列 phoneNumber)

渡された通知電話番号に関連付けられた電話ドライバーが一度に SMS メッセージを送信できる電話番号の最大数を返します。

表 : 5. パラメーター
名前	タイプ	説明
phoneNumber	文字列	関連付けられたドライバーが 1 件の一括 SMS メッセージで送信できる電話番号の最大数を確認するために、電話番号に通知します。

表 : 6. 戻り値
タイプ	説明
番号	1 回の一括 SMS 配信で SMS メッセージを送信できる電話番号の最大数。

この例では、関連付けられた電話ドライバーの 1 件の一括 SMS メッセージで送信できる電話番号の最大数を返します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
       return {
       maxSmsNumbers: driver.getMaxSizeForBulkSMS(notifyNumber)
      }       
    }
}

NotifyJsTelephonyDriver - getPhoneNumber(文字列 phoneNumber)

指定された電話番号の通知電話番号レコードを返します。

指定された電話番号が通知電話番号 [notify_number] テーブルで見つからない場合は null を返します。

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

表 : 8. 戻り値
タイプ	説明
NotifyPhoneNumberAPI	指定された電話番号に関連付けられた通知電話番号レコード。

この例では、電話ドライバーを取得し、指定された電話番号に関連付けられた通知電話番号レコードを返します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
       phoneNumberRecord: driver.getPhoneNumber(notifyNumber)
      } 
    }
}

NotifyJsTelephonyDriver - getPhoneNumbers()

現在の電話ドライバーに関連付けられているすべての通知電話番号のリストを返します。

表 : 9. パラメーター
名前	タイプ	説明
なし

表 : 10. 戻り値
タイプ	説明
文字列	現在のドライバーに関連付けられているすべての通知電話番号のカンマ区切りリスト。

この例では、テレフォニードライバーを取得し、現在のテレフォニードライバーに関連付けられている通知電話番号のリストを返します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
       phoneNumbers: driver.getPhoneNumbers()
      } 
    }
}

NotifyJsTelephonyDriver - isActive()

現在のテレフォニードライバーがアクティブかどうかを確認します。

表 : 11. パラメーター
名前	タイプ	説明
なし

表 : 12. 戻り値
タイプ	説明
ブール	現在のテレフォニードライバーがアクティブかどうかを示すフラグ。有効な値： true:ドライバーはアクティブです。 false:ドライバーは非アクティブです。

この例では、テレフォニードライバーを取得し、現在のテレフォニードライバーがアクティブかどうかを返します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        active: driver.isActive()
      } 
    }
}

NotifyJsTelephonyDriver - kick(GlideRecord participantRecord)

現在の通知カンファレンスから指定された発信者を削除します。

表 : 13. パラメーター
名前	タイプ	説明
参加者レコード	GlideRecord - グローバル	カンファレンスから削除する発信者の参加者通知 [notify_participant] レコードを含む GlideRecord オブジェクト。

表 : 14. 戻り値
タイプ	説明
文字列	エラーの場合にのみ返されます。発信者がコールから削除されなかった理由を説明するエラーメッセージ。

この例では、現在のカンファレンスコールで関連する発信者をミュートします。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      var notifyParticipantGr = new GlideRecord('notify_participant');
      notifyParticipantGr.get('active participant sys id');
    
      if (notifyParticipantGr.isValid) {
        driver.kick(notifyParticipantGr)
    }
}

NotifyJsTelephonyDriver - ミュート (GlideRecord participantRecord)

現在の通知カンファレンスコールで指定された発信者をミュートします。

表 : 15. パラメーター
名前	タイプ	説明
参加者レコード	GlideRecord - グローバル	カンファレンスコールでミュート状態にする発信者の参加者通知 [notify_participant] レコードを含む GlideRecord オブジェクト。

表 : 16. 戻り値
タイプ	説明
文字列	エラーの場合にのみ返されます。発信者がミュートされなかった理由を説明するエラーメッセージ。

この例では、現在のカンファレンスコールで関連する発信者をミュートします。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      var notifyParticipantGr = new GlideRecord('notify_participant');
      notifyParticipantGr.get('active participant sys id');
    
      if (notifyParticipantGr.isValid) {
        driver.mute(notifyParticipantGr)
    }
}

NotifyJsTelephonyDriver - sendAutonomousBulkSms(Object notifyPhoneNumber, Array toPhoneNumber, String message, GlideRecord source)

指定された電話番号のリストに、指定されたショートメッセージサービス (SMS) メッセージを送信します。

さらに、オプションで、SMS メッセージを生成する原因となったインシデントレコードを SMS メッセージに関連付けることができます。

表 : 17. パラメーター
名前	タイプ	説明
メッセージ	文字列	送信するメッセージ。
notifyPhoneNumber	NotifyPhoneNumber - グローバル	一括 SMS メッセージを送信する電話番号を含むレコード。
ソース	GlideRecord - グローバル	オプション。通知メッセージ [notify message] テーブルの関連する SMS メッセージレコードの [ソース] フィールドに保存するインシデント GlideRecord。これにより、SMS メッセージ生成の原因となったインシデントレコードがその SMS メッセージにリンクされます。デフォルト:なし。このパラメーターが渡されない場合、この情報は追跡されません。
toPhoneNumber	アレイ	SMS メッセージを受信するデバイスの電話番号のリスト。

表 : 18. 戻り値
タイプ	説明
なし

この例では、自律的な一括 SMS を送信する方法を示します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {

    }
}

NotifyJsTelephonyDriver - sendSMS(NotifyPhoneNumber notifyPhoneNumber, String toPhoneNumber, String messageBody)

指定されたショートメッセージサービス (SMS) メッセージを指定された電話番号に送信します。

表 : 19. パラメーター
名前	タイプ	説明
notifyPhoneNumber	NotifyPhoneNumber - グローバル	SMS メッセージを送信している電話番号が含まれている通知電話番号レコード。テーブル:通知電話番号 [notify_number]
toPhoneNumber	文字列	SMS メッセージの送信先の電話番号。フォーマット:E.164準拠
メッセージ	文字列	SMS メッセージで送信するテキスト。

表 : 20. 戻り値
タイプ	説明
なし

NotifyJsTelephonyDriver - supportsAutonomousBulkSms(文字列 phoneNumber)

指定された通知電話番号が自律的な一括ショートメッセージサービス (SMS) メッセージを処理できるかどうかを確認します。

表 : 21. パラメーター
名前	タイプ	説明
なし

表 : 22. 戻り値
タイプ	説明
ブール	指定された通知電話番号が自律一括 SMS をサポートしているかどうかを示すフラグ。有効な値： true:自律型一括 SMS をサポートします。 false:自律一括 SMS をサポートしません。

この例では、テレフォニードライバーを取得し、ドライバーが自律的な一括 SMS をサポートしているかどうかを返します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        supportsBulkSMS: driver.supportsAutonomousBulkSms(notifyNumber)
      } 
    }
}

NotifyJsTelephonyDriver - supportsCall()

現在の電話ドライバーが電話を処理できるかどうかを確認します。

表 : 23. パラメーター
名前	タイプ	説明
なし

表 : 24. 戻り値
タイプ	説明
ブール	現在の電話ドライバーが電話をサポートしているかどうかを示すフラグ。有効な値： true: ドライバーは電話をサポートします。 false:ドライバーは電話をサポートしていません。

この例では、テレフォニードライバーを取得し、ドライバーが電話をサポートしているかどうかを返します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        supportsCall: driver.supportsCall()
      } 
    }
}

NotifyJsTelephonyDriver - supportsCallOverWebRtc()

指定された通知電話番号が WebRTC (リアルタイム通信) を使用してブラウザを呼び出すことができるかどうかを確認します。

表 : 25. パラメーター
名前	タイプ	説明
なし

表 : 26. 戻り値
タイプ	説明
ブール	指定された通知電話番号が WebRTC を使用したブラウザ呼び出しをサポートしているかどうかを示すフラグ。有効な値： true:WebRTC をサポートします。 false:WebRTC をサポートしません。

この例では、テレフォニードライバーを取得し、ドライバーが WebRTC を使用したブラウザー呼び出しをサポートしているかどうかを返します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        supportsWebRTC: driver.supportsCallOverWebRtc(notifyNumber)
      } 
    }
}

NotifyJsTelephonyDriver - supportsSMS()

現在のテレフォニードライバーがショートメッセージサービス (SMS) メッセージを処理できるかどうかを確認します。

表 : 27. パラメーター
名前	タイプ	説明
なし

表 : 28. 戻り値
タイプ	説明
ブール	現在のテレフォニードライバーが SMS をサポートしているかどうかを示すフラグ。有効な値： true:ドライバーは SMS をサポートします。 false:ドライバーは SMS をサポートしていません。

この例では、テレフォニードライバーを取得し、ドライバーが SMS をサポートしているかどうかを返します。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      return {
        supportsSMS: driver.supportsSMS()
      } 
    }
}

NotifyJsTelephonyDriver - unmute(GlideRecord participantRecord)

現在の通知カンファレンスコールで指定された発信者のミュート状態を解除します。

表 : 29. パラメーター
名前	タイプ	説明
参加者レコード	GlideRecord - グローバル	カンファレンスコールでミュート状態にする発信者の参加者通知 [notify_participant] レコードを含む GlideRecord オブジェクト。

表 : 30. 戻り値
タイプ	説明
文字列	エラーの場合にのみ返されます。発信者がミュートされなかった理由を説明するエラーメッセージ。

この例では、現在のカンファレンスコールで関連する発信者をミュートします。

getDriverDetails('<notify_number>'); 

function getDriverDetails(notifyNumber) {
  var nUtil = new NotifyUtil();
  if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
    return;
  var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
    if (driver) {
      var notifyParticipantGr = new GlideRecord('notify_participant');
      notifyParticipantGr.get('active participant sys id');
    
      if (notifyParticipantGr.isValid) {
        driver.unmute(notifyParticipantGr)
    }
}