TCL IVR API Version 2.0 プログラミング ガイド
情報タグ
情報タグ
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 2MB) | フィードバック

目次

情報タグ

aaa_accounting_last_sent

aaa_avpair

aaa_avpair_exists

aaa_new_guid

cfg_avpair

cfg_avpair_exists

con_all

con_ofleg

evt_aaa_status_info

evt_address_resolve_reject_reason

evt_address_resolve_term_cause

evt_connections

evt_consult_info

evt_dcdigits

evt_dest_handle

evt_digit

evt_digit_duration

evt_disc_iec

evt_disc_rsi

evt_endpoint_addresses

evt_event

evt_facility_id

evt_facility_report

evt_feature_param

evt_feature_report

evt_feature_type

evt_gtd

evt_handoff ani

evt_handoff argstring

evt_handoff dnis

evt_handoff_legs

evt_handoff proto_headers

evt_handoff_string

evt_iscommand_done

evt_last_disconnect_cause

evt_last_event_handle

evt_last_iec

evt_legs

evt_module_handle

evt_module_subevent

evt_module_context

evt_msg

evt_msg_source

evt_params

evt_progress_indication

evt_proto_content

evt_proto_content_type

evt_proto_headers

evt_report ev_transfer_request

evt_redirect_info

evt_service_control

evt_service_control_count

evt_status

evt_status_text

evt_subscription_id

evt_timer_name

evt_transfer_info

evt_vxmlevent

evt_vxmlevent_params

gtd_attr_exists

last_command_handle

leg_all

leg_ani

leg_ani_pi

leg_ani_si

leg_dn_tag

leg_dnis

leg_display_info

leg_guid

leg_incoming

leg_incoming_guid

leg_inconnection

leg_isdid

leg_outgoing

leg_password

leg_proto_headers

leg_rdn

leg_rdn_pi

leg_rdn_si

leg_redirect_cnt

leg_remoteipaddress

leg_remote_media_ip_address

leg_remote_signaling_ip_address

leg_rgn_noa

leg_rgn_npi

leg_rgn_num

leg_rgn_pi

leg_rgn_si

leg_settlement_time

leg_source_carrier_id

leg_subscriber_type

leg_suppress_outgoing_auto_acct

leg_target_carrier_id

leg_tdm_hairpin

leg_type

leg_username

med_backup_server

med_language

med_language_map

med_location

med_total_languages

media_timer_factor

mod_all_handles

mod_handle

mod_handle_service

set iec

subscription_context

subscription_info

subscription_server_ipaddress

sys_version

情報タグ

情報タグは、コール レッグ、イベント、スクリプト、現在の設定、および RADIUS から戻された値に関する情報の取得に使用できる識別子です。


) 情報タグには 1 つまたは複数のパラメータを持つものもあり、このパラメータは取得、設定、変更が行われる情報をより詳細に特定するために使用します。


情報タグは、用途に応じてグループ分けされます。情報タグ ラベルの最初の 3 文字がグループを示します。

aaa--RADIUS 情報

cfg--設定情報

con--接続情報

evt--イベント情報

leg--コール レッグ情報

med--メディア サービス情報

sys--システム情報

この章では、使用可能な情報タグとその情報について記載します。

説明--情報タグの用途の説明。

構文--情報タグの構文。

モード--情報タグが読み取りまたは読み取り/書き込みのいずれであるか。

適用範囲--情報タグを使用できるコンテキスト。一部の情報タグは常時(グローバルに)使用できますが、その他の情報タグは、特定のイベントを受け取ったときだけ有効です。それ以外の状況で情報タグを使用した場合、スクリプトが終了してエラーが出力されます。たとえば、ev_setup_done イベントの処理中に evt_dcdigits を呼び出すことはできません。つまり、leg setup コマンドの実行後、ev_setup_done イベントがまだ戻されないうちに infotag get evt_dcdigits コマンドを実行することはできません。実行した場合、スクリプトが終了してエラーが出力されます。

戻り値のタイプ:infotag get または infotag set コマンドと一緒に使用した場合に情報タグによって戻される情報のタイプ。

ダイレクト マッピング:コマンド(infotag get または infotag set コマンドを除く)によって情報タグを直接使用できるかどうか、また、どのコマンドで使用できるか。


) 情報タグやパラメータを誤って指定した場合や、目的の適用範囲外で情報タグを使用した場合、スクリプトが終了してエラーが出力されます。


aaa_accounting_last_sent

説明

voice-aaa サブシステムから送信された最後のアカウンティング レコードのタイムスタンプを取得します。

構文

infotag get aaa_accounting_last_sent {servertag}

servertag:サーバ(またはサーバ グループ)の識別子。この値は、次の AAA 設定と同様に method-list-name を示します。

aaa accounting connection {default | method-list-name} group group-name

モード

読み取り

適用範囲

servertag の登録が正常に終了したときだけ有効です。

戻り値のタイプ

timestamp

ダイレクト マッピング

なし

aaa_avpair

説明

RADIUS によって戻された AV ペアの値を戻します。

authorize コマンドの終了後、RADIUS サーバによってパラメータが AV ペアで戻された可能性があります。この情報タグを
aaa_avpair_exists と一緒に使用して、パラメータが戻されたことを確認した後、そのパラメータの値を取得します。有効な VSA AV ペアの名前のリストについては、「AV ペアの名前」の表を参照してください。

構文

infotag get aaa_avpair avpair-name

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

RADIUS によって設定または戻される文字列、数字、ブール(1 または 0)などのすべての値

ダイレクト マッピング

なし

aaa_avpair_exists

説明

RADIUS サーバの戻り値の中で一致した AV ペアの数を戻します。

authorize コマンドの終了後、RADIUS サーバによってパラメータが AV ペアとして戻される場合があります。この情報タグを aaa_avpair と一緒に使用して、パラメータの値を取得する前にパラメータが存在するかどうかを確認します。有効な VSA AV ペアの名前のリストについては、「AV ペアの名前」の表を参照してください。

構文

infotag get aaa_avpair_exists avpair-name

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字

ダイレクト マッピング

なし

AV ペアの名前

情報タグ aaa_avpair_exists を使用して、VSA の可用性を確認することができます。また、情報タグ aaa_avpair を使用して、この VSA で戻された値を取得することができます。これらのコマンドにパラメータとして渡すことができる有効な VSA 名を、次に示します。

 

タイプ
名前
説明

aaa

h323-ivr-in

「color:blue」または「advprompt:rtsp://www.cisco.com/rtsp/areyouready.au」などの AV ペア形式で、課金サーバからゲートウェイへ情報を送信するための総称 VSA。

h323-ivr-out

「color:blue」または「advprompt:rtsp://www.cisco.com/rtsp/areyouready.au」などの AV ペア形式で、ゲートウェイから課金サーバへ情報を送信するための総称 VSA。

h323-credit-amount

アカウントの預金残高が戻されます。

h323-credit-time

アカウントの残り通話時間が戻されます。

h323-prompt-id

プロンプトの ID が戻されます。

h323-redirect-number

呼の転送番号が戻されます。

h323-redirect-ip-addr

優先ルートの IP アドレスが戻されます。

h323-preferred-lang

エンド ユーザの優先言語として課金システムが戻す言語。en(英語)、sp(スペイン語)、ch(中国語)の 3 つの言語がサポートされています。必要に応じて、追加の言語を定義することができます。

h323-time-and-day

宛先の時刻と曜日。

h323-return-code

この情報は、authorization コマンドの発行後にのみ戻され、数値または「Unknown variable name」のいずれかが戻されます。数値は、IVR アプリケーションがどの処理を行う必要があるか、つまり、許可に失敗した原因をエンド ユーザに知らせるために特定の音声ファイルを再生することを示します。「Unknown variable name」が戻される場合、外部の AAA サーバはアウト オブ サービスです。

h323-billing-model

呼で使用される課金モデルを示します。初期値は 0=Credit、1=Debit です。注意:デビット カード アプリケーションでは、Debit 課金モデルを前提としています。

h323-currency

残高の再生に使用される単位を示す ISO 通貨。デビット カード アプリケーションでは、preferred_language_dollar.au および preferred_language_cent.au の単位を前提としています。


) aaa 変数が「0」を戻す場合、戻された名前と一致する VSA がないことを示します。


aaa_new_guid

説明

システムに新しい GUID を生成して戻すように要求します。

構文

infotag get aaa_new_guid

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

cfg_avpair

説明

CLI によって設定された AV ペアの値を戻します。

構文

infotag get cfg_avpair avpair-name

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

RADIUS によって設定または戻される文字列、数字、ブール(1 または 0)などのすべての値

ダイレクト マッピング

なし

cfg_avpair_exists

説明

指定のパラメータまたは AV ペアが CLI によって設定されたかどうかの結果を戻します。

構文

infotag get cfg_avpair_exists avpair-name

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

ブール(1 = true; 0=false)

ダイレクト マッピング

なし

con_all

説明

スクリプトのすべての接続 ID のリストを戻すか、またはマッピングします。

構文

infotag get con_all

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

ダイレクト マッピング

接続

con_ofleg

説明

レッグが関与するすべての接続のリストを取得します。確立または破棄されている接続は含まれません。この情報タグは、1 つのレッグのみにマッピングする必要があります。

構文

infotag get con_ofleg {info-tag | legID}

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

ダイレクト マッピング

接続

evt_aaa_status_info

説明

aaa 情報を取得します。たとえば、方式リストを ev_accounting_status_ind イベントから取得します。

構文

infotag get evt_aaa_status_info [attribute-name]

attribute-name:アクセス対象の属性。定義される属性は、method-list-name と status です。属性を指定しない場合、属性のリストを av1#av2#(「#」はデリミタ)の形式で戻します。ステータスの値を次に示します。

000:アカウンティングが失敗しました。

001:アカウンティングが成功しました。

モード

読み取り

適用範囲

ev_accounting_status_ind

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set method_list [infotag get evt_aaa_status_info method-list-name]

evt_address_resolve_reject_reason

説明

アドレス解決拒否の理由を戻します。

構文

infotag get evt_address_resolve_reject_reason

モード

読み取り

適用範囲

ev_address_resolved

戻り値のタイプ

数字

ダイレクト マッピング

なし

evt_address_resolve_term_cause

説明

アドレス解決終了の理由を戻します。

構文

infotag get evt_address_resolve_term_cause

モード

読み取り

適用範囲

ev_address_resolved

戻り値のタイプ

数字

ダイレクト マッピング

なし

evt_connections

説明

受け取ったイベントと関連した接続 ID のリストを戻します。

構文

infotag get evt_connections

モード

読み取り

適用範囲

ev_handoff
ev_returned
ev_setup_done
ev_create_done
ev_destroy_done

戻り値のタイプ

数字リスト

ダイレクト マッピング

接続

evt_consult_info

説明

打診応答イベントから打診情報を戻します。

構文

infotag get evt_consult_info {consultID | transferDest}

モード

読み取り

適用範囲

ev_consult_response

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_dcdigits

説明

leg collectdigits コマンドで収集したディジットを戻します。

構文

infotag get evt_dcdigits

モード

読み取り

適用範囲

ev_collectdigits_done

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_dest_handle

説明

宛先番号に対して登録されているインスタンスのアプリケーション ハンドルを戻します。この値は、宛先がアナログ FXS 電話でビジー(話中)の場合にだけ使用できます。宛先番号に登録されているアプリケーションがない場合、値は空の文字列になります。

構文

infotag get evt_dest_handle

モード

読み取り

適用範囲

ev_setup_done

戻り値のタイプ

文字列:TCL アプリケーション ハンドルを表します。

ダイレクト マッピング

なし

evt_digit

説明

押されたディジット キーを戻します。

構文

infotag get evt_digit

モード

読み取り

適用範囲

ev_digit_end

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_digit_duration

説明

ディジットが押された秒数を戻します。

構文

infotag get evt_digit_duration

モード

読み取り

適用範囲

ev_digit_end

戻り値のタイプ

数字

ダイレクト マッピング

なし

evt_disc_iec

説明

内部エラー コード(IEC)を戻します。複数の IEC がある場合、最後の 1 つだけを戻します。IEC は RADIUS VSA と同じ形式で、ピリオドで区切られた「version.entity.category.subsystem.error.diagnostic」文字列として戻します。

<component> を指定しない場合、このコマンドはピリオドで区切った文字列を IEC の構成要素と一緒に戻します。たとえば、「1.1.180.3.21.0」のようになります。 切断に関連付けられた内部エラーがない場合、 戻される文字列は 「0.0.0.0.0.0」です。

構文

infotag get evt_disc_iec [<component>]

省略可能な <component> 引数には、次のパラメータのいずれかを使用できます。

entity:IEC のエンティティ構成要素を戻します。たとえば「1」です。

category :IEC のカテゴリ構成要素を戻します。たとえば「180」です。

subsystem:サブシステム構成要素を戻します。たとえば「3」です。

errcode:サブシステム固有のエラー コード構成要素を戻します。たとえば「21」です。

モード

読み取り

適用範囲

ev_disconnected

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_disc_rsi

説明

どこからリリースされたかを示す RSI 数値を戻します。
使用できる RSI がない場合、このコマンドは 0 を戻します。


) ev_disconnected イベントを受け取ったときだけ有効です。別のイベントの処理中に呼び出されると、このコマンドは TCL_ERROR を戻し、スクリプトは終了します。


構文

infotag get evt_disc_rsi

モード

読み取り

適用範囲

ev_disconnected

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_endpoint_addresses

説明

終端点アドレスのリストを戻します。

構文

infotag get evt_endpoint_addresses

モード

読み取り

適用範囲

ev_address_resolved

戻り値のタイプ

文字列

戻り値は次の構造を持ちます。

<endpointAddress>#<endpointAddress>#...

最初の endpointAddress は主アドレスです。その後に続く endpointAddresses は代替アドレスです。

ダイレクト マッピング

なし

evt_event

説明

受け取ったイベントの名前を戻します。

構文

infotag get evt_event

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_facility_id

説明

ファシリティ メッセージ応答のサービス タイプを戻します。MCID 呼び出し応答の場合、値は ss_mcid_resp です。

構文

infotag get evt_facility_id

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set facility_id [infotag get evt_facility_id]

使用上の注意

なし

evt_facility_report

説明

ファシリティ イベントの受け取りをイネーブルにします。

構文

infotag set evt_facility_report <mcid | gtd>

モード

書き込み

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

infotag set evt_facility_report gtd

使用上の注意

MCID 応答からファシリティ応答を受け取るには、この情報タグの mcid オプションを設定する必要があります。

GTD 情報を含むファシリティ イベントを受け取るには、この情報タグの gtd オプションを設定する必要があります。

evt_feature_param

説明

特定機能イベントに関連するパラメータを戻します。

構文

infotag get evt_feature_param {parameter_name}

media_inactivity に対する有効な戻り値は次のとおりです。

no media received:メディアの非作動を検出しました。設定された時間内に RTP または RTCP パケットを受信していません。メディアの非作動条件が満たされる前に RTCP パケットを受信しました。

no control info received:メディアの非作動を検出しました。設定された時間内に RTP または RTCP パケットを受信していません。メディアの非作動条件が満たされる前に RTCP パケットを受信していません。

モード

読み取り

適用範囲

ev_feature

戻り値のタイプ

文字列

ダイレクト マッピング

なし

infotag get evt_feature_param media_inactivity_type

evt_feature_report

説明

スクリプトによる特定の機能イベントの代行受信をイネーブルまたはディセーブルにします。

構文

infotag set evt_feature_report {["no_"]event_names}

event_names:呼の作動中にアプリケーションへのレポートが必要な(または不要な)イベントを定義する、アプリケーション イベント名のリスト。イベント名に「no_」のプレフィックスが付いている場合、レポート不要を意味します。有効な event_names の値は次のとおりです。

fax

modem

modem_phase

hookflash

onhook

offhook

media_inactivity

モード

書き込み

適用範囲

ev_feature

戻り値のタイプ

なし

ダイレクト マッピング

なし

スクリプトによるフックフラッシュ機能イベントの受け取りをイネーブルにし、ファックスおよびモデム機能イベントの受け取りをディセーブルにする場合: infotag set evt_feature_report hookflash nofax nomodem

スクリプトによる media_inactivity の受け取りをイネーブルにする場合: infotag set evt_feature_report media_activity

evt_feature_type

説明

機能イベントを受け取ったときに機能タイプ文字列を戻します。

構文

infotag get evt_feature_type

戻り値として有効なイベント名は次のとおりです。

fax

modem

modem_phase

hookflash

onhook

offhook

media_inactivity

media_activity

モード

読み取り

適用範囲

ev_feature

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_gtd

説明

ハンドルをイベントに含まれる GTD パラメータに関連付けます。

アプリケーションはこのハンドルを使用して、関連付けられている GTD パラメータを発呼シグナル メッセージに含めることができます。

構文

infotag get evt_gtd <gtd_handle>

モード

読み取り

適用範囲

ev_address_resolved
ev_alert
ev_connected
ev_disconnected
ev_proceeding
ev_progress
ev_setup_indication

戻り値のタイプ

数字。ハンドルをイベントから作成できる場合は 1、それ以外の場合は 0 を戻します。

ダイレクト マッピング

なし

set handle [infotag get evt_gtd gtd_inf]

使用上の注意

なし

evt_handoff ani

説明

leg setup コマンドの <transfer>/ フィールドに着信アプリケーションが設定した ani を戻します。

構文

infotag get evt_handoff ani

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set ani [infotag get evt_handoff ani]

使用上の注意

このコマンドは、handoff イベントでだけ使用できます。

evt_handoff argstring

説明

このコマンドは、既存の evt_handoff_string 情報タグに代わるものです。

構文

infotag get evt_handoff argstring

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set hstring [infotag get evt_handoff argstring]

使用上の注意

このコマンドは、handoff イベントでだけ使用できます。

evt_handoff dnis

説明

leg setup コマンドの <transfer>/ フィールドに着信アプリケーションが設定した dnis を戻します。handoff イベントでだけ使用できます。

構文

infotag get evt_handoff dnis

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set dnis [infotag get evt_handoff dnis]

使用上の注意

なし

evt_handoff_legs

説明

アプリケーションに受け渡されたすべてのレッグを戻します。通常は複数レッグの受け渡しでのコール レッグすべてを取得するために使用しますが、レッグ 1 つの受け渡しにも使用できます。

構文

infotag get evt_handoff_legs

モード

読み取り

適用範囲

ev_handoff

戻り値のタイプ

文字列:スペース文字で区切られた複数の legID を表します。

ダイレクト マッピング

なし

evt_handoff proto_headers

説明

受け渡しのヘッダーを取得します。

構文

infotag get evt_handoff proto_headers [<attribute-name>]

<attribute-name>:取得するヘッダーの名前。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set AccountInfo [infotag get evt_handoff proto_headers AccountInfo]
 
The following command returns all headers in a concatenated string. Each header av-pair is separated by a ‘&’:
 
set allHeaders [infotag get evt_handoff proto_headers]
 

使用上の注意

<attribute-name> を指定しない場合、各ヘッダーを「&」記号で区切り、すべてのヘッダーを連結した文字列で戻します。

evt_handoff_string

説明

1 つ以上のコール レッグがスクリプトに受け渡されるか、または戻されると、handoff 文字列を戻します。

構文

infotag get evt_handoff_string

モード

読み取り

適用範囲

ev_handoff
ev_returned

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_iscommand_done

説明

コマンドが終了したかどうかの結果を戻します。

構文

infotag get evt_iscommanddone

モード

読み取り

適用範囲

ev_returned
ev_setup_done
ev_collectdigits_done
ev_vxmldialog_done

戻り値のタイプ

ブール(1 = true; 0 = false)

ダイレクト マッピング

なし

evt_last_disconnect_cause

説明

この呼の間に検出された最後のエラーの値を戻します。エラーは、この呼に関連付けられたコール レッグで発生した可能性があります。呼の間にエラーが発生しなかった場合は、di_000 を戻します。

この情報タグの値を、次のイベントの処理中に更新します。

ev_disconnected:プロトコル メッセージで受信した理由種別に設定します。

ev_disc_prog_ind:プロトコル メッセージで受信した理由種別に設定します。

ev_collectdigits_done:ev_collectdigits_done イベントがステータス cd_006 を戻した場合、di_028(無効な番号)に設定します。別のディジット収集ステータス コードが戻された場合、変更しません。

ev_setup_done:呼の確立の試行に関連付けられた原因コードに設定します。呼の確立が成功した場合、値は di_016(正常)です。

ev_authenticate_done:ev_authenticate_done イベント ステータスが au_000 以外の場合、di_057(ベアラ機能は使用不可)に設定します。イベント ステータスが au_000 の場合、変更しません。

ev_authorize_done:ev_authorize_done イベント ステータスが ao_000 以外の場合、di_057(ベアラ機能は使用不可)に設定します。イベント ステータスが ao_000 の場合、変更しません。

構文

infotag get evt_last_disconnect_cause

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列。文字列の形式については、「切断の原因」を参照してください。

ダイレクト マッピング

なし

evt_last_event_handle

説明

確立のコマンド ハンドルを戻します。

構文

infotag get evt_last_event_handle

モード

読み取り

適用範囲

ev_address_resolved
ev_alert

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_last_iec

説明

スクリプトが ev_setup_done イベントでエラー ステータスを受け取り、詳細な情報が必要な場合、この情報タグにポーリングして ロータリー確立の試行に関連する最後の内部エラー コード(IEC)を検索し、 着信レッグの発信者に IEC に基づいて該当するメッセージを再生します。 この情報タグはどのイベントにも有効です。呼に関連付けられた IEC がまだない場合、文字列「0.0.0.0.0.0」、または構成要素に対して 0 を戻します。

構文

infotag get evt_last_iec [<component>]

省略可能な <component> 引数には、次のパラメータのいずれかを使用できます。

entity:IEC のエンティティ構成要素を戻します。たとえば「1」です。

category:IEC のカテゴリ構成要素を戻します。たとえば「180」です。

subsystem:サブシステム構成要素を戻します。たとえば「3」です。

errcode:サブシステム固有のエラー コード構成要素を戻します。たとえば「21」です。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_legs

説明

受け取ったイベントに関連したレッグ ID のリストを戻します。特定のイベントに対して evt_legs 情報タグがどのレッグを戻すかについては、 第5章「イベント」 を参照してください。

構文

infotag get evt_legs

モード

読み取り

適用範囲

ev_authorize_done
ev_leg_timer
ev_digit_end
ev_hookflash
ev_disconnected
ev_disconnect_done
ev_grab
ev_setup_indication
ev_media_done
ev_handoff
ev_returned
ev_setup_done
ev_collectdigits_done
ev_vxml_dialog_done
ev_vxmldialog_event

戻り値のタイプ

数字リスト

ダイレクト マッピング

レッグ

evt_module_handle

説明

現在のモジュール イベントを生成したモジュールのモジュール ハンドルを戻します。

構文

infotag get evt_module_handle

モード

読み取り

適用範囲

ev_module_done, ev_module_event

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_module_subevent

説明

処理中の ev_module_event を生成した module return interim コマンドで指定されたモジュール サブイベント名を戻します。そのため、処理中の特定のモジュール イベントに関連付けられたパラメータにアクセスできるようになります。

構文

infotag get evt_module_subevent

モード

読み取り

適用範囲

ev_module_event

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_module_context

説明

このモジュールを module new コマンドで作成したときに指定されたモジュール コンテキストを戻します。

構文

infotag get evt_module_context

モード

読み取り

適用範囲

ev_module_done, ev_module_event

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_msg

説明

メッセージ本文を取得します。


) ev_msg_indication イベントの処理時にだけ有効です。


構文

infotag get evt_msg <array-name>

<array_name>: sendmsg コマンドの -p 属性から情報を入力された TCL 配列の名前。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

配列項目名のリスト。

ダイレクト マッピング

なし

proc act_handle_msg {
infotag get evt_msg rx_message
if { [info exists rx_message(fruit)] == 1 } {
set fruit $rx_message(fruit)
} else { set fruit “peaches” }
set ident [infotag get evt_msg_source]
set return_msg(text) “Got your message requesting $fruit, ignoring it”
sendmsg $ident -p return_msg
}

使用上の注意

なし

evt_msg_source

説明

メッセージのソースのハンドルを取得します。

構文

infotag get evt_msg_source

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

proc act_handle_msg {
infotag get evt_msg rx_message
if { [info exists rx_message(fruit)] == 1 } {
set fruit $rx_message(fruit)
} else { set fruit “peaches” }
set ident [infotag get evt_msg_source]
set return_msg(text) “Got your message requesting $fruit, ignoring it”
sendmsg $ident -p return_msg
}

使用上の注意

これは、mod_handle 情報タグで戻されるハンドルと同じ種類のハンドルです。sendmsg または handoff コマンドで使用できます。

この情報タグは、ev_msg_indication イベントの後にだけ有効です。別の場合に呼び出されるとエラーが発生し、スクリプトが失敗します。

evt_params

説明

module return コマンドの <param-array> パラメータで提供される情報から現在のモジュール空間内に <array-name> という名前の配列変数を作成します。そのため、処理中の特定のモジュール イベントに関連付けられたパラメータにアクセスできるようになります。

構文

infotag get evt_params <array-name>

モード

読み取り

適用範囲

ev_module_done, ev_module_event

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_progress_indication

説明

受信した alert、connected、disconnect、disconnect with PI、proceeding、progress のいずれかのメッセージの経過を示す値を戻します。

構文

infotag get evt_progress_indication

モード

読み取り

適用範囲

ev_alert
ev_connected
ev_progress
ev_proceeding
ev_disconnected
ev_disc_prog_ind

戻り値のタイプ

数字

ダイレクト マッピング

なし

set progress [infotag get evt_progress_indication]

使用上の注意

なし

evt_proto_content

説明

受け取ったイベントのコンテンツを取得するために使用します。コンテンツはプロトコル メッセージの本文です。

構文

infotag get evt_proto_content

モード

読み取り

適用範囲

ev_notify、ev_subscribe_done、ev_unsubscribe_indication

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set r_content [infotag get evt_proto_content]

使用上の注意

プレーン テキストや XML テキストなど、テキスト コンテンツだけがサポートされます。

evt_proto_content_type

説明

受け取ったイベントのコンテンツ タイプを取得するために使用します。このイベントでは、プロトコル メッセージの本文に含まれるコンテンツのタイプを指定します。

構文

infotag get evt_proto_content_type

モード

読み取り

適用範囲

ev_notify、ev_subscribe_done、ev_unsubscribe_indication

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set content_type [infotag get evt_proto_content_type]

使用上の注意

プレーン テキストや XML テキストなど、テキスト コンテンツだけがサポートされます。

evt_proto_headers

説明

イベントに関連付けられたプロトコル ヘッダー情報へのアクセスに使用します。

構文

infotag get evt_proto_headers <attribute-name>

<attribute-name>:取得するヘッダーの名前。

モード

読み取り

適用範囲

ev_notify、ev_subscribe_done、ev_unsubscribe_indication

戻り値のタイプ

ヘッダー属性の値を含む文字列

ダイレクト マッピング

なし

set event [infotag get evt_proto_headers Event]
set inviteSubject [infotag get evt_proto_headers “Subject”]
set all_headers [infotag get evt_proto_headers]

使用上の注意

このコマンドを使用して、標準および標準以外のヘッダーにアクセスできます。アプリケーションでは、ヘッダー値をキャッシュに格納しません。アプリケーションでヘッダー情報の保管が必要な場合は、ローカル変数またはグローバル変数に情報を保存する必要があります。

<attribute-name> を指定しない場合、各ヘッダーを「&」記号で区切り、すべてのヘッダーを連結した文字列で戻します。

evt_report ev_transfer_request

説明

終端点からアプリケーションにコール転送要求イベントを通知できるようにします。

構文

infotag set evt_report ev_transfer_request

モード

書き込み

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

infotag set evt_report ev_transfer_request

使用上の注意

スクリプトは、転送先の終端点へのレッグの確立を実行します。callinfo(transferCall、transferBy、consultID)フィールドに evt_transfer_info 情報タグで入手できる情報が入力されます。

callinfo フィールドが入力されたら、転送先の終端点への呼が確立されます。

evt_redirect_info

説明

呼が転送されるときに、転送要求情報を戻します。

構文

infotag get evt_redirect_info {redirectDest | redirectReason | redirectCount | originalDest}

redirectDest:宛先への呼の確立中に取得したリダイレクト先の番号。

redirectReason:リダイレクションのタイプ。

rr_cfb:CF-busy

rr_cfnr:CF-no answer

rr_cd:CD-call deflection

rr_cfu:CF-unconditional

redirectCount:発生したコール転送の数。

originalDest:元の送信先番号。

モード

読み取り

適用範囲

ev_setup_done

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_service_control

説明

<index> で指数付けされたサービス コントロールを戻します。<index> 1 が最初のサービス コントロール フィールドになります。

構文

infotag get evt_service_control <index>

モード

読み取り

適用範囲

ev_address_resolved

戻り値のタイプ

文字列

文字列のコンテンツはアプリケーションによって異なります。コンテンツの形式は、アプリケーションとルート エンティティ間で取り決められます。


) アプリケーションがサービス記述子フィールドを処理します。ゲートキーパーとゲートウェイはどちらもサービス記述子のコンテンツを解釈しません。


ダイレクト マッピング

なし

evt_service_control_count

説明

サービス コントロール フィールドの数を戻します。

構文

infotag get evt_service_control_count

モード

読み取り

適用範囲

ev_address_resolved

戻り値のタイプ

数字

ダイレクト マッピング

なし

evt_status

説明

受け取ったイベントのステータスを戻します。この情報タグは、そのイベントを処理する関数の適用範囲でのみ有効です。有効なステータスのリストについては、「ステータス コード」を参照してください。

構文

infotag get evt_status

モード

読み取り

適用範囲

ev_setup_done
ev_collectdigits_done
ev_media_done
ev_disconnected
ev_authorize_done
ev_authenticate_done
ev_vxmldialog_done
ev_subscribe_done
ev_unsubscribe_done
ev_unsubscribe_indication

戻り値のタイプ

文字列

ダイレクト マッピング

なし

proc act_SubscribeDone { } {
puts "***** act_Subscribe : SUBSCRIPTION DONE received"
set sub_id [infotag get evt_subscription_id]
set status [infotag get evt_status]
puts "*** act_subscribe: subscription status=$status"
if {$status == "su_000"} {
puts "\n Subscription accepted."
return
} else if {$status == "su_001"} {
puts "\n Subscription is pending"
return
} else {$status == "su_002"} {
# subscription request has failed; close the subscription
puts "\nSubscription request has failed."
set status_text [infotag get evt_status_text]
puts "text is: $status_text\n"
subscription close $sub_id
}
}

使用上の注意

戻りコードは何らかのタイプのエラーが発生したことを示します。このため、スクリプトはそのようなエラーを適切に処理できるように記述する必要があります。

evt_status_text

説明

イベントに関連付けられたエラー情報を取得します。

構文

infotag get evt_status

モード

読み取り

適用範囲

ev_subscribe_done、ev_unsubscribe_done、ev_unsubscribe_indication

戻り値のタイプ

エラー情報がある場合は、それを含む文字列

ダイレクト マッピング

なし

set sub_id [infotag get evt_subscription_id]
set status [infotag get evt_status]
puts "*** act_subscribe: subscription status=$status"
if {$status == "su_002"} {
# subscription request has failed; close the subscription
puts "\nSubscription request has failed."
set status_text [infotag get evt_status_text]
puts "text is: $status_text\n"
subscription close $sub_id
}

evt_subscription_id

説明

登録または通知に関連するイベントに関連付けられた登録 ID を取得します。

構文

infotag get evt_subscription_id

モード

読み取り

適用範囲

ev_subscribe_done、ev_notify、ev_subscribe_cleanup、ev_unsubscribe_indication

戻り値のタイプ

登録 ID

ダイレクト マッピング

なし

set sub_id [infotag get evt_subscription id]

使用上の注意

なし

evt_timer_name

説明

時間切れになった named_timer に関連付けられた名前を取得します。

構文

infotag get evt_timer_name

モード

読み取り

適用範囲

ev_named_timer

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_transfer_info

説明

転送要求イベントからの転送情報を戻します。

構文

infotag get evt_transfer_info {transferBy | transferDest | consultID}

モード

読み取り

適用範囲

ev_transfer_request

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_vxmlevent

説明

スローされた VXML イベントを含む文字列を戻します。これらのイベントの形式は一般に vxml.* です。

VXML sendevent object 拡張を使用してダイアログ マークアップまたはドキュメントからスローされたイベントの形式は、vxml.dialog.* です。sendevent オブジェクトの詳細については、「SendEvent オブジェクト」を参照してください。

<disconnect/> タグを実行する vxml ドキュメントなど、何らかのイベントが原因でシステムからスローされたイベントの形式は vxml.session.* です。

構文

infotag get evt_vxmlevent

モード

読み取り

適用範囲

ev_vxmldialog_done
ev_vxmldialog_event

戻り値のタイプ

文字列

ダイレクト マッピング

なし

evt_vxmlevent_params

説明

イベントに付属するパラメータを取得します。この情報タグは、配列変数を消去して、sendevent オブジェクト タグの param オプションに含まれるパラメータ名で示されたパラメータ値を入力します。パラメータはまた、<exit/> タグと namelist 属性によって戻すこともできます。sendevent オブジェクトの詳細については、「SendEvent オブジェクト」を参照してください。

どちらの場合も、namelist に音声クリップ変数が含まれていれば、音声クリップ用の ram:// uri 形式を含む文字列値を使用して、TCL スクリプトからパラメータとして使用できます。この情報タグは、指数のスペース区切りリストを戻します。この指数は、パラメータとして情報タグに渡された戻り配列変数に追加されたものです。

構文

infotag get evt_vxmlevent_params <array-variable-name>

モード

読み取り

適用範囲

ev_vxmldialog_done
ev_vxmldialog_event

戻り値のタイプ

文字列

Parameter: array-variable-name

ダイレクト マッピング

なし

gtd_attr_exists

説明

属性インスタンスが GTD メッセージ内に存在するかどうかの判別に使用します。

構文

infotag get gtd_attr_exists <gtd_handle><attr_instance>

<gtd_handle>:GTD ハンドルの名前。ここからアプリケーションが GTD 属性インスタンスの存在を確認します。

<attr_instance>:このパラメータの形式は <attr_name>、<attr_instance> です。<attr_instance> には、値 -1(「どちらでもよい」という意味)を指定できます。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

ブール(1 = true、0 = false)

ダイレクト マッピング

なし

last_command_handle

説明

最後のコマンド ハンドルを取得します。

構文

infotag get last_command_handle

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_all

説明

1 つ以上のコール レッグを戻すか、またはマッピングします。これは、leg_incoming と leg_outgoing を組み合わせたものです。

構文

infotag get leg_all

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

ダイレクト マッピング

レッグ

leg_ani

説明

CallInfo の ANI フィールドを戻します。

構文

infotag get leg_ani [legID]

レッグ ID を指定しない場合、この情報タグは、最初の着信コール レッグの ANI フィールドを戻します。着信コール レッグが 1 つ以上ある場合に限り、レッグ ID を指定しなくても有効です。

レッグ ID を指定する場合、この情報タグは、そのコール レッグの ANI フィールドを戻します。コール レッグが無効な場合、スクリプトが終了してエラーが出力されます。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_ani_pi

説明

発信者番号のプレゼンテーションを示す値を取得します。

構文

infotag get leg_ani_pi

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

取得する値は、次のいずれかになります。

1:presentation_allowed
2:presentation_restricted
3:number_lost_due_to_interworking
4:reserved_value
5:not_present(着信シグナリング メッセージに発信者番号 IE が存在しないことを示す)

ダイレクト マッピング

なし

leg_ani_si

説明

発信者番号のスクリーニングを示す値を取得します。

構文

infotag get leg_ani_si

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

取得する値は、次のいずれかになります。

1:usr_provided_unscreened
2:usr_provided_screening_passed
3:usr_provided_screening_failed
4:network_provided
5:not_present(着信シグナリング メッセージに発信者番号 IE が存在しないことを示す)

ダイレクト マッピング

なし

leg_dn_tag

説明

CallInfo の DN フィールドを戻します。ephone から発信された呼では、このフィールドに発信者の DN タグが含まれます。

構文

infotag get leg_dn_tag legID

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_dnis

説明

CallInfo の DNIS フィールドを戻します。

構文

infotag get leg_dnis [legID]

レッグ ID を指定しない場合、この情報タグは、最初の着信コール レッグの DNIS フィールドを戻します。着信コール レッグが 1 つ以上ある場合に限り、レッグ ID を指定しなくても有効です。

レッグ ID を指定する場合、この情報タグは、そのコール レッグの DNIS フィールドを戻します。コール レッグが無効な場合、スクリプトが終了してエラーが出力されます。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_display_info

説明

CallInfo の display_info フィールドを戻します。ephone から発信された呼では、このフィールドには発信者の名前が含まれます。

構文

infotag get leg_display_info legID

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_guid

説明

レッグの GUID を戻します。

構文

infotag get leg_dnis [legID]

legID が指定しない場合、最初の着信レッグの GUID を戻します。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_incoming

説明

1 つ以上の着信コール レッグを戻すか、マッピングします。

構文

infotag get leg_incoming

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

ダイレクト マッピング

レッグ

leg_incoming_guid

説明

レッグの着信 GUID を戻します。

構文

infotag get leg_incoming_guid [legID]

legID が指定しない場合、最初の着信レッグの GUID を戻します。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_inconnection

説明

この接続に関与するレッグのリストを取得します。この情報タグのパラメータは、1 つの接続にのみマッピングされます。

構文

infotag get inconnection {connID | info-tag}

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

ダイレクト マッピング

レッグ

leg_isdid

説明

CallInfo の DID フィールドを戻します。このフィールドは、コール レッグの FinalDestination フラグを反映したブール フィールド(1 と 0)です。

構文

infotag get leg_isdid [legID]

レッグ ID を指定しない場合、この情報タグは、最初の着信コール レッグの DID フィールドを戻します。着信コール レッグが 1 つ以上ある場合に限り、レッグ ID を指定しなくても有効です。

レッグ ID を指定する場合、この情報タグは、そのコール レッグの DID フィールドを戻します。コール レッグが無効な場合、スクリプトが終了してエラーが出力されます。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

ブール(1 = true; 0 = false)

ダイレクト マッピング

なし

leg_outgoing

説明

1 つ以上の発信コール レッグを戻すか、またはマッピングします。

構文

infotag get leg_outgoing

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

ダイレクト マッピング

レッグ

leg_password

説明

レッグ ID を指定しない場合、この情報タグは、最初の着信コール レッグのパスワード フィールドを戻します。着信コール レッグが 1 つ以上ある場合に限り、レッグ ID を指定しなくても有効です。レッグ ID を指定する場合、この情報タグは、そのコール レッグのパスワード フィールドを戻します。コール レッグが無効な場合、スクリプトが終了してエラーが出力されます。

構文

infotag get leg_password [legID]

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_proto_headers

説明

使用中のプロトコルに関連付けられたヘッダーにアクセスできるようにします。

構文

infotag get leg_proto_headers [<attribute-name>] [legID]

<attribute-name>:取得するヘッダーの名前。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set AccountInfo [infotag get leg_proto_headers AccountInfo]
set inviteSubject [infotag get evt_proto_headers "Subject"]
set inviteFrom [infotag get leg_proto_headers “From” leg_incoming]
 

次のコマンドは、着信 invite メッセージから受信したすべてのヘッダーを連結した文字列で戻します。各ヘッダーの AV ペアは「&」で区切られます。

set allHeaders [infotag get evt_proto_headers]
 

使用上の注意

この情報タグを使用すると、VXML ドキュメントまたは TCL IVR 2.0 スクリプトから SIP ヘッダーにアクセスできます。

現在、SIP invite、subscribe、notify、H.323 setup メッセージのヘッダーへのアクセスだけがサポートされています。

<attribute-name> を指定しない場合、各ヘッダーを「&」記号で区切り、すべてのヘッダーを連結した文字列で戻します。

legID を指定しない場合、最初の着信レッグが適用されます。

leg_rdn

説明

最初の着信レッグからリダイレクト番号を取得します。

構文

infotag get leg_rdn

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_rdn_pi

説明

リダイレクト番号のプレゼンテーションを示す値を取得します。

構文

infotag get leg_rdn_pi

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

取得する値は、次のいずれかになります。

1:presentation_allowed
2:presentation_restricted
3:number_lost_due_to_interworking
4:reserved_value
5:not_present(着信シグナリング メッセージにリダイレクト番号 IE が存在しないことを示す)

ダイレクト マッピング

なし

leg_rdn_si

説明

リダイレクト番号のスクリーニングを示す値を取得します。

構文

infotag get leg_rdn_si

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字リスト

取得する値は、次のいずれかになります。

1:usr_provided_unscreened
2:usr_provided_screening_passed
3:usr_provided_screening_failed
4:network_provided
5:not_present(着信シグナリング メッセージにリダイレクト番号 IE が存在しないことを示す)

ダイレクト マッピング

なし

leg_redirect_cnt

説明

最初の着信コール レッグからリダイレクト カウント情報を、または、callid を指定した場合はレッグのリダイレクト カウント情報を取得します。

構文

infotag get leg_redirect_cnt

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字。取得する値は 0 ~ 7 です。

ダイレクト マッピング

なし

leg_remoteipaddress

説明

呼の送信元である終端点のリモート IP アドレスを戻します。IP アドレスを取得できない場合は、空の文字列を戻します。

構文

infotag get leg_remoteipaddress <leg-id>

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列(IP アドレス)

ダイレクト マッピング

なし

leg_remote_media_ip_address

説明

終端点のリモート メディア IP アドレスを戻します。IP アドレスを取得できない場合は、空の文字列を戻します。

構文

infotag get leg_remote_media_ip_address <leg_id>

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列(IP アドレス)

ダイレクト マッピング

なし

leg_remote_signaling_ip_address

説明

終端点のリモート シグナリング IP アドレスを戻します。IP アドレスを取得できない場合は、空の文字列を戻します。

構文

infotag get leg_remote_signaling_ip_address <leg_id>

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列(IP アドレス)

ダイレクト マッピング

なし

leg_rgn_noa

説明

リダイレクト番号のアドレス値の種類を取得します。

構文

infotag get leg_rgn_noa

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字

取得する値は、次のいずれかになります。

00:不明、番号あり
01:不明、番号なし、プレゼンテーション制限あり
02:一意の登録者番号
03:一意でない登録者番号
04:一意の国(有効)番号
05:一意でない国番号
06:一意の国際番号
07:一意でない国際番号
08:ネットワーク固有の番号
09:非登録者番号
10:登録者番号、オペレータ要
11:国番号、オペレータ要
12:国際番号、オペレータ要
13:番号なし、オペレータ要
14:番号なし、キャリアへのカットスルー コール
15:キャリアの電話局、ホテル/モーテル、または電話局以外のアクセス終端局からの 950+ コール
16:テスト回線テストコード
17:一意の 3 桁国番号
18:クレジット カード
19:国際着信
20:キャリアのアクセス コードを含む国または国際番号
21:セルラー - グローバル ID GSM
22:セルラー - グローバル ID NWT 900
23:セルラー - グローバル ID autonet
24:モバイル(その他)
25:ポーティングされた番号
26:VNET
27:WZ1 外の国際オペレータ間
28:WZ1 内の国際オペレータ間
29:オペレータ要 - 処理済み
30:国(有効)形式のネットワーク ルーティング番号
31:ネットワーク固有形式のネットワーク ルーティング番号
32:発信者電話番号と連結されたネットワーク ルーティング番号
33:番号ポータビリティ用にスクリーニング済み
34:短縮番号

ダイレクト マッピング

なし


) この情報タグは、特定のシグナリング情報にアクセスするための中間メカニズムとして提供されます。将来の IOS リリースでこの情報への代替アクセス方法が利用可能になると、使用されなくなる可能性があります。


leg_rgn_npi

説明

リダイレクト番号のナンバリング プラン インジケータ値を戻します。

構文

infotag get leg_rgn_npi

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字

取得する値は、次のいずれかになります。
1:ISDN ナンバリング プラン
2:データ ナンバリング プラン
3:テレックス ナンバリング プラン
4:プライベート ナンバリング プラン
5:国
6:海上モバイル
7:陸上モバイル
8:ISDN モバイル
252:不明

ダイレクト マッピング

なし


) この情報タグは、特定のシグナリング情報にアクセスするための中間メカニズムとして提供されます。将来の IOS リリースでこの情報への代替アクセス方法が利用可能になると、使用されなくなる可能性があります。


leg_rgn_num

説明

リダイレクト番号アドレスを戻します。

構文

infotag get leg_rgn_num

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし


) この情報タグは、特定のシグナリング情報にアクセスするための中間メカニズムとして提供されます。将来の IOS リリースでこの情報への代替アクセス方法が利用可能になると、使用されなくなる可能性があります。


leg_rgn_pi

説明

リダイレクト番号のプレゼンテーションを示す値を戻します。

構文

infotag get leg_rgn_pi

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字

取得する値は、次のいずれかになります。

0:不明
1:プレゼンテーション可能
2:プレゼンテーション不可
3:アドレス使用不可

ダイレクト マッピング

なし


) この情報タグは、特定のシグナリング情報にアクセスするための中間メカニズムとして提供されます。将来の IOS リリースでこの情報への代替アクセス方法が利用可能になると、使用されなくなる可能性があります。


leg_rgn_si

説明

リダイレクト番号のスクリーニングを示す値を戻します。

構文

infotag get leg_rgn_si

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字

取得する値は、次のいずれかになります。

1:指定されたユーザはスクリーニングされません。
2:指定されたユーザはスクリーニングに合格しました。
3:指定されたユーザはスクリーニングに合格できませんでした。
4:ネットワークが指定されました。
252:不明

ダイレクト マッピング

なし


) この情報タグは、特定のシグナリング情報にアクセスするための中間メカニズムとして提供されます。将来の IOS リリースでこの情報への代替アクセス方法が利用可能になると、使用されなくなる可能性があります。


leg_settlement_time

説明

指定したレッグのリストに関連した OSP 決済時間(秒)の最小値を戻します。

構文

infotag get leg_settlement_time {legID | info-tag} [minimum]

minimum を指定すると、レッグ リストの OSP 決済時間の最小値、および AAA AV-pair creditTime の値を戻します。この AAA AV-pair creditTime の値は、これ以前に実行された aaa authorize コマンドによって戻されたものです。

すべての残り通話時間が初期化されていない場合、「uninitialized」が戻されます。

すべての残り通話時間に制限がない場合や、一部は初期化されてそれ以外は制限がない場合、「uninitialized」が戻されます。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字

ダイレクト マッピング

なし

leg_source_carrier_id

説明

発信元キャリア ID を取得します。

構文

infotag get leg_source_carrier_id

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

なし

ダイレクト マッピング

なし

leg_subscriber_type

説明

登録者タイプを戻します。

構文

infotag get leg_subscriber_type

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

なし

ダイレクト マッピング

なし

leg_suppress_outgoing_auto_acct

説明

設定した場合、サービス プロバイダー モジュールが自動的に発信コール レッグにアカウンティング パケットを生成することはありません。

構文

infotag get leg_suppress_outgoing_auto_acct
infotag set leg_suppress_outgoing_auto_acct

モード

読み取り/書き込み

適用範囲

グローバル

戻り値のタイプ

設定の場合はなし
取得の場合はブール(0 | 1)

ダイレクト マッピング

レッグ

leg_target_carrier_id

説明

宛先キャリア ID を設定します。

構文

infotag set leg_target_carrier_id

モード

書き込み

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

leg_tdm_hairpin

説明

着信コール レッグで TDM ヘアピニングをイネーブルにします。TDM ヘアピン値を発信レッグにコピーし、TDM ヘアピニングに使用できるようにします。

構文

infotag set leg_tdm_hairpin [legID | info-tag] [enable | disable]

モード

書き込み

適用範囲

グローバル

戻り値のタイプ

なし

ダイレクト マッピング

なし

leg_type

説明

指定されたレッグのインターフェイス タイプを戻します。detail パラメータを指定した場合、指定したレッグのインターフェイス サブタイプを含む詳細な文字列を戻します。detail パラメータは省略可能です。レッグの指定に使用する情報タグに対応するレッグは 1 つだけにする必要があります。

構文

infotag get leg_type [detail] {legID | info-tag}

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

有効な戻り値を以下に示します。

telephony
voip
mmoip
voatm
vofr
unknown
none

detail パラメータを指定した場合の有効な戻り値は次のとおりです。

voip-h323
voip-sip
tele-analog-em
tele-analog-fxo
tele-analog-fxs
tele-analog-efxs
tele-analog-efxo
tele-digital-isdn
tele-digital-cas
tele-digital-bri
tele-digital-r2
msp-doc
msp-fax
unknown

ダイレクト マッピング

なし

leg_username

説明

レッグ ID を指定しない場合、この情報タグは、最初の着信コール レッグの username フィールドを戻します。着信コール レッグが 1 つ以上ある場合に限り、レッグ ID を指定しなくても有効です。レッグ ID を指定する場合、この情報タグは、そのコール レッグの username フィールドを戻します。コール レッグが無効な場合、スクリプトが終了してエラーが出力されます。

構文

infotag get leg_username [legID]

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

med_backup_server

説明

バックアップ サーバを戻すか、または設定します。これは、RTSP ベースのプロンプトに適用されます。

スクリプト再生の試行に URL を使用して URL エラーが発生した場合、URL のサーバ部分を置き換えて、バックアップ サーバのリストから URL の再生を試みます。

たとえば、スクリプトが次の URL からプロンプトの再生を試みて(失敗し)、

rtsp://www.cisco.com:5554/audiofiles/english/anounce.au

バックアップ サーバ 0 が次の URL で構成されている場合、

rtsp://www.real.com/cisco/

次のバックアップ URL から試みます。

rtsp://www.real.com/cisco/audiofiles/english/anounce.au

最大 2 つのバックアップ サーバ(0 と 1)の構成が可能です。

この情報タグは、いずれのプロンプトも再生していないストリームにだけ適用され、通常、スクリプトで一度だけ実行される初期化セクションで使用されます。

構文

infotag get med_backupserver index

infotag set med_backupserver index server-URL

モード

読み取り/書き込み

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

med_language

説明

メディアの再生で現在使用されている言語を戻すか、または設定します。

この情報タグは、現在使用されている言語の言語インデックスまたは(プレフィックスが指定されている場合)言語プレフィックスを戻します。

構文

infotag get med_language [prefix]

infotag set med_language [index | prefix prefix]

モード

読み取り/書き込み

適用範囲

グローバル

戻り値のタイプ

文字列/数字

ダイレクト マッピング

なし

med_language_map

説明

言語インデックスと言語プレフィックスの間のマッピングを戻すか、または設定します。

この情報タグは、現在使用されている言語の言語インデックスまたは(プレフィックスが指定されている場合)言語プレフィックスを戻します。

構文

infotag get med_language_map [index | prefix prefix]

infotag set med_language_map index prefix

モード

読み取り/書き込み

適用範囲

グローバル

戻り値のタイプ

文字列/数字

ダイレクト マッピング

なし

med_location

説明

スクリプトで使用されるすべての言語のロケーションを戻すか、または設定します。言語プレフィックス、カテゴリ、および場所は、Cisco IOS コマンドライン インターフェイス(CLI)から設定可能なものと同じです。

構文

infotag get med_location prefix category有効なカテゴリ値は、1、2、3、4 です。

infotag set med_location prefix category location.カテゴリ 0 を使用すると 1 ~ 4 のカテゴリすべてを設定できます。

モード

読み取り/書き込み

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

med_total_languages

説明

設定されている言語の合計数を戻します。

構文

infotag get med_total_languages

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

数字

ダイレクト マッピング

なし

media_timer_factor

説明

receive-rtcp タイマーを設定します。新しい値はスクリプトの適用範囲内で使用され、ゲートウェイの設定は変更されません。

構文

infotag set media_timer_factor <timer_factor>

timer_factor:2 ~ 1000 の整数。この値は、RTCP 送信間隔の倍数です。推奨値は 5 です。


) 2 ~ 1000 の範囲以外の値を使用すると、スクリプトはエラー メッセージを受け取ります。


モード

書き込み

適用範囲

なし

戻り値のタイプ

なし

ダイレクト マッピング

なし

infotag set media_timer_factor 5

mod_all_handles

説明

ゲートウェイで実行中のすべてのインスタンスのリストを取得します。戻されたハンドルは、handoff および sendmsg コマンドの引数として使用できます。

構文

infotag get mod_all_handles

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set all_handles [infotag get mod_all_handles]

使用上の注意

ハンドルはゲートウェイ内でだけ有効な ASCII 文字列です。別のゲートウェイにあるセッションのハンドルは、そのゲートウェイへのメッセージ送信には使用できません。

ハンドルの形式は、TCL スクリプトによる解析や出力向けには設計されていません。ハンドルは、sendmsg または handoff コマンドで内部的に使用されます。

mod_handle

説明

現在実行中のアプリケーション セッションのハンドルを取得します。戻されたハンドルは、handoff および sendmsg コマンドの引数として使用できます。

構文

infotag get mod_handle

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set id [infotag get mod_handle]
 
set my_name new_customer
set recorded_name ([infotag get mod_handle]) $my_name

使用上の注意

ハンドルはゲートウェイ内でだけ有効な ASCII 文字列です。別のゲートウェイにあるセッションのハンドルは、そのゲートウェイへのメッセージ送信には使用できません。

ハンドルの形式は、TCL スクリプトによる解析や出力向けには設計されていません。ハンドルは、sendmsg または handoff コマンドで内部的に使用されます。

サービスが実行されていない場合は、「unavailable」を戻します。

mod_handle_service

説明

ネームド サービスのハンドルを取得します。

構文

infotag get mod_handle_service <service>

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set serv_hndl [infotag get mod_handle_service]

使用上の注意

ネームド サービスが実行されていない場合は、「unavailable」を戻します。

戻されたハンドルは、handoff および sendmsg コマンドの引数として使用できます。

set iec

説明

call close または leg disconnect コマンドを発行する前に内部エラー コード(IEC)を設定します。


) leg disconnect -<iec> コマンドで、IEC を指定した後に set iec 情報タグを使用すると、コール レッグに関連付けられる IEC が重複します。


構文

infotag set iec <legID | info-tag> <iec>

<iec>:次の引数のいずれかを指定できます。

media_done_err:ev_media_done イベントからエラー ステータスが戻されたため、スクリプトが呼を終了することを示します。

collectdigits_done_err :ev_collectdigits_done イベントからエラー ステータスが戻されたため、スクリプトが呼を終了することを示します。

authenticate_done_err:ev_authenticate_done イベントからエラー ステータスが戻されたため、スクリプトが呼を終了することを示します。

authorize_done_err:ev_authorize_done イベントからエラー ステータスが戻されたため、スクリプトが呼を終了することを示します。

media_inactivity_err:メディアの非作動が検出され、報告されたときに呼を切断します。

accounting_conn-err:アカウンティング サーバへの接続が失われたことをスクリプトが検出したことを示します。

モード

書き込み

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

subscription_context

説明

登録 ID に関連付けられた登録コンテキスト情報を取得します。

構文

infotag get subscription_context <subscription_id> [attribute]

subscription_id:登録に関連付けられた ID。

attribute:コンテキスト情報内の属性。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

コンテキストを含む文字列

ダイレクト マッピング

なし

set accountNumber [infotag get subscription_context $MySubID accountNumber]

使用上の注意

attribute 引数がない場合、すべての属性と値を含む文字列を戻します。各 AV ペアは、「#」文字でエスケープされます。

subscription_info

説明

登録 ID に関連付けられた登録情報を取得します。取得可能な登録属性は、url、event、expirationTime、subscription_context、および
notificationReceiver です。

構文

infotag get subscription_info <subscription_id> <attribute>

subscription_id:登録に関連付けられた ID。

attribute:アクセス対象の属性。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし

set exp_time [infotag get subscription_info $sub_id expirationTime]

使用上の注意

なし

subscription_server_ipaddress

説明

登録サーバの IP アドレスを取得します。

構文

infotag get subscription_server_ipaddress <subscription_id>

subscription_id:登録に関連付けられた ID。

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

サーバの IP アドレスを含む文字列

ダイレクト マッピング

なし

set ipaddr [infotag get subscription_server_ipaddress $sub_id]

使用上の注意

なし

sys_version

説明

TCL IVR API のバージョンを戻します。

構文

infotag get sys_version

モード

読み取り

適用範囲

グローバル

戻り値のタイプ

文字列

ダイレクト マッピング

なし