Please note that this SDK relates to LivePersons legacy chat product which receives limited support and will be deprecated in the future.
It is recommended to build future integrations on top of the corresponding messaging SDK instead.
Retrieves the Offline survey to be displayed to the visitor, if no agent is available to chat.
Note: For more information on the Survey object, see Surveys.
Request
Properties
| Value | Description | Type | Required | Notes |
|---|---|---|---|---|
| skill | Survey for a specific skill. | string | Optional | |
| visitorProfile | Requests a survey for a specific visitor profile. | string | Optional | If both the skill and visitorProfile properties are provided, only the visitorProfile property will be considered. |
| visitorId | The identifier of the visitor. | string | Optional | |
| surveyName | Requests a specific survey. | string | Optional | If visitorprofile or skill properties are provided, and a survey with this name exists. The requested survey will be returned unless there is a rule that overrides this name. |
| surveyApiId | A survey ID you know of in the server. | string | Optional |
Sample code
var failedRequest = myChat.getOfflineSurvey({
skill: "support",
success: myChat.handleOfflineSurvey,
error: myChat.errorGettingOfflineSurvey,
context: myChat
});
if (failedRequest && failedRequest.error) {
alert(failedRequest.error);
}