View a markdown version of this page

Ative o streaming de mensagens de bate-papo em tempo real no Connect Customer - Amazon Connect Customer
Como as APIs de transmissão de mensagens funcionamEtapa 1: Criar um tópico padrão do SNSEtapa 2: Iniciar o contato do chatEtapa 3: Habilitar a transmissão de mensagens no contatoEtapa 4: Criar a conexão do participantePróximas etapas

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Ative o streaming de mensagens de bate-papo em tempo real no Connect Customer

O Connect Customer Chat fornece APIs que você pode usar para assinar um fluxo de mensagens de bate-papo em tempo real. Usando essas APIs, você pode:

  • Transmitir mensagens de chat em tempo real quando um novo contato de chat for criado.

  • Estenda a funcionalidade atual do Connect Customer Chat para oferecer suporte a casos de uso, como criar integrações com soluções de SMS e aplicativos de mensagens de terceiros, habilitar notificações push móveis e criar painéis de análise para monitorar e rastrear a atividade de mensagens de bate-papo.

nota

Esta página descreve como assinar um endpoint SNS para streaming em tempo real de mensagens de bate-papo no Connect Customer. Se você estiver tentando ativar o streaming de mensagens para interações conversacionais de IA no Connect Customer, consulteAtivar streaming de mensagens para AI-powered bate-papo.

Como as APIs de transmissão de mensagens funcionam

As APIs de streaming de mensagens do Connect Customer são acionadas quando determinados eventos ocorrem em um contato do Connect Customer Chat. Por exemplo, quando um cliente envia uma nova mensagem de chat, o evento envia uma carga útil para um endpoint específico contendo dados sobre a mensagem que acabou de ser enviada. As mensagens são publicadas usando o Amazon Simple Notification Service (Amazon SNS) para um endpoint específico.

Este tópico descreve como configurar o streaming de mensagens em tempo real usando o Connect Customer e o Amazon SNS. As etapas são:

  1. Use o console do Amazon SNS para criar um novo tópico padrão do SNS e configurar as mensagens.

  2. Ligue para a StartChatContact API para iniciar o contato de bate-papo.

  3. Ligue para a StartContactStreaming API para iniciar o streaming de mensagens.

  4. Chame a CreateParticipantConnection API para criar a conexão do participante.

Etapa 1: Criar um tópico padrão do SNS

  1. Acesse o console do Amazon SNS.

  2. Crie um tópico do SNS em sua AWS conta. Na seção Detalhes, em Tipo, escolha Padrão, insira um nome para o tópico e escolha Criar tópico.

    nota

    Atualmente, as APIs de transmissão de mensagens oferecem suporte apenas ao SNS padrão para transmissão de mensagens em tempo real. Elas não são compatíveis com tópicos FIFO (primeiro a entrar, primeiro a sair) do Amazon SNS.

  3. Depois de criar o tópico, o nome do recurso da Amazon (ARN) é exibido na seção Detalhes. Copie o ARN do tópico para a área de transferência. Use o tópico ARN na próxima etapa e emEtapa 3: Habilitar a transmissão de mensagens no contato.

    O ARN do tópico é semelhante ao seguinte exemplo: 

    arn:aws:sns:us-east-1:111122223333:MyTopic

  4. Escolha a guia Política de acesso, escolha Editar e adicione uma política baseada em recursos no tópico SNS para que o Connect Customer tenha permissão para publicar nela. Veja a seguir um exemplo de política do SNS que você pode copiar e colar no editor JSON e, em seguida, personalizar com seus valores:

    JSON
    {
   "Version":"2012-10-17",
   "Statement":[
      {
         "Effect":"Allow",
         "Principal":{
            "Service":"connect.amazonaws.com"
         },
         "Action":"sns:Publish",
         "Resource":"arn:aws:sns:us-east-1:111122223333:TopicName",
         "Condition":{
            "StringEquals":{
                "aws:SourceAccount":"111122223333"
            },
            "ArnEquals":{
            "aws:SourceArn":"arn:aws:connect:us-east-1:111122223333:instance/InstanceId"
            }
         }
      }
   ]
}
    nota

    A Política de acesso padrão vem com condições aplicadas ao sourceOwner como: 

    "Condition": {
        "StringEquals": {
          "AWS:SourceOwner": "921772911154"
        }
      }

    Remova e substitua por SourceAccount, por exemplo:

    "Condition":{
            "StringEquals":{
               "aws:SourceAccount":"YOUR_AWS_ACCOUNT_ID"
            },
            "ArnEquals":{
               "aws:SourceArn":"YOUR_CONNECT_INSTANCE_ARN"
            }
         }

    Isso evita um problema de substituto confuso entre serviços.

  5. Se você estiver usando criptografia do lado do servidor no SNS, verifique se você tem a permissão connect.amazonaws.com habilitada na KMS key. Veja a seguir um exemplo de política:

    JSON
    {
    "Version":"2012-10-17",
    "Id": "key-consolepolicy-3",
    "Statement": [
        {
            "Sid": "Enable IAM User Permissions",
            "Effect": "Allow",
            "Principal": {
                "AWS": "arn:aws:iam::111122223333:root",
                "Service": "connect.amazonaws.com"
            },
            "Action": "kms:*",
            "Resource": "*"
        },
        {
            "Sid": "Allow access for Key Administrators",
            "Effect": "Allow",
            "Principal": {
                "AWS": "arn:aws:iam::111122223333:root",
                "Service": "connect.amazonaws.com"
            },
            "Action": [
                "kms:Create*",
                "kms:Describe*",
                "kms:Enable*",
                "kms:List*",
                "kms:Put*",
                "kms:Update*",
                "kms:Revoke*",
                "kms:Disable*",
                "kms:Get*",
                "kms:Delete*",
                "kms:TagResource",
                "kms:UntagResource",
                "kms:ScheduleKeyDeletion",
                "kms:CancelKeyDeletion"
            ],
            "Resource": "*"
        }
    ]
}

Etapa 2: Iniciar o contato do chat

  1. Ligue para a StartChatContact API Connect Customer para iniciar o contato por chat.

    Para obter informações sobre como criar o cliente SDK para chamar as APIs do Connect Customer, consulte os tópicos a seguir:

  2. Acompanhe ContactId e receba a StartChatContact resposta, pois esses atributos ParticipantToken de resposta são usados para chamar outras APIs de bate-papo necessárias para ativar o streaming. Isso é descrito nas próximas etapas.

Etapa 3: Habilitar a transmissão de mensagens no contato

  • Ligue StartContactStreaming para ativar o streaming de mensagens em tempo real para o seu tópico do SNS.

    • Limites: você pode assinar até dois tópicos do SNS por contato.

    • Ao ligar StartContactStreaming, você precisará fornecer o nome de recurso da Amazon (ARN) do tópico do SNS (consulteEtapa 1: Criar um tópico padrão do SNS).

      Um único ARN de tópico do SNS pode ser usado em vários Contas da AWS, mas deve estar na mesma região da sua instância do Connect Customer. Por exemplo, se o ARN do seu tópico estiver em us-east-1, sua instância Connect Customer deverá estar em us-east-1.

    • Para mensagens de bate-papo iniciais que não são recebidas no endpoint de streaming, você pode chamar a GetTranscript API para receber as mensagens iniciais.

Etapa 4: Criar a conexão do participante

Próximas etapas

Você está pronto para trabalhar com as APIs de transmissão de mensagens.

  1. Para verificar se está funcionando, verifique se as mensagens foram publicadas no tópico do SNS que você criou. Você pode fazer isso usando as CloudWatch métricas da Amazon. Para obter instruções, consulte Tópicos sobre monitoramento do Amazon SNS usando CloudWatch.

  2. Como o SNS tem retenção limitada, recomendamos que você configure o Amazon Simple Queue Service (Amazon SQS), o Amazon Kinesis ou outro serviço para reter mensagens.

  3. StopContactStreamingO uso é opcional e não é obrigatório se os bate-papos estiverem sendo desconectados por meio de um fluxo de contato ou se o cliente desconectar o bate-papo. No entanto, StopContactStreaming oferece a opção de interromper a transmissão de mensagens no tópico do SNS, mesmo se o chat estiver ativo e contínuo.