После того как вы создадите агента Business Messages для бренда, которым вы управляете, и завершите информацию об агенте, вы сможете проверить агента и все связанные с ним местоположения. Вы должны проверить агенты и местоположения, прежде чем они смогут запуститься .
Проверка агента
Когда вы проверяете агента, Business Messages подтверждает информацию об агенте с помощью контакта бренда, который представляет агент. Как только контактное лицо бренда подтвердит, что вы можете представлять бренд вместе с агентом и что информация об агенте верна, агент проходит проверку.
Контрольный список перед проверкой
Прежде чем проверять своего агента, используйте следующий контрольный список, чтобы выявить любые проблемы, которые могут возникнуть в процессе проверки.
Информация об агенте |
---|
Имя агента Необходимый. Имя агента, как оно отображается пользователям. См. Создание агента . |
Логотип агента Необходимый. Логотип агента, каким его видят пользователи. См. Создание агента . |
Доступность обмена сообщениями Необходимый. Дни и время, когда живые агенты доступны для ответа пользователям. См. раздел Настройка доступности сообщений . |
Нелокальная информация Требуется для нелокальных точек входа . Связанные с агентом домены, номера телефонов и доступные регионы запуска. См. раздел Установка нелокальной информации . |
Язык по умолчанию Необходимый. Языковой стандарт, в котором обычно взаимодействует агент. См. раздел Локализация и языковые стандарты . |
Конфигурация OAuth Необязательный. Подробности об интеграции OAuth агента с другими продуктами. См. Аутентификация с помощью OAuth . |
Разрешенные точки входа Необходимый. Необходимо только проверить, создали ли вы агента с API бизнес-коммуникаций. См. Создание агента . |
После проверки агента вы сможете обновить только следующие элементы:
-
conversationalSettings
-
customAgentId
-
defaultLocale
-
primaryAgentInteraction
-
additionalAgentInteractions
-
phone
Если вам нужно обновить поля, доступные только для чтения, после проверки агента,связаться с нами. (Сначала необходимо войти в систему с помощью учетной записи Google Business Messages. Чтобы зарегистрировать учетную запись, см. раздел Регистрация в Business Messages .)
Предварительные условия
Прежде чем вы сможете проверить своего агента, вам необходимо собрать некоторую информацию:
name
агентаЕсли вы не знаете имени агента, см. раздел Список всех агентов бренда .
Путь к ключу сервисной учетной записи вашего проекта GCP на вашем компьютере разработки.
- Имя партнера (название вашей организации)
- Адрес электронной почты партнера (ваш адрес электронной почты)
- Веб-сайт бренда, который представляет агент, в виде общедоступного URL-адреса, начинающегося с https://.
- Контактное имя и адрес электронной почты (обычно общий домен с веб-сайтом бренда) для бренда, который представляет агент, который может подтвердить ваши деловые отношения с брендом и ваши полномочия представлять бренд.
Подтвердить агента
Когда вы запрашиваете подтверждение агента, Business Messages отправляет электронное письмо указанному вами контактному лицу бренда, чтобы подтвердить информацию вашего агента.
Когда контактное лицо бренда проверит информацию вашего агента, а Business Messages проверит вашего агента, вы получите электронное письмо.
Чтобы проверить агента, выполните следующую команду. Замените переменные значениями, указанными в разделе «Предварительные условия» .
КУЛЬ
# This code requests a verification of a Business Messages agent. # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/verify?method=api#verify_an_agent # Replace the __BRAND_ID__ and __AGENT_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X POST \ h"ttps://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__:requestVerification "\ -H C"ontent-Type: application/json "\ -H U"ser-Agent: curl/business-communications "\ -H $"(oauth2l header --json ./service_account_key.json businesscommunications) "\ -d {' a"gentVerificationContact:" { p"artnerName:" P"artner name," p"artnerEmailAddress:" p"artner@email.com," b"randContactName:" B"rand contact name," b"randContactEmailAddress:" b"rand-contact@email.com," b"randWebsiteUrl:" h"ttps://www.your-company-website.com " } }c'
Node.js
/** * This code snippet requests an agent verification. * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/verify?method=api#verify_an_agent * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = E'DIT_HERE;' const AGENT_ID = E'DIT_HERE;' const PATH_TO_SERVICE_ACCOUNT_KEY = .'/service_account_key.json;' const businesscommunications = require(b'usinesscommunications)'; const {google} = require(g'oogleapis)'; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ h'ttps://www.googleapis.com/auth/businesscommunications,' ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const agentName = b'rands/ '+ BRAND_ID + /'agents/ '+ AGENT_ID; if (authClient) { const agentVerificationContact = { agentVerificationContact: { partnerName: P'artner name,' partnerEmailAddress: p'artner@email.com,' brandContactName: B'rand contact name,' brandContactEmailAddress: b'rand-contact@email.com,' brandWebsiteUrl: h'ttps://www.your-company-website.com,' }, }; // Setup the parameters for the API call const apiParams = { auth: authClient, name: agentName, resource: agentVerificationContact, }; bcApi.brands.agents.requestVerification(apiParams, {}, (err, response) = >{ if (err !== undefined &&err !== null) { console.dir(err); } else { // Agent found console.log(response.data); } }); } else { console.log(A'uthentication failure.)'; } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();c
Ява
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential; import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.http.HttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.businesscommunications.v1.BusinessCommunications; import com.google.api.services.businesscommunications.v1.model.Agent; import java.io.FileInputStream; import java.util.Arrays; class Main { /** * Initializes credentials used by the Business Communications API. */ private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() { BusinessCommunications.Builder builder = null; try { GoogleCredential credential = GoogleCredential .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY")); credential = credential.createScoped(Arrays.asList( "https://www.googleapis.com/auth/businesscommunications")); credential.refreshToken(); HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport(); JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance(); // Create instance of the Business Communications API builder = new BusinessCommunications .Builder(httpTransport, jsonFactory, null) .setApplicationName(credential.getServiceAccountProjectId()); // Set the API credentials and endpoint builder.setHttpRequestInitializer(credential); } catch (Exception e) { e.printStackTrace(); } return builder; } public static void main(String args[]) { try { // Create client library reference BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder(); String agentName = "brands/BRAND_ID/agents/AGENT_ID"; BusinessCommunications.Brands.Agents.RequestVerification request = builder.build().brands().agents().requestVerification(agentName, new RequestAgentVerificationRequest().setAgentVerificationContact( new AgentVerificationContact() .setPartnerName("PARTNER_NAME") .setPartnerEmailAddress("PARTNER_EMAIL") .setBrandContactName("BRAND_CONTACT_NAME") .setBrandContactEmailAddress("BRAND_CONTACT_EMAIL") .setBrandWebsiteUrl("BRAND_WEBSITE_URL"))); System.out.println(request.execute().toPrettyString()); } catch (Exception e) { e.printStackTrace(); } } }
Питон
T"""his code requests a verification of a Business Messages agent. Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/verify?method=api#verify_an_agent This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( BusinesscommunicationsBrandsAgentsRequestVerificationRequest, RequestAgentVerificationRequest, AgentVerificationContact ) # Edit the values below: BRAND_ID = E'DIT_HERE 'AGENT_ID = E'DIT_HERE 'SCOPES = [h'ttps://www.googleapis.com/auth/businesscommunications]' SERVICE_ACCOUNT_FILE = .'/service_account_key.json ' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) agents_service = BusinesscommunicationsV1.BrandsAgentsService(client) agent_name = b'rands/ '+ BRAND_ID + /'agents/ '+ AGENT_ID verification_request = agents_service.RequestVerification(BusinesscommunicationsBrandsAgentsRequestVerificationRequest( name=agent_name, requestAgentVerificationRequest=RequestAgentVerificationRequest( agentVerificationContact=AgentVerificationContact( partnerName=P'artner name,' partnerEmailAddress=p'artner@email.com,' brandContactName=B'rand contact name,' brandContactEmailAddress=b'rand-contact@email.com,' brandWebsiteUrl=h'ttps://www.your-company-website.com ' )) )) print(verification_request)c
Параметры форматирования и значения см. в brands.agents.requestVerification
.
Получить статус проверки агента
После того как вы сделаете запрос на проверку агента, вы можете проверить состояние проверки вашего агента.
Чтобы получить состояние проверки агента, выполните следующую команду. Замените переменные значениями, указанными в разделе «Предварительные условия» .
КУЛЬ
# This code gets the agent verification state. # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.locations/getVerification # Replace the __BRAND_ID__ and __AGENT_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X GET \ h"ttps://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/verification "\ -H C"ontent-Type: application/json "\ -H U"ser-Agent: curl/business-communications "\ -H $"(oauth2l header --json ./service_account_key.json businesscommunications)g"
Node.js
/** * This code snippet gets an agent verification state. * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.locations/getVerification * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = E'DIT_HERE;' const AGENT_ID = E'DIT_HERE;' const PATH_TO_SERVICE_ACCOUNT_KEY = .'/service_account_key.json;' const businesscommunications = require(b'usinesscommunications)'; const {google} = require(g'oogleapis)'; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ h'ttps://www.googleapis.com/auth/businesscommunications,' ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const agentName = b'rands/ '+ BRAND_ID + /'agents/ '+ AGENT_ID; if (authClient) { // Setup the parameters for the API call const apiParams = { auth: authClient, name: agentName + /'verification,' }; bcApi.brands.agents.getVerification(apiParams, {}, (err, response) = >{ if (err !== undefined &&err !== null) { console.dir(err); } else { // Agent found console.log(response.data); } }); } else { console.log(A'uthentication failure.)'; } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();g
Ява
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential; import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.http.HttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.businesscommunications.v1.BusinessCommunications; import com.google.api.services.businesscommunications.v1.model.Agent; import java.io.FileInputStream; import java.util.Arrays; class Main { /** * Initializes credentials used by the Business Communications API. */ private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() { BusinessCommunications.Builder builder = null; try { GoogleCredential credential = GoogleCredential .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY")); credential = credential.createScoped(Arrays.asList( "https://www.googleapis.com/auth/businesscommunications")); credential.refreshToken(); HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport(); JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance(); // Create instance of the Business Communications API builder = new BusinessCommunications .Builder(httpTransport, jsonFactory, null) .setApplicationName(credential.getServiceAccountProjectId()); // Set the API credentials and endpoint builder.setHttpRequestInitializer(credential); } catch (Exception e) { e.printStackTrace(); } return builder; } public static void main(String args[]) { try { // Create client library reference BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder(); String agentName = "brands/BRAND_ID/agents/AGENT_ID/verification"; BusinessCommunications.Brands.Agents.GetVerification request = builder.build().brands().agents().getVerification(agentName); System.out.println(request.execute().toPrettyString()); } catch (Exception e) { e.printStackTrace(); } } }
Питон
T"""his code gets the agent verification state. Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.locations/getVerification This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( BusinesscommunicationsBrandsAgentsGetVerificationRequest, ) # Edit the values below: BRAND_ID = E'DIT_HERE 'AGENT_ID = E'DIT_HERE 'SCOPES = [h'ttps://www.googleapis.com/auth/businesscommunications]' SERVICE_ACCOUNT_FILE = .'/service_account_key.json ' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) agents_service = BusinesscommunicationsV1.BrandsAgentsService(client) agent_name = b'rands/ '+ BRAND_ID + /'agents/ '+ AGENT_ID + /'verification ' verification_state = agents_service.GetVerification(BusinesscommunicationsBrandsAgentsGetVerificationRequest( name=agent_name )) print(verification_state)g
Параметры форматирования и значений см. в brands.agents.getVerification
.
Отменить запрос на проверку агента
Если вы обнаружите, что информация об агенте неверна или что агент по другим причинам не готов к проверке, вы можете отменить ожидающие запросы на проверку. Если вы отмените запрос, Business Messages уведомит об этом контактное лицо вашего бренда, и вам необходимо будет сделать новый запрос на проверку, чтобы перезапустить процесс проверки.
Чтобы отменить запрос на проверку агента, выполните следующую команду. Замените переменные значениями, указанными в разделе «Предварительные условия» .
КУЛЬ
# This code updates the verification state of an agent. # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/updateVerification # Replace the __BRAND_ID__ and __AGENT_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X PATCH \ h"ttps://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__/verification "\ -H C"ontent-Type: application/json "\ -H U"ser-Agent: curl/business-communications "\ -H $"(oauth2l header --json ./service_account_key.json businesscommunications) "\ -d {' v"erificationState:" V"ERIFICATION_STATE_UNVERIFIED "}u'
Node.js
/** * This code snippet updates the state of an agent verification. * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/updateVerification * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = E'DIT_HERE;' const AGENT_ID = E'DIT_HERE;' const PATH_TO_SERVICE_ACCOUNT_KEY = .'/service_account_key.json;' const businesscommunications = require(b'usinesscommunications)'; const {google} = require(g'oogleapis)'; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ h'ttps://www.googleapis.com/auth/businesscommunications,' ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const agentName = b'rands/ '+ BRAND_ID + /'agents/ '+ AGENT_ID; if (authClient) { // Setup the parameters for the API call const apiParams = { auth: authClient, name: agentName + /'verification,' updateMask: v'erificationState,' resource: { name: agentName, verificationState: V'ERIFICATION_STATE_UNVERIFIED,' } }; bcApi.brands.agents.updateVerification(apiParams, {}, (err, response) = >{ if (err !== undefined &&err !== null) { console.dir(err); } else { // Agent found console.log(response.data); } }); } else { console.log(A'uthentication failure.)'; } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();u
Ява
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential; import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.http.HttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.businesscommunications.v1.BusinessCommunications; import com.google.api.services.businesscommunications.v1.model.Agent; import java.io.FileInputStream; import java.util.Arrays; class Main { /** * Initializes credentials used by the Business Communications API. */ private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() { BusinessCommunications.Builder builder = null; try { GoogleCredential credential = GoogleCredential .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY")); credential = credential.createScoped(Arrays.asList( "https://www.googleapis.com/auth/businesscommunications")); credential.refreshToken(); HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport(); JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance(); // Create instance of the Business Communications API builder = new BusinessCommunications .Builder(httpTransport, jsonFactory, null) .setApplicationName(credential.getServiceAccountProjectId()); // Set the API credentials and endpoint builder.setHttpRequestInitializer(credential); } catch (Exception e) { e.printStackTrace(); } return builder; } public static void main(String args[]) { try { // Create client library reference BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder(); String agentName = "brands/BRAND_ID/agents/AGENT_ID/verification"; BusinessCommunications.Brands.Agents.UpdateVerification request = builder.build().brands().agents().updateVerification(agentName, new AgentVerification().setVerificationState("VERIFICATION_STATE_UNVERIFIED")); System.out.println(request.execute().toPrettyString()); } catch (Exception e) { e.printStackTrace(); } } }
Питон
T"""his code updates the verification state of an agent. Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/updateVerification This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( AgentVerification, BusinesscommunicationsBrandsAgentsUpdateVerificationRequest, ) # Edit the values below: BRAND_ID = E'DIT_HERE 'AGENT_ID = E'DIT_HERE 'SCOPES = [h'ttps://www.googleapis.com/auth/businesscommunications]' SERVICE_ACCOUNT_FILE = .'/service_account_key.json ' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) agents_service = BusinesscommunicationsV1.BrandsAgentsService(client) agent_name = b'rands/ '+ BRAND_ID + /'agents/ '+ AGENT_ID + /'verification ' update_request = agents_service.UpdateVerification( BusinesscommunicationsBrandsAgentsUpdateVerificationRequest( name=agent_name, updateMask=v'erificationState,' agentVerification=AgentVerification(verificationState=AgentVerification.VerificationStateValueValuesEnum.VERIFICATION_STATE_UNVERIFIED) ) ) print(update_request)u
Параметры форматирования и значения см. в brands.agents.updateVerification
.
Проверка местоположения
После проверки агента вы можете проверить местоположения, связанные с этим агентом. После проверки местоположения и запуска связанного с ним агента вы можете запустить местоположение для использования с агентом.
Если бренд является частью сети, вам необходимо добавить все местоположения этой сети, где у вас есть разрешение на включение обмена сообщениями. Чтобы проверить все добавленные вами местоположения, запросите подтверждение только для одного местоположения . Как только мы проверим это местоположение, мы автоматически проверим другие связанные местоположения, которые вы добавили.
Если после проверки вы добавите дополнительные местоположения, вам нужно будет снова запросить подтверждение местоположения. Если какие-либо местоположения не проходят автоматическую проверку, свяжитесь с нами и сообщите подробную информацию о компании и местоположении.
Контрольный список перед проверкой
Прежде чем подтвердить свое местоположение, используйте следующий контрольный список, чтобы выявить любые проблемы, которые могут возникнуть в процессе проверки.
Информация об агенте |
---|
Проверка агента Необходимый. Проверка того, что информация агента верна и что агент может представлять соответствующий бренд. См. раздел Проверка агентов и местоположений . |
Информация о местоположении |
---|
Идентификатор места Необходимый. Уникальный идентификатор местоположения в базе данных Google Адресов и на Картах Google. См. раздел Управление местоположениями . |
Разрешенные точки входа Необходимый. Необходимо только проверить, создали ли вы агента с API бизнес-коммуникаций. См. раздел Управление местоположениями . |
Предварительные условия
Прежде чем вы сможете проверить своего агента, вам необходимо собрать некоторую информацию:
name
местоположенияЕсли вы не знаете имени агента, см. раздел Список всех местоположений бренда .
Путь к ключу сервисной учетной записи вашего проекта GCP на вашем компьютере разработки.
Подтвердить местоположение
Когда вы запрашиваете подтверждение местоположения, Business Messages подтверждает, что местоположение соответствует бренду, который представляет соответствующий агент. Вы получите электронное письмо, когда проверка местоположения будет завершена.
После подтверждения местоположения вы не сможете вносить в него какие-либо обновления. Чтобы обновить местоположение после его подтверждения,связаться с нами. (Сначала необходимо войти в систему с помощью учетной записи Google Business Messages. Чтобы зарегистрировать учетную запись, см. раздел Регистрация в Business Messages .)
Чтобы проверить местоположение, выполните следующую команду. Замените переменные значениями, указанными в разделе «Предварительные требования» .
КУЛЬ
# This code requests a verification of a location. # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.locations/requestVerification # Replace the __BRAND_ID__ and __LOCATION_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X POST \ h"ttps://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/locations/__LOCATION_ID__:requestVerification "\ -H C"ontent-Type: application/json "\ -H U"ser-Agent: curl/business-communications "\ -H $"(oauth2l header --json ./service_account_key.json businesscommunications)c"
Node.js
/** * This code snippet requests a verification for a location. * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.locations/requestVerification * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = E'DIT_HERE;' const LOCATION_ID = E'DIT_HERE;' const PATH_TO_SERVICE_ACCOUNT_KEY = .'/service_account_key.json;' const businesscommunications = require(b'usinesscommunications)'; const {google} = require(g'oogleapis)'; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ h'ttps://www.googleapis.com/auth/businesscommunications,' ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const locationName = b'rands/ '+ BRAND_ID + /'locations/ '+ LOCATION_ID; if (authClient) { // Setup the parameters for the API call const apiParams = { auth: authClient, name: locationName, }; bcApi.brands.locations.requestVerification(apiParams, {}, (err, response) = >{ if (err !== undefined &&err !== null) { console.dir(err); } else { // Agent found console.log(response.data); } }); } else { console.log(A'uthentication failure.)'; } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();c
Ява
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential; import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.http.HttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.businesscommunications.v1.BusinessCommunications; import com.google.api.services.businesscommunications.v1.model.Agent; import java.io.FileInputStream; import java.util.Arrays; class Main { /** * Initializes credentials used by the Business Communications API. */ private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() { BusinessCommunications.Builder builder = null; try { GoogleCredential credential = GoogleCredential .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY")); credential = credential.createScoped(Arrays.asList( "https://www.googleapis.com/auth/businesscommunications")); credential.refreshToken(); HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport(); JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance(); // Create instance of the Business Communications API builder = new BusinessCommunications .Builder(httpTransport, jsonFactory, null) .setApplicationName(credential.getServiceAccountProjectId()); // Set the API credentials and endpoint builder.setHttpRequestInitializer(credential); } catch (Exception e) { e.printStackTrace(); } return builder; } public static void main(String args[]) { try { // Create client library reference BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder(); String locationName = "brands/BRAND_ID/locations/LOCATION_ID/verification"; BusinessCommunications.Brands.Locations.RequestVerification request = builder.build().brands().locations().requestVerification(locationName, new RequestLocationVerificationRequest()); System.out.println(request.execute().toPrettyString()); } catch (Exception e) { e.printStackTrace(); } } }
Питон
T"""his code requests a verification of a location. Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.locations/requestVerification This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( BusinesscommunicationsBrandsLocationsRequestVerificationRequest, RequestLocationVerificationRequest ) # Edit the values below: BRAND_ID = E'DIT_HERE 'LOCATION_ID = E'DIT_HERE 'SCOPES = [h'ttps://www.googleapis.com/auth/businesscommunications]' SERVICE_ACCOUNT_FILE = .'/service_account_key.json ' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) locations_service = BusinesscommunicationsV1.BrandsLocationsService(client) location_name = b'rands/ '+ BRAND_ID + /'locations/ '+ LOCATION_ID verification_request = locations_service.RequestVerification(BusinesscommunicationsBrandsLocationsRequestVerificationRequest( name=location_name, requestLocationVerificationRequest=RequestLocationVerificationRequest() )) print(verification_request)c
Параметры форматирования и значения см. в brands.locations.requestVerification
.
Получить статус проверки местоположения
После того как вы сделаете запрос на проверку местоположения, вы можете проверить состояние проверки местоположения.
Чтобы получить состояние проверки местоположения, выполните следующую команду. Замените переменные значениями, указанными в разделе «Предварительные требования» .
КУЛЬ
# This code gets the verification state of a location. # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.locations/getVerification # Replace the __BRAND_ID__ and __LOCATION_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X GET \ h"ttps://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/locations/__LOCATION_ID__/verification "\ -H C"ontent-Type: application/json "\ -H U"ser-Agent: curl/business-communications "\ -H $"(oauth2l header --json ./service_account_key.json businesscommunications)g"
Node.js
/** * This code snippet gets the verification state of a location. * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.locations/getVerification?hl=en * * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js * Business Communications client library. */ /** * Edit the values below: */ const BRAND_ID = E'DIT_HERE;' const LOCATION_ID = E'DIT_HERE;' const PATH_TO_SERVICE_ACCOUNT_KEY = .'/service_account_key.json;' const businesscommunications = require(b'usinesscommunications)'; const {google} = require(g'oogleapis)'; // Initialize the Business Communications API const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({}); // Set the scope that we need for the Business Communications API const scopes = [ h'ttps://www.googleapis.com/auth/businesscommunications,' ]; // Set the private key to the service account file const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY); async function main() { const authClient = await initCredentials(); const locationName = b'rands/ '+ BRAND_ID + /'locations/ '+ LOCATION_ID; if (authClient) { // Setup the parameters for the API call const apiParams = { auth: authClient, name: locationName + /'verification,' }; bcApi.brands.locations.getVerification(apiParams, {}, (err, response) = >{ if (err !== undefined &&err !== null) { console.dir(err); } else { // Agent found console.log(response.data); } }); } else { console.log(A'uthentication failure.)'; } } /** * Initializes the Google credentials for calling the * Business Messages API. */ async function initCredentials() { // Configure a JWT auth client const authClient = new google.auth.JWT( privatekey.client_email, null, privatekey.private_key, scopes, ); return new Promise(function(resolve, reject) { // Authenticate request authClient.authorize(function(err, tokens) { if (err) { reject(false); } else { resolve(authClient); } }); }); } main();g
Ява
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential; import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.http.HttpTransport; import com.google.api.client.json.jackson2.JacksonFactory; import com.google.api.services.businesscommunications.v1.BusinessCommunications; import com.google.api.services.businesscommunications.v1.model.Agent; import java.io.FileInputStream; import java.util.Arrays; class Main { /** * Initializes credentials used by the Business Communications API. */ private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() { BusinessCommunications.Builder builder = null; try { GoogleCredential credential = GoogleCredential .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY")); credential = credential.createScoped(Arrays.asList( "https://www.googleapis.com/auth/businesscommunications")); credential.refreshToken(); HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport(); JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance(); // Create instance of the Business Communications API builder = new BusinessCommunications .Builder(httpTransport, jsonFactory, null) .setApplicationName(credential.getServiceAccountProjectId()); // Set the API credentials and endpoint builder.setHttpRequestInitializer(credential); } catch (Exception e) { e.printStackTrace(); } return builder; } public static void main(String args[]) { try { // Create client library reference BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder(); String locationName = "brands/BRAND_ID/locations/LOCATION_ID/verification"; BusinessCommunications.Brands.Locations.GetVerification request = builder.build().brands().locations().getVerification(locationName); System.out.println(request.execute().toPrettyString()); } catch (Exception e) { e.printStackTrace(); } } }
Питон
T"""his code gets the verification state of a location. Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.locations/getVerification This code is based on the https://github.com/google-business-communications/python-businessmessages Python Business Messages client library. """ from oauth2client.service_account import ServiceAccountCredentials from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1 from businesscommunications.businesscommunications_v1_messages import ( BusinesscommunicationsBrandsLocationsGetVerificationRequest, ) # Edit the values below: BRAND_ID = E'DIT_HERE 'LOCATION_ID = E'DIT_HERE 'SCOPES = [h'ttps://www.googleapis.com/auth/businesscommunications]' SERVICE_ACCOUNT_FILE = .'/service_account_key.json ' credentials = ServiceAccountCredentials.from_json_keyfile_name( SERVICE_ACCOUNT_FILE, scopes=SCOPES) client = BusinesscommunicationsV1(credentials=credentials) locations_service = BusinesscommunicationsV1.BrandsLocationsService(client) location_name = b'rands/ '+ BRAND_ID + /'locations/ '+ LOCATION_ID + /'verification ' verification_state = locations_service.GetVerification(BusinesscommunicationsBrandsLocationsGetVerificationRequest( name=location_name )) print(verification_state)g
Параметры форматирования и значения см. в brands.locations.getVerification
.
Следующие шаги
После проверки вашего агента и всех связанных с ним местоположений вы готовы запустить их, чтобы они могли общаться с пользователями.