Ao se registrar como parceiro com o Business Messages, você pode criar conversas entre usuários e marcas criando agentes, entidades de conversação que representem funções de negócios, como suporte ao site e locais da marca.
Quando um usuário encontra uma marca que você gerencia na Pesquisa Google ou no Maps, os resultados da pesquisa mostram a opção Chat. Ao clicar em Chat, o usuário pode enviar mensagens ao agente da marca. O agente permite que você receba e responda às mensagens do usuário.
Registrar como parceiro
Ao se registrar como parceiro do Business Messages, criar agentes para marcas e aproveitar as APIs que o capacitam, é possível ativar experiências de mensagens para serviços ao cliente, vendas e outros apps de negócios.
- Abra o Business Communications Developer Console.
- Em Business Messages, clique em Create partner account.
Insira valores para as informações do parceiro:
Campo Valor 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
Leia e aceite os Termos de Serviço do Business Messages.
Clique em Criar.
Você está registrado como um parceiro do Business Messages e tem acesso às APIs Business Communications e Business Communications. A API Business Messages envia mensagens para os usuários, enquanto a API Business Communications gerencia agentes.
Crie uma conta de serviço
Para autenticar chamadas de API com segurança para as APIs Business Messages e Business Communications, você precisa de uma chave de conta de serviço e da ferramenta de linha de comando oauth2l.
- Na página inicial do Console do desenvolvedor do Business Communications, clique em Configurações da conta de parceiro.
- Na navegação à esquerda, clique em Conta de serviço.
Clique em Criar chave e em Criar.
O navegador faz o download da chave da conta de serviço. Armazene a chave da sua conta de serviço em um local privado e seguro. Não compartilhe sua chave publicamente. Você precisará dessa chave posteriormente para acessar as APIs Business Message e Business Communication.
Definir seu livro
Agora que a API Business Messages e o Business Communications estão ativadas, é preciso especificar o URL do webhook para começar a receber mensagens.
- Abra as Configurações da conta no Console do desenvolvedor do Business Communications.
- Verifique se a conta de parceiro correta está selecionada.
- Em URL do webhook do Business Messages, clique em Configurar.
- Em URL do endpoint do webhook, insira o URL do webhook, começando com "https://".
- Anote o valor de
clientToken
. Você precisa dela para verificar se as mensagens recebidas são provenientes do Google. Configure o webhook para aceitar uma solicitação
POST
com o parâmetroclientToken
especificado e enviar uma resposta200 OK
com o valor de texto simples do parâmetrosecret
como o corpo de 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 de
clientToken
e, seclientToken
estiver correto, retornar uma resposta200 OK
com0123456789
como o corpo.No console, clique em Verificar.
Quando o Business Messages verifica seu webhook, a caixa de diálogo é fechada.
Consulte Exemplo: atualizar o URL do webhook para ver como configurar o webhook com as APIs Business Communication.
Receber informações do parceiro
Para acessar suas informações atuais de parceiros, consulte a API Business Communications com seu ID de parceiro.
Execute o comando a seguir. Substitua PARTNER_ID pelo seu ID de 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 Console para desenvolvedores do Business Communications ou execute os comandos a seguir.
Substitua PARTNER_ID pelo ID do parceiro, que pode ser encontrado no Console para desenvolvedores 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, pode começar a desenvolver com o Business Messages. Para começar rapidamente, consulte Criar 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.