Partilhar via

createSession (Referência da API JavaScript) para Dynamics 365 Channel Integration Framework 2.0

Observação

As APIs de gerenciamento de sessão permitem integrar experiências de várias sessões somente no aplicativo de espaço de trabalho Copilot Service.

Cria uma nova sessão com base no nome do modelo de sessão e retorna o identificador exclusivo da sessão que foi criada.

Se sua organização usa um ou vários provedores de canal, você pode usar esse método para iniciar uma sessão padrão. Para obter mais informações: Configurar suporte para provedores de canal único e múltiplo

Antes de chamar esse método, você deve chamar canCreateSession para verificar se uma nova sessão pode ser criada.

Importante

Este método suporta modelos de sessão do tipo Genérico apenas e um máximo de 10 sessões simultaneamente.

Sintaxe

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

Parâmetros

Nome Tipo Obrigatório Description
dados introduzidos Objeto JSON Yes Cordão
correlationId GUID Não Usado para agrupar todas as chamadas de API relacionadas para telemetria de diagnóstico.
successCallback Função Não Uma função a ser chamada quando a solicitação for bem-sucedida. A entrada para esta função é o identificador exclusivo da sessão recém-criada.
errorCallback Função Não Uma função a ser chamada quando a solicitação falhar

A estrutura do parâmetro JSON é a input seguinte:

{ 
   "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

Prometa com um valor como String.

Example

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