コードエレメントのコード

ここでは、コードエレメントを使用してさまざまなタスクを実行する方法の例を示します。

エンドユーザーの場所を緯度と経度に転送する

エンドユーザーが場所を送信し、正確な緯度と経度を決定する場合。

javascript

2 const loc = attributeApi.get('Location');

3 attributeApi.set('latitude', loc.latitude);

4 attributeApi.set('longitude', loc.longitude);

営業時間の定義

エンドユーザーがエージェントと対話する場合は、営業時間中にエージェントに連絡できます。ただし、営業時間外では、エンドユーザーはエージェントにリダイレクトされません。

コーディングエレメントを使用して、これらの営業時間を定義し、それに応じてダイアログを設定することができます。

Example of code for setting agent working hours

異なるタイムゾーンを考慮に入れてください。

javascript

2 const Monday = { open: 8, close: 17 };

3 const Tuesday = { open: 8, close: 17 };

4 const Wednesday = { open: 8, close: 17 };

5 const Thursday = { open: 8, close: 17 };

6 const Friday = { open: 8, close: 17 };

7 const Saturday = { open: 0, close: 0 };

8 const Sunday = { open: 0, close: 0 };

10 const myTimeZone = 'Europe/Zagreb'; // This IANA time zone name

12 const workingHoursSchedule = [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday];

14 function isWorkingHours(now) {

16 const day = new Date(now).getDay();

17 const hours = new Date(now).getHours();

19 const daySchedule = workingHoursSchedule[day];

21 return hours >= daySchedule.open && hours < daySchedule.close;

22 }

24 const result = isWorkingHours(new Date().toLocaleString('en-US', {

25 timeZone: myTimeZone

26 }));

28 attributeApi.set('result', result);

受信したプロモーションメッセージに応じてダイアログを分岐

定義済み lastreceivedtextmessage 属性を使用して、受信メールにプロモーションコードが含まれているかどうかを確認します。

Example how to use lastreceivedtextmessage in Coding element

javascript

2 attributeApi.set('bonus_code', attributeApi.get('lastReceivedTextMessage') === 'promo code' ? true : false);

チャットボット属性を使用してパラメータを一度だけ初期化する

多くの場合、チャットボットを作成するときは、チャットボットがサポートするさまざまなユースケースに対して複数の API 呼び出しを行う必要があります。ベース URL、ユーザー名、パスワード、暗号化キー(該当する場合)などの API の詳細をハードコーディングする代わりに、これらのパラメーターごとにチャットボット属性を作成し、ユーザーがデフォルトのダイアログに入ったらコーディングエレメントを使用して初期化できます。

これは、値の初期化に使用できるコードです。

javascript

2 attributeApi.set('base_url', 'https://127.0.0.1:9030');

3 attributeApi.set('msisdn', attributeApi.get('phoneNumber'));

4 attributeApi.set('username', 'someUsername');

6 attributeApi.set('password', 'somePassword');

7 // or

8 attributeApi.set('password', encryptionUtils.sha1('somePassword'));

初期化された値は、チャットボットのすべてのダイアログで属性としてアクセスできます(使用する必要があるすべての場所でハードコーディングする必要はありません)。

Use initialized values in dialog creation

チャットボット環境を開発から運用に変更する必要があり、API URLと資格情報が変更された場合は、コーディングエレメントでこれらの詳細を 1 回だけ変更するだけで済みます。

機密データの暗号化と復号化

encryptionUtilsを使用して、ID、個人データ、資格情報などの機密性の高い顧客情報を保護します。このプロセスでは、PKCS5 パディングを使用した AES-128-ECB 暗号化が使用されます。

次のいずれかの暗号化オプションを使用します。

デフォルトキー: ライブラリの組み込みデフォルトキーを使用します。このオプションは、重要でないデータに使用します。
カスタムシークレット: 指定したカスタムキーを使用します。このオプションは、セキュリティの強化が必要な機密データに使用します。

大事な

暗号化キーをセッション属性に格納して、ダイアログ要素間で再利用できるようにします。

暗号化と復号化の両方に同じキーを使用します。1 つのキーで暗号化されたデータは、別のキーで復号化することはできません。

デフォルトの暗号化キーを使用する

次の例は、既定のキーを使用して ID CustomerID12345 を暗号化および復号化する方法を示しています。

javascript

1 var sensitiveData = "CustomerID12345";

2 var encrypted = encryptionUtils.encrypt(sensitiveData);

3 attributeApi.set('encryptedID', encrypted);

5 // Later, decrypt when needed

6 var decrypted = encryptionUtils.decrypt(attributeApi.get('encryptedID'));

カスタムシークレットを使用する

次の例は、カスタムキー my-secure-password-2024 を使用して ID QatariID12345 を暗号化および復号化する方法を示しています。

javascript

1 var mySecret = "my-secure-password-2024";

2 var qatariID = "QatariID12345";

4 var encrypted = encryptionUtils.encrypt(qatariID, mySecret);

5 attributeApi.set('encryptedID', encrypted);

7 // Decrypt with the same secret

8 var decrypted = encryptionUtils.decrypt(attributeApi.get('encryptedID'), mySecret);

数値属性値の比較

たとえば、ローンを申し込む顧客がいて、その顧客がクレジットスコア (ローン限度額) を超えるローン金額を申請できないようにする必要がある場合です。このローン限度額は顧客によって異なり、ハードコーディングすることはできません。

スコープ Chatbot のブール属性 is_valid_loan_amount を作成します。
ユーザー借入するローン金額 (loan_amount) を入力した後、コーディングエレメントを使用してローン金額とローン限度額 (credit_score) を比較し、比較結果に応じてis_valid_loan_amountを true または false に設定します

javascript
1
2 const creditScore = attributeApi.get('credit_score');
3 const loanAmount = attributeApi.get('loan_amount');
4
5 if (loanAmount <= creditScore) {
6 attributeApi.set('is_valid_loan_amount', true);
7 } else {
8 attributeApi.set('is_valid_loan_amount', false);
9 }
is_valid_loan_amount が true の場合はローン申請を続行し、それ以外の場合は、より少ない金額を申請するようにユーザーに通知するように、条件エレメントを追加します。

動的に生成された API 応答から有効なオプションを選択する

たとえば、銀行のチャットボットがあり、エンドユーザーに取引元の口座番号のリストが表示された場合、リストから口座番号を1つ選択する必要があります。選択したアカウント番号が提供されたリストにない場合、チャットボットはエラーメッセージで応答する必要があります。

リスト属性response_accountsを作成して、API応答からユーザー銀行口座のリストを格納します。ユーザーが入力したアカウント番号を保持するaccount_number属性を定義します。
ユーザーが選択するアカウントの動的リストを表示します。ユーザー入力は account_number 属性に格納されます。
コーディングエレメントを使用して、ユーザー入力 (account_number) が有効な口座番号のリストに含まれているかどうかを検証します。

javascript
1
2 const validAccounts = attributeApi.get('valid_accounts');
3 const userInput = attributeApi.get('account_number');
4
5 let accountNumber = null;
6
7 const isUserInputValidAccount = validAccounts.indexOf(userInput) > -1;
8 if (isUserInputValidAccount) {
9 accountNumber = userInput;
10 } else {
11 const indexInArray = userInput - 1;
12 const isUserInputValidArrayIndex = validAccounts.length > indexInArray && validAccounts[indexInArray] !== 'undefined';
13 if (isUserInputValidArrayIndex) {
14 accountNumber = validAccounts[indexInArray];
15 }
16 }
17
18 attributeApi.set('account_number', accountNumber);
上記のコーディングエレメントでは、account_numberが有効でない場合(つまり、有効なリストにない場合)、nullに設定されます。
条件エレメントを使用して、account_number属性がnullの場合は、無効なアカウント番号のメッセージを表示し、そうでない場合は、チャットボットとの会話を続行します。

動的に生成された API 応答からの複数選択を許可する

オンボーディングチャットボットがあり、エンドユーザーに障害を選択させる場合は、動的に生成されたリストから選択できます(API呼び出しを使用)。各障害にはIDと名前があります。ユーザーが複数の値を選択できるようにするには、複数の数値をスペースで区切って入力します。2 番目の API を使用して、選択した障碍 ID (ユーザーが入力したオプションの数ではない) が、空白で区切られた 1 つのパラメーターとして渡されます。

次の属性を作成します。

disabilities_response – 選択する障害のリストを保持します (最初のAPIによって返されます)

ユーザーの選択 – ユーザーが選択した障碍のリストを保持します

disability_found –ユーザー入力が有効かどうかを追跡するブール属性

ユーザー入力 – ユーザーが入力する障害を格納します

api_response – ルート JSON パスでの完全な API 応答 ($.)

invalid_input – 予期される応答と一致しないユーザー入力

selected_ids – ユーザーが選択した障碍 ID
ユーザーが選択する障碍の動的リストを表示します。ユーザー入力はユーザー_input 属性に格納されます。このユーザー入力は、数字とスペース (^[0-9\s]*$) のみを許可する正規表現を使用して検証されます
コーディングエレメントの使用:

a)スペースで区切られたユーザー入力を配列に変換して、処理を容易にします b)前の手順で生成された配列内の要素をループします。反復ごとに、現在のエレメント (ユーザー入力) が障害の一覧のインデックスであるかどうかを確認します。その場合は、手順 1 で定義した ユーザー_選択 リスト属性に、対応する障害を格納します。念のため、一致した障碍 ID を別のリスト selected_ids (手順 1 でも定義) に個別にプッシュできます。 c) selected_ids リストを、2 回目の API 呼び出しで想定されるスペース区切りの文字列に変換します。最終的なコーディングエレメントは次のようになります。

javascript
1
2 /**
3 * This validates disability type based on user input
4 **/
5 var user_input = attributeApi.get('user_input');
6 var disabilities = attributeApi.get('disabilities_response');
7 var inputs_array = user_input.split(" ");
8 var selected_ids = [];
9
10 attributeApi.set('inputs_array', inputs_array);
11
12 var user_selection = [];
13 var disability_found = true;
14 var i = 0;
15 for(i=0; i<inputs_array.length; i++){
16 var val = inputs_array[i];
17 var index = parseInt(val)-1;
18 attributeApi.set('invalid_input', val);
19
20 if(val == "") {//Means multiple white spaces between numbers
21 //Pass
22 }else if(typeof disabilities[index] == 'undefined') {
23 disability_found = false;
24 attributeApi.set('invalid_input', val);
25
26 } else { //Found
27 user_selection.push(disabilities[index]);
28 selected_ids.push(disabilities[index].Id);
29 }
30 }
31
32 attributeApi.set('disability_found', disability_found);
33 attributeApi.set('user_selection', user_selection);
34 attributeApi.set('selected_ids', selected_ids.join(" "));
エレメント条件を使用して、disability_found属性がTrueの場合はチャットボット会話を続行し、そうでない場合は検証エラーメッセージを表示します。

ユーザーから送信された時刻と日付を必要なタイムゾーンと日付形式に転送します

次の例では、コーディングエレメントで受信した日時が再フォーマットされるタイムゾーンはアジア/コルカタです。

javascript

2 const date = new Date();

3 const year = new Intl.DateTimeFormat('en', { timeZone: 'Asia/Kolkata', year: 'numeric' }).format(date);

4 const month = new Intl.DateTimeFormat('en', { timeZone: 'Asia/Kolkata', month: '2-digit' }).format(date);

5 const day = new Intl.DateTimeFormat('en', { timeZone: 'Asia/Kolkata', day: '2-digit' }).format(date);

6 const hour = new Intl.DateTimeFormat('en', { timeZone: 'Asia/Kolkata', hour: '2-digit', hour12: false }).format(date);

7 const minute = new Intl.DateTimeFormat('en', { timeZone: 'Asia/Kolkata', minute: '2-digit' }).format(date);

8 const second = new Intl.DateTimeFormat('en', { timeZone: 'Asia/Kolkata', second: '2-digit' }).format(date);

9 const milli = date.getMilliseconds();

10 const formattedDate = `${year}-${month}-${day} ${hour}:${minute}:${second}.${milli}`;

11 attributeApi.set('Date', formattedDate);

メッセージ属性タイプを使用して複数のファイル・タイプを受信する

この例では、属性タイプ 'メッセージ' を持つ属性を使用して、エンドユーザーからファイルを受信する方法を示します。この例では、Codeエレメントを使用して、ファイルの種類が画像かドキュメントかを識別します。

] ダイアログ [#dialog-use-message-attribute-type-to-receive-multiple-file-types]

Dialog that uses attribute of type, Message

コード [#code-use-message-attribute-type-to-receive-multiple-file-types]

javascript

2 var message = attributeApi.get ('MOMessage');

3 var format;

5 var type = message.type;

7 if ((type=="IMAGE"))

8 {

9 format="image";

10 }

11 else

12 {

13 format="document";

14 }

16 attributeApi.set ('message_type', format);

どこ

MOMessage の属性タイプは Message です。
message_type の属性タイプは Text です。

ダイアログとコードの説明 [#explanation-of-the-dialog-and-code-use-message-attribute-type-to-receive-multiple-file-types]

MOMessage 属性には、エンドユーザーから送信されたファイルが格納されます。
コードエレメントは、次の処理を行います。
- var message = attributeApi.get('MOMessage'); 'attributeApi' オブジェクトを使用して、MOMessage 属性の値を取得します
- var 型 = message.type 'type' プロパティを使用してファイルの種類を抽出し、その値を変数 type に代入します。
- if-else ステートメントを使用して、'type' 変数が 'image' か 'document' かを識別します。image の場合、変数 format に値 'image' を代入します。それ以外の場合は、変数 format に値 'document' を代入します。
- attributeApi.set('message_type'、フォーマット); 'attributeApi' オブジェクトを使用して、'format' 変数の値を属性に設定しますmessage_type
条件エレメントは 'format' 変数の値に応じてダイアログを分岐します。

WhatsAppメッセージの場合、この例のコードは、エンドユーザーがWhatsAppの正しいアイコンを使用してファイルを送信する場合にのみ機能します。エンドユーザーがWhatsAppの画像アイコンを使用して画像を送信すると、受信したファイルが画像として認識されます。ただし、終了ユーザーがWhatsAppの添付ファイルアイコンを使用して画像を送信した場合、受信したファイルは画像として認識されません。

日付形式を変更する

属性タイプ date を持つ標準属性は、日付を YYYY-MM-DD の形式で格納します。エンドユーザーが別の形式で日付を送信すると、無効な入力として扱われます。

この例では、コードエレメントを使用して、日付を DD-MM-YYYY の形式で保存する方法を示します。

属性の設定 [#set-up-attributes-change-date-format]

次の図に示すように、属性を作成し、フィールドを構成します。

コード [#code-change-date-format]

javascript

2 const d = new Date(attributeApi.get('date'));

3 var day=d.getDate();

5 const m = new Date(attributeApi.get('date'));

6 var month=m.getMonth()+1;

8 const y = new Date(attributeApi.get('date'));

9 year = y.getFullYear();

11 if (day < 10) {

12 day = '0' + day;

13 }

15 if (month < 10) {

16 month = '0' + month;

17 }

19 var form= day +'-' + month + '-' + year;

21 attributeApi.set('day',day);

22 attributeApi.set('month', month);

23 attributeApi.set('year', year);

24 attributeApi.set('date_format', form);

] ダイアログ [#dialog-change-date-format]

シミュレーター [#simulator-change-date-format]

電話番号の形式を変更する

エンドユーザーから誤った形式で電話番号が送信された場合は、必要な形式に変換できます。この例では、次の操作を行う方法を示します。

番号が国コードで始まる場合、変更はありません。
番号が 0 で始まる場合は、0 が削除され、国コードが追加されます。
番号が国コードまたは 0 で始まらない場合は、国コードを追加します。

この例では、国コード 63 を使用します。

コード [#code-change-phone-number-format]

javascript

2 var a= attributeApi.get('mobile_number');

4 if (a.startsWith("639")) {

5 attributeApi.set('new_number', a);

6 }

7 else if (a.startsWith("0")) {

8 var b="63" + a.substring(1);

9 attributeApi.set('new_number', b);

10 }

11 else if (a.startsWith("9")) {

12 var b="63" + a;

13 attributeApi.set('new_number', b);

14 }

] ダイアログ [#dialog-change-phone-number-format]

最寄りの場所を探す

エンドユーザーに最も近いサービスの場所を計算できます。例:最寄りのATMの場所。

属性の設定 [#set-up-attributes-find-the-nearest-location]

次の図に示すように、属性を作成し、フィールドを構成します。

コード [#code-find-the-nearest-location]

javascript

2 var tempDataList = [

3 {'lat': -23.607171362032318, 'lon': -46.69675437970512, 'name': 'São Paulo'},

4 {'lat': -25.423777049024135, 'lon': -49.26882764791356, 'name': 'Curitiba'},

5 ];

7 var locationClient = attributeApi.get('customerLocation');

9 var locationCode = {'lat': locationClient.latitude, 'lon': locationClient.longitude};

11 var i=1;

13 function distance(lat1, lon1, lat2, lon2) {

15 var radlat1 = Math.PI * lat1/180;

16 var radlat2 = Math.PI * lat2/180;

17 var theta = lon1 - lon2;

18 var radtheta = Math.PI * theta/180;

19 var minimalDistance = Math.sin(radlat1) * Math.sin(radlat2) + Math.cos(radlat1) * Math.cos(radlat2) * Math.cos(radtheta);

20 if (minimalDistance /> 1) {

21 minimalDistance = 1;

22 }

23 minimalDistance = Math.acos(minimalDistance);

24 minimalDistance = minimalDistance * 180/Math.PI;

25 minimalDistance = minimalDistance * 60 * 1.1515;

26 minimalDistance = minimalDistance * 1.609344;

27 return minimalDistance;

28 }

30 var minimalDistance = [];

32 tempDataList.forEach(myFunction);

34 function myFunction(value, index, array){

36 minimalDistance[index] = distance(locationCode.lat, locationCode.lon, value.lat, value.lon);

37 }

39 var closestDistance = Math.min.apply(null , minimalDistance);

41 var index = minimalDistance.indexOf(closestDistance);

43 attributeApi.set('nearestATMLat', tempDataList[index].lat);

44 attributeApi.set('nearestATMLon', tempDataList[index].lon);

45 attributeApi.set('nearestATMName', tempDataList[index].name);

] ダイアログ [#dialog-find-the-nearest-location]

以下は、ダイアログの例です。

コードエレメントのコード

エンドユーザーの場所を緯度と経度に転送する

営業時間の定義

受信したプロモーションメッセージに応じてダイアログを分岐

チャットボット属性を使用してパラメータを一度だけ初期化する

機密データの暗号化と復号化

デフォルトの暗号化キーを使用する

カスタム シークレットを使用する

数値属性値の比較

動的に生成された API 応答から有効なオプションを選択する

動的に生成された API 応答からの複数選択を許可する

ユーザーから送信された時刻と日付を必要なタイムゾーンと日付形式に転送します

メッセージ属性タイプを使用して複数のファイル・タイプを受信する

] ダイアログ [#dialog-use-message-attribute-type-to-receive-multiple-file-types]

コード [#code-use-message-attribute-type-to-receive-multiple-file-types]

ダイアログとコードの説明 [#explanation-of-the-dialog-and-code-use-message-attribute-type-to-receive-multiple-file-types]

日付形式を変更する

属性の設定 [#set-up-attributes-change-date-format]

コード [#code-change-date-format]

] ダイアログ [#dialog-change-date-format]

シミュレーター [#simulator-change-date-format]

電話番号の形式を変更する

コード [#code-change-phone-number-format]

] ダイアログ [#dialog-change-phone-number-format]

最寄りの場所を探す

属性の設定 [#set-up-attributes-find-the-nearest-location]

コード [#code-find-the-nearest-location]

] ダイアログ [#dialog-find-the-nearest-location]

シミュレーター [#simulator-find-the-nearest-location]

カスタムシークレットを使用する