Compartir a través de

createSession (Referencia de API JavaScript) para Marco de integración de canal de Dynamics 365 2.0

Nota

Las API de administración de sesiones le permiten integrar experiencias multisesión solo en la aplicación Copilot Service Workspace.

Crea una nueva sesión basada en el nombre de la plantilla de sesión y devuelve el identificador único de la sesión que se creó.

Si su organización utiliza proveedores de canales únicos o múltiples, puede utilizar este método para iniciar una sesión predeterminada. Más información: Configurar el soporte para proveedores de canales únicos y múltiples

Antes de llamar a este método, debe llamar a canCreateSession para verificar si se puede crear una nueva sesión.

Importante

Este método admite plantillas de sesión de tipo Genérico únicamente y un máximo de 10 sesiones simultáneas.

Sintaxis

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

Parámetros

Name Type Obligatorio Descripción
input Objeto JSON Sí String
correlationId GUID No Se usa para agrupar todas las llamadas API relacionadas para telemetría de diagnóstico.
successCallback Function No Una función para llamar cuando la solicitud se realiza correctamente. La entrada a esta función es el identificador único de la sesión recién creada.
errorCallback Function No Una función para llamar cuando la solicitud produce error

La estructura del parámetro JSON input es la siguiente:

{ 
   "templateName":"<unique name of session template>",
   "templateParameters":{ 
      "globalparam":"number value OR boolean value OR json string value OR parameterized string value",
      "app template 1":{ 
         "param 1":"number value OR boolean value OR json string value OR parameterized string value",
         "param 2":"..."
      },
      "app template 2":"…."
   }
}

Valor de retorno

Promise con un valor como cadena.

Ejemplo

var input = {
   // unique name of the configured template  
    templateName: "msdyn_chat_session",
 
    templateParameters: {
        customer: "Contoso",
    }
    // Global and application tab template parameters, these values will override configured values
};
Microsoft.CIFramework.canCreateSession().then(function successCallback(result) {
    if (result === true) {
        Microsoft.CIFramework.createSession(input).then(function success(sessionId) {
            console.log(sessionId);
            // perform operations on session Id retrieved
        }, function(error) {
            console.log(error.message);
            // handle error conditions
        });
    } else {
        // cannot create new sessions
    }
}, function errorCallback(error) {
    console.log(error.message);
    // handle error conditions
});
  • Last updated on