Definir a disponibilidade de mensagens

Antes que os usuários possam iniciar conversas com seu agente, você precisa definir a disponibilidade de mensagens dele no Business Messages.

Se um usuário enviar uma mensagem ao seu agente durante o horário de atendimento, ele vai receber uma mensagem de boas-vindas e sugestões de conversa. Se a conversa começar fora do horário de atendimento, os usuários vão receber a mensagem off-line do agente. Consulte Iniciar a conversa para mais informações sobre essas mensagens.

Disponibilidade de bots e humanos

É possível especificar a disponibilidade de bots e representantes humanos separadamente.

Se você tiver algum tipo de automação para compor mensagens para seu agente, seja um autoresponder informando aos usuários a posição deles em uma fila, um agente complexo de compreensão de linguagem natural com acesso dinâmico aos detalhes do usuário ou qualquer outra coisa, especifique a disponibilidade de mensagens do bot.

A disponibilidade humana é obrigatória se você quiser lançar um agente em pontos de entrada gerenciados pelo Google, incluindo pontos de entrada com base em local e não locais (exceto o Google Ads). Para a disponibilidade humana, especifique apenas os dias da semana e os horários em que você tem agentes disponíveis para responder a perguntas.

Se os representantes de bot estiverem disponíveis 24 horas por dia, mas os representantes humanos estiverem disponíveis das 8h às 20h, você poderá especificar isso de forma independente.

Além disso, se você especificar a disponibilidade de bots e humanos, você poderá enviar sugestões de solicitação de agente humano para incentivar os usuários a solicitar agentes humanos se os representantes de bot não puderem atender às necessidades deles.

Atualizar a disponibilidade de mensagens

Para atualizar a disponibilidade de mensagens, faça uma solicitação PATCH com a API Business Communications para atualizar os campos primaryAgentInteraction e additionalAgentInteractions de um agente.

Ao atualizar esses campos, você precisa incluir valores para todos os campos no objeto SupportedAgentInteraction. As solicitações de atualização substituem o conteúdo de todos os campos editados, incluindo os campos filhos. Por exemplo, se você fizer uma solicitação para adicionar uma instância a hours, também precisará incluir todas as instâncias hours anteriores. Caso contrário, a atualização vai substituí-las.

Pré-requisitos

Antes de atualizar a disponibilidade de mensagens, você precisa dos seguintes itens:

  • Caminho para a chave da conta de serviço do projeto do GCP na sua máquina de desenvolvimento
  • O name do agente (por exemplo, "brands/12345/agents/67890")

    Se você não souber o name do agente, consulte Listar todos os agentes de uma marca.

  • Fusos horários, dias da semana e horários de disponibilidade do bot

  • Fusos horários, dias da semana e horários de disponibilidade humana

Se você não souber os valores atuais de primaryAgentInteraction e additionalAgentInteractions, consulte Receber informações do agente.

Enviar a solicitação de atualização

Para atualizar o agente, execute o comando abaixo. Substitua as variáveis pelos valores identificados nos pré-requisitos.

Se você tiver disponibilidade de mensagens de bot e humana, especifique a disponibilidade de bot em primaryAgentInteraction e a disponibilidade humana em uma instância de additionalAgentInteractions.

Bot e humano

# This code updates the agent interaction of a bot and human representatives.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/patch

# Replace the __BRAND_ID__ and __AGENT_ID__
# Make sure a service account key file exists at ./service_account_key.json

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__?updateMask=businessMessagesAgent.primaryAgentInteraction,businessMessagesAgent.additionalAgentInteractions" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
-d '{
  "businessMessagesAgent": {
    "primaryAgentInteraction": {
      "interactionType": "BOT",
      "botRepresentative": {
        "botMessagingAvailability": {
          "hours": [
            {
              "startTime": {
                "hours": 20,
                "minutes": 0
              },
              "endTime": {
                "hours": 8,
                "minutes": 0
              },
              "timeZone": "America/Los_Angeles",
              "startDay": "MONDAY",
              "endDay": "SUNDAY"
            }
          ]
        }
      }
    },
    "additionalAgentInteractions": [
      {
        "interactionType": "HUMAN",
        "humanRepresentative": {
          "humanMessagingAvailability": {
            "hours": [
              {
                "startTime": {
                  "hours": 8,
                  "minutes": 0
                },
                "endTime": {
                  "hours": 20,
                  "minutes": 0
                },
                "timeZone": "America/Los_Angeles",
                "startDay": "MONDAY",
                "endDay": "SUNDAY"
              }
            ]
          }
        }
      }
    ]
  }
}'

Somente bot

# This code updates the primary agent interaction of a bot representative
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/patch

# Replace the __BRAND_ID__ and __AGENT_ID__
# Make sure a service account key file exists at ./service_account_key.json

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__?updateMask=businessMessagesAgent.primaryAgentInteraction" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
-d '{
  "businessMessagesAgent": {
    "primaryAgentInteraction": {
      "interactionType": "BOT",
      "botRepresentative": {
        "botMessagingAvailability": {
          "hours": [
            {
              "startTime": {
                "hours": 20,
                "minutes": 0
              },
              "endTime": {
                "hours": 8,
                "minutes": 0
              },
              "timeZone": "America/Los_Angeles",
              "startDay": "MONDAY",
              "endDay": "SUNDAY"
            }
          ]
        }
      }
    }
  }
}'

Somente humano

# This code updates the primary agent interaction of a human representative
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/patch

# Replace the __BRAND_ID__ and __AGENT_ID__
# Make sure a service account key file exists at ./service_account_key.json

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__?updateMask=businessMessagesAgent.primaryAgentInteraction" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
-d '{
  "businessMessagesAgent": {
    "primaryAgentInteraction": {
      "interactionType": "HUMAN",
      "humanRepresentative": {
        "humanMessagingAvailability": {
          "hours": [
            {
              "startTime": {
                "hours": 20,
                "minutes": 0
              },
              "endTime": {
                "hours": 8,
                "minutes": 0
              },
              "timeZone": "America/Los_Angeles",
              "startDay": "MONDAY",
              "endDay": "SUNDAY"
            }
          ]
        }
      }
    }
  }
}'

Para opções de formatação e valor, consulte brands.agents.patch e SupportedAgentInteraction.