NotifyJTelephoneDriver - グローバル

Xanadu API リファレンス

Release

xanadu

ft:locale

ja-JP

ft:publication_title

Xanadu API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

NotifyJTelephoneDriver - グローバル

リリースバージョン: Xanadu

更新日 2024年08月01日

所要時間：20分

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

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

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

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()
      } 
    }
}

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

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

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

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

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

表 : 1. パラメーター
名前	タイプ	説明
notifyPhoneNumber	NotifyPhoneNumber - グローバル	発信元の Notify 電話番号を含む NotifyPhoneNumber レコード。Notify 電話番号 [notify_number] テーブルにあります。
toPhoneNumber	文字列	発信先の電話番号。フォーマット：E.164

表 : 2. 返される内容
タイプ	説明
なし

getDriverDetails('<notify_number>'); 

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

    }
}

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)

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

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

表 : 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 電話番号レコードを返します。

指定された電話番号が Notify 電話番号 [notify_number] テーブルにない場合は null を返します。

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

表 : 8. 返される内容
タイプ	Description (説明)
NotifyPhoneNumberAPI	指定された電話番号に関連付けられた Notify 電話番号レコード。

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

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

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

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

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

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

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)

指定された発信者を現在の Notify 電話会議から除外します。

表 : 13. パラメーター
名前	タイプ	説明
participantRecord	GlideRecord - グローバル	電話会議から除外する発信者の Notify 参加者 [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 - mute(GlideRecord participantRecord)

指定された発信者を現在の Notify 電話会議内でミュートします。

表 : 15. パラメーター
名前	タイプ	説明
participantRecord	GlideRecord - グローバル	電話会議内でミュートする発信者の Notify 参加者 [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(オブジェクト notifyPhoneNumber, アレイ toPhoneNumber, 文字列 message, GlideRecord source)

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

さらに、必要に応じて、SMS メッセージが生成される原因となったインシデントレコードを SMS メッセージに関連付けることもできます。

表 : 17. パラメーター
名前	タイプ	説明
message	文字列	送信するメッセージ。
notifyPhoneNumber	NotifyPhoneNumber - グローバル	一括 SMS メッセージを送信している電話番号を含むレコード。
source	GlideRecord - グローバル	オプション。Notify メッセージ [notify message] テーブル内の関連する SMS メッセージレコードの [ソース] フィールドに格納するインシデントの GlideRecord。これにより、当該の SMS メッセージが生成される原因となったインシデントレコードが SMS メッセージにリンクされます。デフォルト：なし。このパラメーターが渡されない場合、この情報は追跡されません。
toPhoneNumbers	アレイ	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, 文字列 toPhoneNumber, 文字列 messageBody)

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

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

表 : 20. 返される内容
タイプ	説明
なし

この例では、指定された電話番号に 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 - supportsAutonomousBulkSms(文字列 phoneNumber)

指定された Notify 電話番号が自律的な一括 SMS メッセージを処理できるかどうかを確認します。

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

表 : 22. 返される内容
タイプ	説明
ブーリアン	指定された Notify 電話番号が自律的な一括 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()

指定された Notify の電話番号が WebRTC (リアルタイム通信) を使用してブラウザーに発信できるかどうかを確認します。

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

表 : 26. 返される内容
タイプ	説明
ブーリアン	指定された Notify 電話番号が 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)

指定された発信者を現在の Notify 電話会議内でミュート解除します。

表 : 29. パラメーター
名前	タイプ	説明
participantRecord	GlideRecord - グローバル	電話会議内でミュートする発信者の Notify 参加者 [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)
    }
}