1. index
  2. 監視
  3. 設定
  4. コマンド
  5. その他

twilioSms オブジェクト

twilioSmsオブジェクトは、X-MONのTwilio SMS通知設定を操作するオブジェクトです。

twilio_sms.getTwilio SMS通知設定の取得

twilio_sms.getは、Twilio SMS通知設定を取得するためのメソッドです。

対応X-MONバージョン
  • 3.9.0 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

リクエストパラメータ

このメソッドにはパラメータは不要です。

レスポンスカラム

カラム名称 概要
id

Twilio SMS通知設定 ID

alias

Twilio SMS通知設定 名称

account_id

Twilio アカウント ID

from_number

Twilio 電話番号 (From)

contact_name

宛先のユーザID

message_type

メッセージの種類:default1、default2、input のいずれかです。

message

message_typeが「input」の場合の、指定したメッセージ内容です。

twilio_sms.addTwilio SMS通知設定の追加

twilio_sms.addは、Twilio SMS通知設定を追加するためのメソッドです。

対応X-MONバージョン
  • 3.9.0 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称 概要
alias 必須 string

Twilio SMS通知設定 名称を指定します。

account_id 必須 string

Twilio アカウント IDを指定します。

from_number 必須 string

指定したTwilio アカウント IDのTwilio 電話番号を指定します。

電話番号は「+81」のような形式で始まる必要があります。

contact_name 必須 array

宛先の電話番号 (To)としてユーザIDを指定します。

指定するユーザは連絡先電話番号が設定されている必要があります。

message_type string

メッセージの種類:default1、default2、input のいずれかを指定します。

省略時には、「default1」になります。

message string

message_typeに「input」を指定する場合、メッセージの内容を指定します。

approve boolean

このリクエストを即座に反映するかどうかを指定します。

省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

twilio_sms.updateTwilio SMS通知設定の編集

twilio_sms.updateは、Twilio SMS通知設定を編集するためのメソッドです。

対応X-MONバージョン
  • 3.9.0 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称 概要
id 必須 string

Twilio SMS通知設定 IDを指定します。

alias string

Twilio SMS通知設定 名称を指定します。

account_id string

Twilio アカウント IDを指定します。

from_number string

指定したTwilio アカウント IDのTwilio 電話番号を指定します。

電話番号は「+81」のような形式で始まる必要があります。

contact_name array

宛先の電話番号 (To)としてユーザIDを指定します。

指定するユーザは連絡先電話番号が設定されている必要があります。

message_type string

メッセージの種類:default1、default2、input のいずれかを指定します。

message string

message_typeに「input」を指定する場合、メッセージの内容を指定します。

approve boolean

このリクエストを即座に反映するかどうかを指定します。

省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

twilio_sms.deleteTwilio SMS通知設定の削除

twilio_sms.deleteは、Twilio SMS通知設定を削除するためのメソッドです。

対応X-MONバージョン
  • 3.9.0 以降
必要ユーザ権限
  • システム管理者
  • 運用責任者
  • オペレータ
  • 閲覧者
  • 通知ユーザ

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称 概要
id 必須 string

Twilio SMS通知設定 IDを指定します。

approve boolean

このリクエストを即座に反映するかどうかを指定します。

省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。