Inscreva-se no Business Messages

Ao se registrar como parceiro do Business Messages, você pode ativar em conversas entre usuários e marcas criando agentes entidades que representam funções de negócios, como suporte a sites e em vários locais.

Quando um usuário encontra uma marca que você gerencia na Pesquisa Google ou no Maps, o os resultados da pesquisa mostram a opção Chat. Quando o usuário clica em Chat, ele pode enviar mensagens para o agente da marca. Com ele, você recebe e responde às mensagens do usuário.

Registrar-se como parceiro

Ao se registrar como parceiro no Business Messages, criar agentes para marcas, e usando as APIs que capacitam seu agente, é possível ativar a troca de mensagens experiências de atendimento ao cliente, vendas e outros aplicativos comerciais.

  1. Abra o Console do desenvolvedor do Business Communications.
  2. Em Business Messages, clique em Criar conta do parceiro.
  3. Insira valores para as informações do parceiro:

    Campo Valor
    Seu nome Seu nome completo
    Nome do parceiro Nome da sua organização
    Site do parceiro Site da sua organização
    Região A região em que você quer hospedar o serviço do Business Messages
.
  1. Leia e aceite os Termos de Serviço do Business Messages.

  2. Clique em Criar.

Agora você está registrado como parceiro do Business Messages e tem acesso às APIs Business Messages e Business Communications. A API Business Messages envia mensagens aos usuários, e a Business Communications gerencia agentes.

Criar uma conta de serviço

Para autenticar com segurança chamadas de API para as APIs Business Messages e Business Communications, você precisa de uma chave de conta de serviço e do Ferramenta de linha de comando oauth2l.

  1. Na página inicial do Business Communications Developer Console, clique em Configurações da conta do parceiro.
  2. No menu de navegação à esquerda, clique em Conta de serviço.
  3. Clique em Criar chave e em Criar.

    O navegador fará o download da chave da conta de serviço. Armazene a chave da conta de serviço em um local seguro e privado. O que não fazer compartilhar a chave publicamente. Você precisará dessa chave mais tarde para acessar as APIs Business Message e Business Communication.

.

Configure seu webook

Agora que a API Business Messages and Business Communications está ativada, precisa especificar o URL do webhook para começar recebimento de mensagens.

  1. Abra as Configurações da conta no console para desenvolvedores do Business Communications.
  2. Verifique se a conta do parceiro correta está selecionada.
  3. Em URL do webhook do Business Messages, clique em Configurar.
  4. Em URL do endpoint do webhook, insira o URL do webhook, que começa com "https://".
  5. Anote o valor de clientToken. Ela é necessária para verificar se as mensagens enviadas recebidos vêm de Google.
  6. Configure seu webhook para aceitar uma solicitação de POST com o valor parâmetro clientToken e enviar uma resposta 200 OK com o texto simples do parâmetro secret como o corpo da resposta.

    Por exemplo, se o webhook receber uma solicitação POST com o seguinte conteúdo do corpo

    {
      "clientToken":"SJENCPGJESMGUFPY",
      "secret":"0123456789"
    }
    

    seu webhook precisa confirmar o valor clientToken e, se clientToken for correto, retorna uma resposta 200 OK com 0123456789 como o corpo da resposta.

  7. No console, clique em Verificar.

    Quando o recurso Business Messages verifica o webhook, a caixa de diálogo é fechada.

Consulte Exemplo: atualizar URL do webhook para saber como configurar seu webhook com as APIs Business Communication.

Receber informações do parceiro

Para obter suas informações atuais de parceiro, consulte o Perfil da Empresa API Communications pelo seu ID de parceiro.

Execute o comando a seguir. Substitua PARTNER_ID pelo ID do parceiro.

# This code gets the partner.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/partners/get

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

curl -X GET \
"https://businesscommunications.googleapis.com/v1/partners/__PARTNER_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"

Atualizar informações do parceiro

Para atualizar as informações do parceiro, use a página Configurações da conta no Business Communications Developer Console ou execute os comandos a seguir.

Substituir PARTNER_ID pelo seu ID do parceiro(o ID do parceiro pode ser encontrado no console do desenvolvedor do Business Communications) e substitua UPDATED_FIELDS pelos nomes dos campos que você atualiza.

# This code updates the partner entity.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/partners/patch

# Replace the __PARTNER_ID__, __UPDATED_FIELDS__, __FIELD_NAME__, __FIELD_VALUE__
# Make sure a service account key file exists at ./service_account_key.json

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/partners/__PARTNER_ID__?updateMask=__UPDATED_FIELDS__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
-d '{
  "__FIELD_NAME__": "__FIELD_VALUE__"
}'

Para opções de formatação e valor, consulte partners.patch

Exemplo: atualizar o nome de exibição

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/12345/partners/67890?updateMask=displayName" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key businesscommunications)" \
-d "{
    'displayName': 'XYZ Messaging',
}"

Exemplo: atualizar o URL do webhook

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/partners/12345?updateMask=productCapabilities" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key businesscommunications)" \
-d "{
  'productCapabilities': [
    {
      'product': 'BUSINESS_MESSAGES',
      'businessMessagesCapability': {
        'webhookUrl': 'https://xyz.messaging.com/webhook',
      },
    },
  ],
}"

Próximas etapas

Agora que você é um parceiro registrado e ativou as APIs, já pode começar está desenvolvendo com o Business Messages. Para começar rapidamente, consulte Crie seu primeiro agente.

Caso contrário, aprenda a criar agentes para representar suas marcas em conversas e configurar o webhook para receber mensagens dos usuários.