Когда вы регистрируетесь в качестве партнера в Business Messages, вы можете обеспечить общение между пользователями и брендами, создав агентов — диалоговые сущности, которые представляют бизнес-функции, такие как поддержка веб-сайтов и местоположение брендов.
Когда пользователь находит бренд, которым вы управляете, в Google Поиске или на Картах Google, в результатах поиска отображается опция «Чат» . Когда пользователь нажимает «Чат» , он может отправлять сообщения агенту бренда. Агент позволяет получать сообщения пользователя и отвечать на них.
Зарегистрируйтесь как партнер
Зарегистрировавшись в качестве партнера в Business Messages, создав агентов для брендов и используя API-интерфейсы вашего агента, вы сможете обеспечить возможность обмена сообщениями для обслуживания клиентов, продаж и других бизнес-приложений.
- Откройте консоль разработчика бизнес-коммуникаций .
- В разделе «Деловые сообщения» нажмите «Создать партнерскую учетную запись» .
Введите значения для информации о вашем партнере:
Поле Ценить Ваше имя Ваше полное имя Имя партнера Название вашей организации Партнерский сайт Сайт вашей организации Область Регион, в котором вы хотите разместить службу бизнес-сообщений.
Прочтите и примите Условия использования Business Messages .
Нажмите Создать .
Теперь вы зарегистрированы в качестве партнера Business Messages и имеете доступ к API Business Messages и Business Communications. API бизнес-сообщений отправляет сообщения пользователям, а API бизнес-коммуникаций управляет агентами.
Создать учетную запись службы
Для безопасной аутентификации вызовов API к API бизнес-сообщений и бизнес-коммуникаций вам понадобится ключ учетной записи службы и инструмент командной строки oauth2l .
- На домашней странице консоли разработчика Business Communications нажмите « Настройки партнерской учетной записи» .
- На панели навигации слева нажмите «Учетная запись службы» .
Нажмите «Создать ключ» , затем нажмите «Создать» .
Ваш браузер загружает ключ сервисной учетной записи. Храните ключ своей сервисной учетной записи в безопасном и конфиденциальном месте. Не делитесь своим ключом публично. Этот ключ понадобится вам позже для доступа к API Business Message и Business Communication.
Установите свою веб-книгу
Теперь, когда API бизнес-сообщений и бизнес-коммуникаций включен, вам необходимо указать URL-адрес веб-перехватчика, чтобы начать получать сообщения .
- Откройте настройки учетной записи в консоли разработчика Business Communications.
- Убедитесь, что выбран правильный партнерский аккаунт.
- Для URL-адреса веб-перехватчика Business Messages нажмите « Настроить» .
- В поле URL-адрес конечной точки веб-перехватчика введите URL-адрес веб-перехватчика, начиная с https://.
- Обратите внимание на значение
clientToken
. Он нужен вам, чтобы убедиться, что получаемые вами сообщения исходят от Google . Настройте веб-перехватчик для приема запроса
POST
с указанным параметромclientToken
и отправки ответа200 OK
с текстовым значениемsecret
параметра в качестве тела ответа.Например, если ваш вебхук получает запрос
POST
со следующим содержимым тела{ "clientToken":"SJENCPGJESMGUFPY", "secret":"0123456789" }
ваш веб-перехватчик должен подтвердить значение
clientToken
и, еслиclientToken
верен, вернуть ответ200 OK
с0123456789
в качестве тела ответа.В консоли нажмите «Проверить» .
Когда Business Messages проверит ваш веб-перехватчик, диалоговое окно закроется.
См. раздел «Пример: обновление URL-адреса веб-перехватчика» , чтобы узнать, как настроить веб-перехватчик с помощью API-интерфейсов бизнес-коммуникаций.
Получить информацию о партнере
Чтобы получить текущую информацию о партнере, вы можете запросить API бизнес-коммуникаций, указав свой идентификатор партнера.
Выполните следующую команду. Замените PARTNER_ID на свой идентификатор партнера.
# 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)"
Обновить информацию о партнере
Чтобы обновить информацию о своем партнере, вы можете использовать страницу настроек учетной записи в консоли разработчика Business Communications или выполнить следующие команды.
Замените PARTNER_ID своим идентификатором партнера (идентификатор партнера можно найти в консоли разработчика Business Communications) и замените UPDATED_FIELDS именами полей, которые вы обновляете.
# 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__" }'
Параметры форматирования и значений см. в partners.patch
.
Пример: обновить отображаемое имя
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', }"
Пример: обновить URL-адрес веб-перехватчика
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', }, }, ], }"
Следующие шаги
Теперь, когда вы являетесь зарегистрированным партнером и включили API, вы можете начать разработку с помощью Business Messages. Чтобы быстро приступить к работе, см. раздел Создание первого агента .
В противном случае узнайте, как создавать агентов , которые будут представлять ваши бренды в беседах, и настраивать вебхук для получения сообщений от пользователей.