Dynamics 365 チャネル統合フレームワーク 2.0 の notifyEvent (JavaScript API リファレンス)

  • [アーティクル]

着信会話についてエージェントに通知するために使用できる通知を表示します。

構文

Microsoft.CIFramework.notifyEvent(input, correlationId, cancellationToken).then(successCallback, errorCallback);

Parameters

件名 タイプ Required Description
input JSON オブジェクト 可 String
correlationId GUID No 診断テレメトリのために関連するすべての API 呼び出しをグループ化するために使用されます。
cancellationToken String いいえ 着信会話に関する通知をキャンセルするために cancelEvent メソッドで使用される一意の文字列。
successCallback Function いいえ 要求が成功したときに呼び出す関数。 コールバックが成功すると、応答オブジェクトには顧客が会話を受け入れたか拒否したかに関する情報が含まれます。
errorCallback Function いいえ 要求が失敗したときに呼び出す関数。

コールバック関数の詳細

次のオブジェクトは successCallback 関数と errorCallback 関数に渡されます。

successCallback 関数

JSON オブジェクトのサンプル:

{
	"value": {"actionName" : "Accept",
     "responseReason" : "Accept"}
}

パラメーター

actionName responseReason Description
Accept Accept ユーザーが通知を受け付けた場合
Accept AutoAccept 通知テンプレートで、通知がデフォルトで受け入れられます
拒否する DeclinedByAgent ユーザーが通知を拒否した場合
拒否する NotificationQueueLimitExceeded キュー内の通知が 10 件を超えると、通知は拒否されます
拒否する NotificationQueueTimeLimitExceeded キュー内の通知が設定されたタイムアウト期間を超えた場合
Timeout DisplayTimeout ユーザーがタイムアウト期間内に通知に応答しなかった場合

errorCallback 関数

JSON オブジェクトのサンプル:

{
	"message" : "<error details>",
	"msdyn_name" : "NotifyEvent"
}

パラメーター

message Description
NotificationTemplateNotFoundError 指定したテンプレート名が見つからない場合
RejectAfterClientError 不明な例外が発生しました (プラットフォーム API 呼び出しが失敗したか、入力パラメータが欠落している場合に発生します)

例

var canceltoken = "cancellationtoken"+ Math.ceil(Math.random() * 100000 + 100000).toString();

 

var input = {
                templateName: "msdyn_chat_incoming_unauthenticated",
                // unique name of the configured template
                templateParameters: {
                },
// unique random token, to identify the notification during cancelEvent call
                cancellationToken: canceltoken
}
Microsoft.CIFramework.notifyEvent(input).then(
                function success(result) {
                                console.log(result);
                                // Perform operations
                },
                function (error) {
                                console.log(error.message);
                                // Handle error conditions
                }
);