हम 31 जुलाई, 2024 को Google Business Messages की सेवा बंद कर देंगे. यहां ज़्यादा जानकारी दी गई है.

इस पेज का अनुवाद Cloud Translation API से किया गया है.

ब्रैंड मैनेज करने के लिए एजेंट बनाएं

पार्टनर के तौर पर रजिस्टर करने के बाद, जिन ब्रैंड को मैनेज किया जा रहा है उनके लिए Business Messages एजेंट बनाकर, बातचीत की सुविधा चालू की जा सकती है.

एजेंट, बातचीत करने वाली ऐसी इकाई है जिससे उपयोगकर्ता इंटरैक्ट करते हैं. आप हर उस ब्रैंड के लिए एक एजेंट बनाते हैं जिसे आप मैनेज करते हैं. BusinessCommunications API की मदद से एजेंट बनाए और मैनेज किए जा सकते हैं. साथ ही, Business Messages API से, अपने एजेंट के लिए मैसेज सेवा को कंट्रोल किया जा सकता है.

एजेंट में किसी ब्रैंड के कारोबार से जुड़े काम शामिल होते हैं. जैसे, ऑनलाइन मदद देना और दुकान या स्टोर (अगर कोई है) का पता लगाना. हर मैसेज में वह कॉन्टेक्स्ट होता है जिससे उपयोगकर्ता ने बातचीत शुरू की है. आपका मैसेज रूटिंग इन्फ़्रास्ट्रक्चर यह पता लगा सकता है कि क्या उपयोगकर्ता ने कारोबार की किसी खास जगह को देखा है या सामान्य सहायता मांगी है. साथ ही, वह मैसेज को सही जगह पर भेज सकता है.

उदाहरण के लिए, अगर आप Growing ट्री बैंक ब्रैंड को मैनेज करते हैं, जिसकी एक वेबसाइट और दो जगहों पर मौजूद है, तो आपको एक "Growing ट्री बैंक" एजेंट बनाना होगा. उपयोगकर्ता, सामान्य या जगह के हिसाब से की गई खोजों से एजेंट को देख सकते हैं. साथ ही, वे देख सकते हैं कि उपयोगकर्ता ने जिस कॉन्टेक्स्ट के साथ एजेंट को ढूंढा है उसे आपके वेबहुक पर हर मैसेज के साथ भेजा जाएगा. उस कॉन्टेक्स्ट का इस्तेमाल, उस जगह के स्टाफ़ के पास या वेबसाइट की सहायता टीम के पास मैसेज भेजने के लिए किया जाता है. सहायता टीम उस व्यक्ति का जवाब देती है और उसके साथ बातचीत जारी रखती है.

दर्शकों की उम्मीद

एजेंट बनाने से पहले, Business Messages से एजेंट की उम्मीदों के बारे में जान लें.

एजेंट को Business Messages के लिए बातचीत डिज़ाइन में, डिज़ाइन से जुड़े दिशा-निर्देशों का पालन करना चाहिए.
एजेंट के पास ऐसे सवालों के जवाब देने के लिए मानवीय प्रतिनिधि उपलब्ध होने चाहिए जब ऑटोमेशन की सुविधा किसी अनुरोध को पूरा न कर पाए या जब उपयोगकर्ताओं का अनुरोध पूरा न हो.

ध्यान दें: अगर आपका एजेंट, प्रतिनिधि के साथ काम नहीं करता, तो उसे जगह के हिसाब से एंट्री पॉइंट या बिना लोकल एंट्री पॉइंट से लॉन्च नहीं किया जा सकता. अपने एजेंट के लिए, मानवीय इंटरैक्शन का टाइप तय करें, ताकि यह Google के मैनेज किए जाने वाले एंट्री पॉइंट पर दिखे.
एजेंट को कम से कम 80% की ग्राहक संतुष्टि रेटिंग (सीएसएटी) और मेट्रिक के हिसाब से कम से कम 95% की, व्यापारी/कंपनी के जवाब की दर (एमआरआर) बनाए रखनी चाहिए.

एजेंट बनाएं

एजेंट बनाने के लिए, आपको ब्रैंड के बारे में जानकारी इकट्ठा करके सबमिट करनी होगी. साथ ही, आपको यह भी बताना होगा कि लोगों को एजेंट कैसा दिखेगा.

अगर एक से ज़्यादा ब्रैंड मैनेज किए जा रहे हैं, तो हर ब्रैंड के लिए एजेंट बनाने के तरीके को दोहराएं.

ज़रूरी शर्तें

जिन ब्रैंड को मैनेज करने का अधिकार आपके पास है उनके लिए एजेंट बनाने से पहले, आपको कुछ जानकारी इकट्ठा करनी होगी:

डेवलपमेंट एनवायरमेंट

आपके डेवलपमेंट एनवायरमेंट के बारे में जानकारी.

GCP प्रोजेक्ट, जिसमें Business Communications API चालू है

एपीआई चालू करने के लिए, Business Messages पर रजिस्टर करें देखें.
आपकी डेवलपमेंट मशीन पर, आपके GCP प्रोजेक्ट के सेवा खाता कुंजी का पाथ

ब्रैंड की जानकारी

एजेंट के ब्रैंड की जानकारी.

ब्रैंड का नाम
ब्रैंड की वेबसाइट
वेबसाइट पर संपर्क करने के विकल्प (जैसा कि OPTION में बताया गया है)
उपभोक्ता के लिए फ़ोन नंबर
कॉल डिफ़्लेक्शन के लिए फ़ोन नंबर चालू किए गए

एजेंट के दिखने का तरीका और नीतियां

इस बारे में जानकारी कि लोगों को एजेंट कैसे दिखता है और वह कैसे काम करता है.

एजेंट का नाम, जैसा आपको उपयोगकर्ताओं के साथ बातचीत में दिखाना है
निजता नीति, "https://" से शुरू होने वाले सार्वजनिक तौर पर उपलब्ध यूआरएल के तौर पर
(सुझाया गया) एजेंट का लोगो (1024x1024 पिक्सल), सार्वजनिक तौर पर उपलब्ध यूआरएल के तौर पर

किसी बातचीत में, लोगो 1024 पिक्सल व्यास वाले सर्कल के रूप में दिखते हैं. इस बात का ध्यान रखें कि आपका लोगो गोल आकार में दिखता हो.

अपने लोगो की जांच करना
अपने लोगो के लिए यूआरएल डालें और देखें कि वह उपयोगकर्ताओं को कैसा दिखेगा.

ध्यान दें: इमेज को होस्ट करने वाले वेब सर्वर को, इमेज को अन्य वेबसाइटों पर एम्बेड करने की अनुमति ज़रूर देनी चाहिए.
(ज़रूरी नहीं) कस्टम एजेंट आईडी, जो वेबहुक पर मिलने वाले मैसेज में ब्रैंड की पहचान करता है

एजेंट से इंटरैक्शन

इस बारे में जानकारी कि आपका एजेंट, लोगों से कैसे इंटरैक्ट करता है.

आपका एजेंट आम तौर पर जिस स्थान-भाषा में काम करता है उसे दो वर्णों वाले ISO 639-1 भाषा कोड से बताया जाता है
एजेंट का वेलकम मैसेज

एजेंट लोगों का स्वागत करने के लिए क्या कहता है?
एजेंट से बातचीत शुरू करने के लिए पॉइंट लिखें

एजेंट से बातचीत करने के लिए, सुझावों की सूची बातचीत की जानकारी वाले चिप के तौर पर होती है. इस बारे में SuggestedReply में बताया गया है
- चिप में उपयोगकर्ता को दिखने वाला टेक्स्ट
- पोस्टबैक डेटा, यानी अगर उपयोगकर्ता चिप पर टैप करता है, तो मैसेज पेलोड में आपके वेबहुक पर वापस भेजी गई स्ट्रिंग
ऑटोमेटेड और लाइव चैट का समय
- रोज़ के शुरुआत का समय, TimeOfDay ऑब्जेक्ट के तौर पर
  
  उदाहरण के लिए, सुबह 8:15 बजे है
```
{
  "hours": 8,
  "minutes": 15,
}
```
- रोज़ के खत्म होने का समय, TimeOfDay ऑब्जेक्ट के तौर पर
  
  उदाहरण के लिए, शाम 7:30 बजे
```
{
  "hours": 19,
  "minutes": 30,
}
```
- शुरू होने का दिन, हफ़्ते के पहले दिन से एजेंट चैट के लिए उपलब्ध होता है (जैसा कि DayOfWeek में बताया गया है)
- खत्म होने का दिन, हफ़्ते के आखिरी दिन जिस दिन एजेंट चैट के लिए उपलब्ध होगा (जैसा कि DayOfWeek में बताया गया है)
- वह टाइम ज़ोन जिसमें एजेंट काम करता है (जैसा कि आईएएनए टाइम ज़ोन डेटाबेस में बताया गया है, उदाहरण के लिए "अमेरिका/Los_Angeles")

एजेंट के एंट्री पॉइंट

इस बारे में जानकारी कि उपयोगकर्ता, एजेंट के साथ बातचीत कहां से शुरू कर सकते हैं.

एजेंट के लिए अनुमति वाले एंट्री पॉइंट, जहां लोग एजेंट (NON_LOCAL और/या LOCATION) से बातचीत शुरू कर सकते हैं

ध्यान दें: जगह के हिसाब से बातचीत की सुविधा को चालू करने के लिए, LOCATION एंट्री पॉइंट ज़रूरी है.

NON_LOCAL एंट्री पॉइंट के बारे में जानकारी (Google Ads के एंट्री पॉइंट पर लागू नहीं होती).

NON_LOCAL एंट्री पॉइंट तक इलाके के हिसाब से ऐक्सेस करने पर पाबंदी लगाने के लिए, अनुमति वाले इलाके (CLDR क्षेत्र कोड के तौर पर).

एजेंट किसी भी इलाके में, सिर्फ़ एक ही फ़ोन नंबर जुड़ सकता है. अगर आपको क्षेत्र के आधार पर कोई अलग फ़ोन नंबर चाहिए, तो आपको हर क्षेत्र के लिए एक अलग एजेंट बनाना होगा.

सभी उपलब्ध क्षेत्रों में NON_LOCAL एंट्री पॉइंट चालू करने के लिए, दुनिया के क्षेत्र के कोड के लिए 001 का इस्तेमाल करें.

oauth2l को इंस्टॉल और टेस्ट करना

इस साइट के दस्तावेज़ में मौजूद सभी कर्ल अनुरोध, पुष्टि करने के लिए oauth2l का इस्तेमाल करते हैं. अगर आपको Business Communications और Business Messages API से कनेक्ट करने के लिए, कमांड लाइन का इस्तेमाल करना है, तो oauth2l इंस्टॉल करें.

Python 3 के साथ oauth2l इंस्टॉल करने के लिए,

oauth2l डाउनलोड करें.
डायरेक्ट्री को "./oauth2l/python" में बदलें.
नीचे दिए गए निर्देश की मदद से, oauth2l इंस्टॉल करें.
```
sudo python setup.sh build && sudo python setup.py install
```
यह जांच करें कि oauth2l, ऑथराइज़ेशन टोकन जनरेट कर सकता है या नहीं.
```
oauth2l header --json resources/bm-agent-service-account-credentials.json businesscommunications
```
पुष्टि करें कि आउटपुट, फ़ॉर्म का ऑथराइज़ेशन टोकन बनाता है:
```
Authorization: Bearer AUTHORIZATION_BEARER_TOKEN
```

अलग-अलग ऑपरेटिंग सिस्टम के लिए, oauth2l इंस्टॉल करने के और भी तरीके हैं. आगे बढ़ने से पहले, पक्का करें कि आपके पास सेवा खाते के JSON क्रेडेंशियल पर आधारित ऑथराइज़ेशन टोकन जनरेट करने का विकल्प हो.

एजेंट बनाएं

अपनी जानकारी इकट्ठा करने के बाद, अपना एजेंट बनाएं.

वह ब्रैंड बनाएं जिसका प्रतिनिधित्व एजेंट करता है. अगर ब्रैंड पहले से मौजूद है, तो ब्रैंड के name का इस्तेमाल करें और अगले चरण पर जाएं.

टर्मिनल में, यह निर्देश चलाएं:

cURL


# This code creates a brand.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/create

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

curl -X POST "https://businesscommunications.googleapis.com/v1/brands" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
-d '{
  "displayName": "My first brand curl"
}'create-brand.sh

Node.js


/**
 * This code snippet creates a brand.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/create
 *
 * 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 PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// 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 = [
  'https://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();

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      resource: {
        displayName: 'My first brand',
      },
    };

    bcApi.brands.create(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Brand created
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Communcations 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('Failed to connect');
      } else {
        resolve(authClient);
      }
    });
  })
}

main();create-brand.js

Java

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.Brand;
import java.io.FileInputStream;
import java.util.Arrays;
import java.util.UUID;

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();

      // Create a request to create a new brand
      BusinessCommunications.Brands.Create request = builder
          .build().brands().create(new Brand().setDisplayName("BRAND_NAME"));

      Brand brand = request.execute();

      // Print newly created brand object
      System.out.println(brand.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

यह कोड Java Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Python


"""This code creates a brand.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/create

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 (
    Brand)

# Edit the values below:
SCOPES = ['https://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)

brands_service = BusinesscommunicationsV1.BrandsService(client)

brand = brands_service.Create(Brand(displayName='My first brand'))

print(brand)create-brand.py

एपीआई से मिली name वैल्यू को सेव करें. आपको अपडेट करने या एजेंट बनाने के लिए इसकी ज़रूरत होगी.

ब्रैंड को अपडेट करने या देखने के लिए, brands देखें.

एजेंट बनाएं. BRAND_ID की जगह ब्रैंड की name वैल्यू के उस हिस्से का इस्तेमाल करें जो "brands/" के बाद आता है. उदाहरण के लिए, अगर name "brands/12345" है, तो ब्रैंड आईडी "12345" होगा.

टर्मिनल में, यह निर्देश चलाएं:

cURL


# This code creates a Business Messages agent.
# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/agents?method=api#create_the_agent

# Replace the __BRAND_ID__ with a brand id that you can create agents for
# Make sure a service account key file exists at ./service_account_key.json

curl -X POST "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
-d '{
  "displayName": "My first agent",
  "businessMessagesAgent": {
    "logoUrl": "https://developers.google.com/identity/images/g-logo.png",
    "entryPointConfigs": [
      {
        "allowedEntryPoint": "NON_LOCAL"
      }
    ],
    "customAgentId": "'$(uuidgen)'",
    "nonLocalConfig": {
      "regionCodes": [
        "US",
        "CA"
      ],
      "contactOption": {
        "url": "https://www.your-company-website.com",
        "options": [
          "EMAIL",
          "PHONE"
        ]
      },
      "enabledDomains": [
        "your-company-website.com"
      ],
      "phoneNumber": {
        "number": "+10000000000"
      },
      "callDeflectionPhoneNumbers": [
        {
          "number": "+10000000000"
        },
        {
          "number": "+10000000000"
        }
      ]
    },
    "conversationalSettings": {
      "en": {
        "welcomeMessage": {
          "text": "This is a sample welcome message"
        },
        "privacyPolicy": {
          "url": "https://www.your-company-website.com/privacy"
        },
        "conversationStarters": [
          {
            "suggestion": {
              "reply": {
                "text": "Option 1",
                "postbackData": "postback_option_1"
              }
            }
          }
        ]
      }
    },
    "defaultLocale": "en",
    "primaryAgentInteraction": {
      "interactionType": "HUMAN",
      "humanRepresentative": {
        "humanMessagingAvailability": {
          "hours": [
            {
              "startTime": {
                "hours": 8,
                "minutes": 30
              },
              "endTime": {
                "hours": 20,
                "minutes": 0
              },
              "timeZone": "America/Los_Angeles",
              "startDay": "MONDAY",
              "endDay": "SATURDAY"
            }
          ]
        }
      }
    }
  }
}'create-agent-bm.sh

Node.js


/**
 * This code snippet creates a Business Messages agent.
 * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/agents?method=api#create_the_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 = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');
const uuidv4 = require('uuid').v4;

// 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 = [
  'https://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 brandName = 'brands/' + BRAND_ID;

  if (authClient) {
    const agentObject = {
      displayName: 'My first agent',
      businessMessagesAgent: {
        customAgentId: uuidv4(), // Optional
        logoUrl: 'https://developers.google.com/identity/images/g-logo.png',
        entryPointConfigs: [
          {
            allowedEntryPoint: 'NON_LOCAL',
          }
        ],
        nonLocalConfig: { // Configuration options for launching on non-local entry points
          // List of phone numbers for call deflection, values must be globally unique
          callDeflectionPhoneNumbers: [
            { number: '+10000000000' },
            { number: '+10000000001' },
          ],
          // Contact information for the agent that displays with the messaging button
          contactOption: {
            options: [
              'EMAIL',
              'PHONE'
            ],
            url: 'https://www.your-company-website.com',
          },
          // Domains enabled for messaging within Search, values must be globally unique
          enabledDomains: [ 'your-company-website.com' ],
          // Agent's phone number. Overrides the `phone` field
          // for conversations started from non-local entry points
          phoneNumber: { number: '+10000000000' },
          // List of CLDR region codes for countries where the agent is allowed to launch `NON_LOCAL` entry points
          regionCodes: [ 'US', 'CA' ]
        },
        // Must match a conversational setting locale
        defaultLocale: 'en',
        conversationalSettings: {
          en: {
            privacyPolicy: { url: 'https://www.your-company-website.com/privacy' },
            welcomeMessage: { text: 'This is a sample welcome message' },
            conversationStarters: [
              {
                suggestion: {
                  reply: {
                    text: 'Option 1',
                    postbackData: 'postback_option_1',
                  },
                },
              },
            ],
          },
        },
        primaryAgentInteraction: {
          interactionType: 'HUMAN',
          humanRepresentative: {
            humanMessagingAvailability: {
              hours: [
                {
                  startTime: {
                    hours: 8,
                    minutes: 30
                  },
                  startDay: 'MONDAY',
                  endDay: 'SATURDAY',
                  endTime: {
                    hours: 20,
                    minutes: 0
                  },
                  timeZone: 'America/Los_Angeles',
                },
              ],
            },
          },
        },
      },
    };

    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      parent: brandName,
      resource: agentObject
    };

    bcApi.brands.agents.create(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent created
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication 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();create-agent-bm.js

Java

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.Brand;
import com.google.common.collect.ImmutableMap;
import java.io.FileInputStream;
import java.util.Arrays;
import java.util.UUID;

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 brandName = "BRAND_ID";

      BusinessCommunications.Brands.Agents.Create request = builder
          .build().brands().agents().create(brandName,
              new Agent()
                  .setDisplayName("AGENT_NAME")
                  .setBusinessMessagesAgent(new BusinessMessagesAgent()
                      .setCustomAgentId("CUSTOM_ID") // Optional
                      .setLogoUrl("LOGO_URL")
                      .setEntryPointConfigs(Arrays.asList(
                        new BusinessMessagesEntryPointConfig()
                            .setAllowedEntryPoint(
                                "ENTRY_POINT_1"),
                        new BusinessMessagesEntryPointConfig()
                            .setAllowedEntryPoint(
                                "ENTRY_POINT_2")
                      ))
                      // Configuration options for launching on non-local entry points
                      .setNonLocalConfig(new NonLocalConfig()
                        // List of phone numbers for call deflection, values must be globally unique
                        .setCallDeflectionPhoneNumbers(Arrays.asList(new Phone().setNumber("DEFLECTION_PHONE_NUMBER_1"),
                            new Phone().setNumber("DEFLECTION_PHONE_NUMBER_2")))
                        // Contact information for the agent that displays with the messaging button
                        .setContactOption(new ContactOption().setOptions(Arrays.asList(
                            "CONTACT_OPTION_1",
                            "CONTACT_OPTION_2")
                        ).setUrl("WEBSITE_URL"))
                        // Domains enabled for messaging within Search, values must be globally unique
                        .setEnabledDomains(Arrays.asList("ENABLED_DOMAIN_1", "ENABLED_DOMAIN_2"))
                        // Agent's phone number. Overrides the `phone` field for
                        // conversations started from non-local entry points
                        .setPhoneNumber(new Phone().setNumber("CONTACT_PHONE_NUMBER"))
                        // List of regions where this agent will be available
                        .setRegionCodes(Arrays.asList("REGION_CODE")))
                      .setDefaultLocale("LOCALE")
                      // Create a map between the language code and the initial conversation settings
                      .setConversationalSettings(ImmutableMap.of("LOCALE",
                        new ConversationalSetting()
                            .setPrivacyPolicy(new PrivacyPolicy().setUrl("PRIVACY_POLICY_URL"))
                            .setWelcomeMessage(new WelcomeMessage().setText("WELCOME_MESSAGE"))
                            .setConversationStarters(Arrays.asList(
                                new ConversationStarters().setSuggestion(new Suggestion()
                                    .setReply(new SuggestedReply().setText("SUGGESTION_TEXT").setPostbackData("SUGGESTION_POSTBACK_DATA")))
                            ))))
                      .setPrimaryAgentInteraction(new SupportedAgentInteraction()
                          .setInteractionType(InteractionType.HUMAN.toString())
                          .setHumanRepresentative(new HumanRepresentative()
                              .setHumanMessagingAvailability(new MessagingAvailability()
                                  // Create a list of available hours
                                  .setHours(Arrays.asList(new Hours()
                                    .setStartTime(new TimeOfDay().setHours(START_TIME_HOURS).setMinutes(START_TIME_MINUTES))
                                    .setStartDay("BEGINNING_DAY_OF_WEEK")
                                    .setEndDay("END_DAY_OF_WEEK")
                                    .setEndTime(new TimeOfDay().setHours(END_TIME_HOURS).setMinutes(END_TIME_MINUTES))
                                    .setTimeZone("TIME_ZONE"))))))

                  ));

      Agent agent = request.execute();

      System.out.println(agent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

यह कोड Java Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Python


"""This code creates a Business Messages agent.

Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/agents?method=api#create_the_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 (
    Agent, BusinesscommunicationsBrandsAgentsCreateRequest,
    BusinessMessagesAgent, BusinessMessagesEntryPointConfig,
    ContactOption, ConversationalSetting, ConversationStarters,
    Hours, HumanRepresentative, MessagingAvailability,
    NonLocalConfig, Phone, PrivacyPolicy, Suggestion,
    SuggestedReply, SupportedAgentInteraction,
    TimeOfDay, WelcomeMessage
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
SCOPES = ['https://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)

brand_name = 'brands/ '+ BRAND_ID

agent = Agent(
    displayName='My first agent',
    businessMessagesAgent=BusinessMessagesAgent(
        customAgentId='CUSTOM_ID', # Optional
        logoUrl='https://developers.google.com/identity/images/g-logo.png',
        entryPointConfigs=[BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.LOCATION
        ), BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.NON_LOCAL
        )],
        nonLocalConfig=NonLocalConfig(
            # List of phone numbers for call deflection, values must be globally unique
            # Generating a random phone number for demonstration purposes
            # This should be replaced with a real brand phone number
            callDeflectionPhoneNumbers=[Phone(number='+10000000000'),
              Phone(number='+10000000001')],
            # Contact information for the agent that displays with the messaging button
            contactOption=ContactOption(
                    options=[ContactOption.OptionsValueListEntryValuesEnum.EMAIL,
                        ContactOption.OptionsValueListEntryValuesEnum.PHONE],
                    url='https://www.your-company-website.com'
                ),
            # Domains enabled for messaging within Search, values must be globally unique
            # Generating a random URL for demonstration purposes
            # This should be replaced with a real brand URL
            enabledDomains=['your-company-website.com'],
            # Agent's phone number. Overrides the `phone` field for conversations started from non-local entry points
            phoneNumber=Phone(number='+10000000000'),
            # List of CLDR region codes for countries where the agent is allowed to launch `NON_LOCAL` entry points.
            # Example is for launching in Canada and the USA
            regionCodes=['US', 'CA']
        ),
        defaultLocale='en',
        conversationalSettings=BusinessMessagesAgent.ConversationalSettingsValue(
            additionalProperties=[BusinessMessagesAgent.ConversationalSettingsValue.AdditionalProperty(
                key='en',
                value=ConversationalSetting(
                    privacyPolicy=PrivacyPolicy(url='https://www.your-company-website.com/privacy'),
                    welcomeMessage=WelcomeMessage(text='This is a sample welcome message'),
                    conversationStarters=[
                        ConversationStarters(
                            suggestion=Suggestion(
                                reply=SuggestedReply(text='Option 1',
                                                     postbackData='postback_option_1')
                            )
                        )
                    ]
                )
            )]
        ),
        primaryAgentInteraction=SupportedAgentInteraction(
            interactionType=SupportedAgentInteraction.InteractionTypeValueValuesEnum.HUMAN,
            humanRepresentative=HumanRepresentative(
                humanMessagingAvailability=MessagingAvailability(hours=[
                        Hours(
                            startTime=TimeOfDay(hours=8, minutes=30),
                            startDay=Hours.StartDayValueValuesEnum.MONDAY,
                            endDay=Hours.EndDayValueValuesEnum.SATURDAY,
                            endTime=TimeOfDay(hours=20, minutes=0),
                            timeZone='America/Los_Angeles'
                        )
                    ])
            )
        ),
    )
)

new_agent = agents_service.Create(
    BusinesscommunicationsBrandsAgentsCreateRequest(
        agent=agent,
        parent=brand_name
    )
)

print(new_agent)create-agent-bm.py

फ़ॉर्मैटिंग और वैल्यू के विकल्पों के लिए, brands.agents देखें.

अगर ब्रैंड में ऐसी जगहें हैं जिन्हें आपको अपने एजेंट से जोड़ना है, तो जगहें जोड़ें देखें.

उदाहरण: Growing ट्री बैंक के लिए कोई एजेंट बनाएं

curl -X POST "https://businesscommunications.googleapis.com/v1/brands" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key.json businesscommunications)" \
-d "{
    'displayName': 'Growing Tree Bank'
}"

# Fetch returned brand name value of "brands/12345"

curl -X POST "https://businesscommunications.googleapis.com/v1/brands/12345/agents" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key.json businesscommunications)" \
-d "{
    'displayName': 'Growing Tree Bank',
    'businessMessagesAgent': {
        'logoUrl': 'https://www.growingtreebank.com/images/logo.png',
        'entryPointConfigs': [
          {
            'allowedEntryPoint': 'NON_LOCAL',
          },
          {
            'allowedEntryPoint': 'LOCATION',
          },
        ],
        'customAgentId': 'growing-tree-bank',
        'nonLocalConfig': {
            'regionCodes': ['001'],
            'contactOption': {
                'url': 'https://www.growingtreebank.com',
                'options': [
                    'EMAIL',
                    'PHONE',
                ],
            },
            'enabledDomains': [
                'https://www.growingtreebank.com',
            ],
            'phoneNumber': {
                'number': '+12223334444',
            },
            'callDeflectionPhoneNumbers': [
                {
                    'number': '+12223334444',
                },
                {
                    'number': '+56667778888',
                },
            ],
        },
        'conversationalSettings': {
            'en': {
                'welcomeMessage': {
                    'text': 'Thanks for contacting Growing Tree Bank. What can I help with today?',
                },
                'privacyPolicy': {
                    'url': 'https://www.growingtreebank.com/privacy',
                },
                'conversationStarters': [
                    {
                        'suggestion': {
                            'reply': {
                                'text': 'Set up an account',
                                'postbackData': 'new-account',
                            },
                        },
                    },
                ],
            },
        },
        'defaultLocale': 'en',
        'primaryAgentInteraction': {
            'interactionType': 'BOT',
            'botRepresentative': {
                'botMessagingAvailability': {
                    'hours': [
                        {
                            'startTime': {
                                'hours': '8',
                                'minutes': '00',
                            },
                            'endTime': {
                                'hours': '17',
                                'minutes': '30',
                            },
                            'timeZone': 'America/Los_Angeles',
                            'startDay': 'MONDAY',
                            'endDay': 'FRIDAY',
                        },
                    ],
                },
            },
        },
    },
}"

ज़रूरी जानकारी सेव करें

एजेंट बनाने पर, Business Communications एपीआई आपके एजेंट की वैल्यू दिखाता है. इनमें name और testUrls शामिल हैं.

एजेंट-लेवल का वेबहुक सेट करें

एजेंट को भेजे गए मैसेज, आपको वेबहुक पर मिलते हैं. इसके बजाय, अगर आपको किसी खास एजेंट के मैसेज किसी दूसरे वेबहुक पर पहुंचाना है, तो एजेंट-लेवल वेबहुक सेट करें.

एजेंट-लेवल वेबहुक सेट करने के लिए, डेवलपर कंसोल का इस्तेमाल करें.

एजेंट को टेस्ट करें

हर एजेंट के टेस्ट यूआरएल होते हैं, जिनसे आपको यह पता चलता है कि उस एजेंट के साथ हुई बातचीत उपयोगकर्ताओं को कैसी दिखती है. साथ ही, इससे आपको मैसेज सेवा के इन्फ़्रास्ट्रक्चर की पुष्टि करने का मौका मिलता है.

TestUrl में url और surface एट्रिब्यूट होते हैं. iOS डिवाइस से जांच करने के लिए, SURFACE_IOS_MAPS के सरफ़ेस वैल्यू वाले टेस्ट यूआरएल का इस्तेमाल करें. जिस iOS डिवाइस पर Google Maps ऐप्लिकेशन इंस्टॉल है उस पर यूआरएल खोलने से एजेंट से बातचीत पूरी तरह से शुरू हो जाती है.

Android डिवाइसों में दो टेस्ट यूआरएल होते हैं. SURFACE_ANDROID_MAPS की surface वैल्यू वाले यूआरएल, Google Maps पर खुली हुई बातचीत दिखाते हैं. ये बातचीत वाले ऐसे एंट्री पॉइंट होते हैं जो Google Maps पर दिखते हैं. SURFACE_ANDROID_WEB की surface वैल्यू वाले यूआरएल, ओवरले कॉन्वर्सेशनल व्यू में खुली हुई बातचीत दिखाते हैं और बाकी सभी एंट्री पॉइंट दिखाते हैं.

बातचीत वाला प्लैटफ़ॉर्म खुलने के बाद, बातचीत में ब्रैंडिंग से जुड़ी वह सारी जानकारी शामिल होती है जो उपयोगकर्ताओं को दिखती है. जब एजेंट को कोई मैसेज भेजा जाता है, तो आपके वेबहुक को मैसेज मिलता है. इसमें उपयोगकर्ताओं से बातचीत करते समय ज़रूरत के मुताबिक पूरा JSON पेलोड शामिल होता है.

एजेंट का टेस्ट यूआरएल खोलने के लिए, लिंक पर टैप करें या मोबाइल डिवाइस पर Business Messages के एजेंट लॉन्चर का इस्तेमाल करें.

एजेंट की जानकारी पाएं

agentTestUrl जैसे एजेंट के बारे में जानकारी पाने के लिए, आप Business Communications API से जानकारी पा सकते हैं, बशर्ते आपके पास एजेंट की name वैल्यू हो.

किसी एक एजेंट के बारे में जानकारी पाएं

एजेंट की जानकारी पाने के लिए, इस कमांड को चलाएं. BRAND_ID और AGENT_ID को एजेंट के name की यूनीक वैल्यू से बदलें.

cURL


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

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

curl -X GET \
"https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"get-agent.sh

Node.js


/**
 * This code snippet gets an agent.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/get
 *
 * 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 = 'EDIT_HERE';
const AGENT_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// 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 = [
  'https://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 = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
    };

    bcApi.brands.agents.get(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication 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();get-agent.js

Java

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.Get request = builder
        .build().brands().agents().get(agentName);

      Agent agent = request.execute();

      System.out.println(agent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

यह कोड Java Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Python


"""This code gets the agent.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/get

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 (
    Agent,
    BusinesscommunicationsBrandsAgentsGetRequest,
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
AGENT_ID = 'EDIT_HERE'
SCOPES = ['https://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 = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID

agent = agents_service.Get(BusinesscommunicationsBrandsAgentsGetRequest(
        name=agent_name
    ))

print(agent)get-agent.py

किसी ब्रैंड के सभी एजेंट की सूची बनाएं

अगर आपको एजेंट के name के बारे में जानकारी नहीं है, तो आप किसी ब्रैंड से जुड़े सभी एजेंट की जानकारी पा सकते हैं. इसके लिए, आपको GET अनुरोध यूआरएल से AGENT_ID वैल्यू को हटाना होगा.

cURL


# This code lists all agents from a brand.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/list

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

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

Node.js


/**
 * This code snippet lists the agents of a brand.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/list
 *
 * 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 = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// 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 = [
  'https://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 brandName = 'brands/' + BRAND_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      parent: brandName,
    };

    bcApi.brands.agents.list(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication 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();list-agents.js

Java

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.io.IOException;
import java.util.Arrays;
import java.util.List;

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 brandName = "brands/BRAND_ID";

      BusinessCommunications.Brands.Agents.List request = builder
          .build().brands().agents().list(brandName);

      List agents = request.execute().getAgents();
      agents.stream().forEach(agent -> {
        try {
          System.out.println(agent.toPrettyString());
        } catch (IOException e) {
          e.printStackTrace();
        }
      });
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

यह कोड Java Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Python


"""This code lists all agents from a brand.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/list

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 (
    Agent,
    BusinesscommunicationsBrandsAgentsGetRequest,
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
SCOPES = ['https://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)

brand_name = 'brands/' + BRAND_ID

agents = agents_service.List(BusinesscommunicationsBrandsAgentsListRequest(
        parent=brand_name
    ))

print(agents)list-agents.py

एजेंट की जानकारी अपडेट करें

एजेंट को अपडेट करने के लिए, आपको Business Communications API की मदद से पैच अनुरोध करना होगा. एपीआई कॉल करते समय, आपको उन फ़ील्ड के नाम शामिल करने होते हैं जिनमें "updateMask" यूआरएल पैरामीटर की वैल्यू के तौर पर बदलाव किया जा रहा है.

उदाहरण के लिए, displayName और customAgentId फ़ील्ड अपडेट करने पर, "updateMask" यूआरएल पैरामीटर "updateMask=displayName,businessMessagesAgent.customAgentId" होता है.

फ़ॉर्मैटिंग और वैल्यू के विकल्पों के लिए, brands.agents.patch देखें.

अगर आपको एजेंट के name के बारे में जानकारी नहीं है, तो ब्रैंड के सभी एजेंट की सूची बनाएं देखें.

किसी एजेंट की पुष्टि करने के बाद, उसके सिर्फ़ ये फ़ील्ड अपडेट किए जा सकते हैं:

conversationalSetting

चेतावनी: conversationalSettings में किसी भी फ़ील्ड को अपडेट करने पर, आपको ऑब्जेक्ट के सभी फ़ील्ड को अपडेट करना होगा. साथ ही, आपको सेटिंग का स्थान-भाषा भी बतानी होगी (दो वर्णों वाले ISO 639-1 भाषा कोड के तौर पर).
customAgentId
defaultLocale
primaryAgentInteraction
additionalAgentInteractions
phone

अपने एजेंट की पुष्टि करने के बाद, अगर आपको दूसरे फ़ील्ड अपडेट करने हैं, तो हमसे संपर्क करें. (पहले आपको Business Messages वाले Google खाते से साइन इन करना होगा. खाता रजिस्टर करने के लिए, Business Messages पर रजिस्टर करें देखें.)

उदाहरण: डिसप्ले नेम अपडेट करना

cURL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?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': 'Growing Tree Bank',
}"

Node.js

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
let bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require('PATH_TO_SERVICE_ACCOUNT_KEY');

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
async function initCredentials() {
  // Configure a JWT auth client
  let 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);
      }
    });
  });
}

async function main() {
  let authClient = await initCredentials();

  let agentName = 'brands/BRAND_ID/agents/AGENT_ID';

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
      updateMask: 'displayName',
      resource: {
        displayName: 'Growing Tree Bank',
      }
    };

    bcApi.brands.agents.patch(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

main();

यह कोड Node.js Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Java

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";

      Agent agent = new Agent().setDisplayName("Growing Tree Bank");

      BusinessCommunications.Brands.Agents.Patch request = builder
          .build().brands().agents().patch(agentName, agent);

      request.setUpdateMask("displayName");

      Agent updatedAgent = request.execute();
      System.out.println(updatedAgent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

यह कोड Java Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Python

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import (
    BusinesscommunicationsV1
)
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinesscommunicationsBrandsAgentsPatchRequest,
)

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = 'PATH_TO_SERVICE_ACCOUNT_KEY'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/BRAND_ID/agents/AGENT_ID'

agent=Agent(
          displayName='Growing Tree Bank'
      )

updated_agent = agents_service.Patch(
        BusinesscommunicationsBrandsAgentsPatchRequest(
            agent=agent,
            name=agent_name,
            updateMask='displayName'
        )
    )

print(updated_agent)

यह कोड Python Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

उदाहरण: `NON_LOCAL` और `LOCATION` एंट्री पॉइंट ग्रुप के बारे में बताएं

cURL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?updateMask=businessMessagesAgent.entryPointConfigs" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
  'businessMessagesAgent': {
    'entryPointConfigs': [
      {
        'allowedEntryPoint': 'NON_LOCAL',
      },
      {
        'allowedEntryPoint': 'LOCATION',
      },
    ],
  },
}"

Node.js

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
let bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require('PATH_TO_SERVICE_ACCOUNT_KEY');

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
async function initCredentials() {
  // Configure a JWT auth client
  let 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);
      }
    });
  });
}

async function main() {
  let authClient = await initCredentials();

  let agentName = 'brands/BRAND_ID/agents/AGENT_ID';

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
      updateMask: 'businessMessagesAgent.entryPointConfigs',
      resource: {
        businessMessagesAgent: {
          entryPointConfigs: [
            {
              allowedEntryPoint: 'LOCATION',
            },
            {
              allowedEntryPoint: 'NON_LOCAL',
            },
          ],
        }
      }
    };

    bcApi.brands.agents.patch(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

main();

यह कोड Node.js Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Java

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.*;
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";

      Agent agent = new Agent().setBusinessMessagesAgent(
          new BusinessMessagesAgent().setEntryPointConfigs(Arrays.asList(
              new BusinessMessagesEntryPointConfig()
                  .setAllowedEntryPoint(
                      "NON_LOCAL"),
              new BusinessMessagesEntryPointConfig()
                  .setAllowedEntryPoint(
                      "LOCATION"))));

      BusinessCommunications.Brands.Agents.Patch request = builder
          .build().brands().agents().patch(agentName, agent);

      request.setUpdateMask("businessMessagesAgent.entryPointConfigs");

      Agent updatedAgent = request.execute();
      System.out.println(updatedAgent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

यह कोड Java Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Python

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import (
    BusinesscommunicationsV1
)
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinessMessagesAgent,
    BusinessMessagesEntryPointConfig,
    BusinesscommunicationsBrandsAgentsPatchRequest,
)

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = 'PATH_TO_SERVICE_ACCOUNT_KEY'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/BRAND_ID/agents/AGENT_ID'

agent=Agent(
    businessMessagesAgent=BusinessMessagesAgent(
        entryPointConfigs=[BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.NON_LOCAL
        ), BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.LOCATION
        )]
    )
)

updated_agent = agents_service.Patch(
        BusinesscommunicationsBrandsAgentsPatchRequest(
            agent=agent,
            name=agent_name,
            updateMask='businessMessagesAgent.entryPointConfigs'
        )
    )

print(updated_agent)

यह कोड Python Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

उदाहरण: वेलकम मैसेज अपडेट करना

अगर conversationalSettings—जैसे कि welcomeMessage— में किसी भी फ़ील्ड को अपडेट किया जाता है, तो आपको ऑब्जेक्ट के सभी फ़ील्ड अपडेट करने होंगे. साथ ही, सेटिंग की स्थान-भाषा बतानी होगी (दो वर्णों वाले ISO 639-1 भाषा कोड के तौर पर).

cURL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?updateMask=businessMessagesAgent.conversationalSettings.en" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
    'businessMessagesAgent': {
        'conversationalSettings': {
            'en': {
                'welcomeMessage': {
                    'text': 'Thanks for contacting Growing Tree Bank. What can I help with today?',
                },
                'offlineMessage': {
                    'text': 'We\'re closed for the night. Please reach out to us again tomorrow.',
                },
                'privacyPolicy': {
                    'url': 'https://www.growingtreebank.com/privacy',
                },
                'conversationStarters': [
                    {
                        'suggestion': {
                            'reply': {
                                'text': 'Set up an account',
                                'postbackData': 'new-account',
                            },
                        },
                    },
                    {
                        'suggestion': {
                            'reply': {
                                'text': 'Look up account information',
                                'postbackData': 'account-lookup',
                            },
                        },
                    },
                ],
            },
        },
    },
}"

Node.js

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
let bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require('PATH_TO_SERVICE_ACCOUNT_KEY');

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
async function initCredentials() {
  // Configure a JWT auth client
  let 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);
      }
    });
  });
}

async function main() {
  let authClient = await initCredentials();

  let agentName = 'brands/BRAND_ID/agents/AGENT_ID';

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
      updateMask: 'businessMessagesAgent.conversationalSettings.en',
      resource: {
        businessMessagesAgent: {
          conversationalSettings: {
            en: {
              privacyPolicy: { url: 'https://www.growingtreebank.com/privacy' },
              welcomeMessage: { text: 'Thanks for contacting Growing Tree Bank. What can I help with today?' },
              offlineMessage: { text: 'We\'re closed for the night. Please reach out to us again tomorrow.' },
              conversationStarters: [
                {
                  suggestion: {
                    reply: {
                      text: 'Set up an account',
                      postbackData: 'new-account',
                    },
                  },
                },
                {
                  suggestion: {
                    reply: {
                      text: 'Look up account information',
                      postbackData: 'account-lookup',
                    },
                  },
                },
              ],
            },
          }
        }
      }
    };

    bcApi.brands.agents.patch(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

main();

यह कोड Node.js Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Java

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.*;
import com.google.common.collect.ImmutableMap;
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";

      Agent agent = new Agent().setBusinessMessagesAgent(
          new BusinessMessagesAgent().setConversationalSettings(ImmutableMap.of("en",
              new ConversationalSetting()
                  .setPrivacyPolicy(new PrivacyPolicy().setUrl("https://www.growingtreebank.com/privacy"))
                  .setWelcomeMessage(new WelcomeMessage().setText("Thanks for contacting Growing Tree Bank. What can I help with today?"))
                  .setOfflineMessage(new OfflineMessage().setText("We're closed for the night. Please reach out to us again tomorrow."))
                  .setConversationStarters(Arrays.asList(
                      new ConversationStarters().setSuggestion(new Suggestion()
                          .setReply(new SuggestedReply()
                              .setText("Set up an account")
                              .setPostbackData("new-account"))),
                      new ConversationStarters().setSuggestion(new Suggestion()
                          .setReply(new SuggestedReply()
                              .setText("Look up account information")
                              .setPostbackData("account-lookup")))
                      )))));

      BusinessCommunications.Brands.Agents.Patch request = builder
          .build().brands().agents().patch(agentName, agent);

      request.setUpdateMask("businessMessagesAgent.conversationalSettings.en");

      Agent updatedAgent = request.execute();
      System.out.println(updatedAgent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

यह कोड Java Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Python

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import (
    BusinesscommunicationsV1
)
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinessMessagesAgent,
    ConversationStarters,
    ConversationalSetting,
    OfflineMessage,
    PrivacyPolicy,
    WelcomeMessage,
    BusinesscommunicationsBrandsAgentsPatchRequest,
)

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = 'PATH_TO_SERVICE_ACCOUNT_KEY'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/BRAND_ID/agents/AGENT_ID'

agent=Agent(
		businessMessagesAgent=BusinessMessagesAgent(
		  	conversationalSettings=BusinessMessagesAgent.ConversationalSettingsValue(
		        additionalProperties=[BusinessMessagesAgent.ConversationalSettingsValue.AdditionalProperty(
		            key='en',
		            value=ConversationalSetting(
		                privacyPolicy=PrivacyPolicy(url='https://www.growingtreebank.com/privacy'),
		                welcomeMessage=WelcomeMessage(text='Thanks for contacting Growing Tree Bank. What can I help with today?'),
		                offlineMessage=OfflineMessage(text='We\'re closed for the night. Please reach out to us again tomorrow.'),
		                conversationStarters=[
		                    ConversationStarters(
		                        suggestion=Suggestion(
		                            reply=SuggestedReply(text='Set up an account',
		                                postbackData='new-account')
		                        )
		                    ),
		                    ConversationStarters(
		                        suggestion=Suggestion(
		                            reply=SuggestedReply(text='Look up account information',
		                                postbackData='account-lookup')
		                        )
		                    )]
		                )
		            )
		        ]
		    )
		)
)

updated_agent = agents_service.Patch(
        BusinesscommunicationsBrandsAgentsPatchRequest(
            agent=agent,
            name=agent_name,
            updateMask='businessMessagesAgent.conversationalSettings.en'
        )
    )

print(updated_agent)

यह कोड Python Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

किसी एजेंट को मिटाएं

किसी एजेंट को मिटाने पर Business Messages, एजेंट का सारा डेटा मिटा देता है. Business Messages, आपके एजेंट के भेजे गए ऐसे मैसेज नहीं मिटाता जो उपयोगकर्ता के डिवाइस पर भेजे जाते हैं या स्टोर किए जाते हैं. लोगों को भेजे गए मैसेज, एजेंट का डेटा नहीं होते.

अगर एजेंट के पास उससे जुड़ी जगह की जानकारी है या आपने एजेंट की पुष्टि करने की एक या उससे ज़्यादा बार कोशिश की है, तो अनुरोध नहीं मिटाए जा सके. जगहों की जानकारी अपडेट करने के लिए, जगहें जोड़ें देखें.

पुष्टि हो चुके एजेंट को मिटाया नहीं जा सकता. आपने जिस एजेंट की पुष्टि कर ली है या जिसकी पुष्टि करने की कोशिश की है उसे मिटाने के लिए, हमसे संपर्क करें. (पहले आपको Business Messages वाले Google खाते से साइन इन करना होगा. खाता रजिस्टर करने के लिए, Business Messages पर रजिस्टर करें देखें.)

किसी एजेंट को मिटाने के लिए, इस निर्देश का इस्तेमाल करें. BRAND_ID और AGENT_ID को एजेंट के name की यूनीक वैल्यू से बदलें.

cURL


# This code deletes an agent.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/delete

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

curl -X DELETE "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"delete-agent.sh

Node.js


/**
 * This code snippet deletes an agent.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/delete
 *
 * 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 = 'EDIT_HERE';
const AGENT_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// 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 = [
  'https://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 = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
    };

    bcApi.brands.agents.delete(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent removed
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication 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();delete-agent.js

Java

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.*;
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.Delete request
         = builder.build().brands().agents().delete(agentName);

      System.out.println(request.execute());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

यह कोड Java Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Python


"""This code deletes an agent.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/delete

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 (
    Agent,
    BusinesscommunicationsBrandsAgentsDeleteRequest,
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
AGENT_ID = 'EDIT_HERE'
SCOPES = ['https://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 = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID

agent = agents_service.Delete(BusinesscommunicationsBrandsAgentsDeleteRequest(
        name=agent_name
    ))

print(agent)delete-agent.py

फ़ॉर्मैटिंग और वैल्यू के विकल्पों के लिए, brands.agents.delete देखें.

किसी ब्रैंड को मिटाना

किसी ब्रैंड को मिटाने पर, BusinessCommunications API की मदद से DELETE का अनुरोध किया जाता है. अगर आपके पास ब्रैंड से जुड़े एक या उससे ज़्यादा एजेंट या जगहें हैं, तो अनुरोध मिटाए नहीं जा सकते. भले ही, वे एजेंट किसी दूसरे प्रॉडक्ट से जुड़े हों.

किसी ब्रैंड को मिटाने के लिए, यह निर्देश दें. BRAND_ID की जगह, ब्रैंड के name की यूनीक वैल्यू डालें.

cURL


# This code deletes a brand.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/delete

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

curl -X DELETE "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"delete-brand.sh

Node.js


/**
 * This code snippet deletes a brand.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/delete
 *
 * 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 = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// 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 = [
  'https://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 brandName = 'brands/' + BRAND_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: brandName,
    };

    bcApi.brands.delete(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Brand removed
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication 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();delete-brand.js

Java

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.*;
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 brandName = "brands/BRAND_ID";

      BusinessCommunications.Brands.Delete request = builder.build().brands().delete(brandName);

      System.out.println(request.execute());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

यह कोड Java Business Communications क्लाइंट लाइब्रेरी पर आधारित है.

Python


"""This code deletes a brand.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/delete

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 (
    BusinesscommunicationsBrandsAgentsDeleteRequest
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
SCOPES = ['https://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)

brand_name = 'brands/' + BRAND_ID

agent = agents_service.Delete(BusinesscommunicationsBrandsAgentsDeleteRequest(
        name=brand_name
    ))

print(agent)delete-brand.py

फ़ॉर्मैटिंग और वैल्यू के विकल्पों के लिए, brands.delete देखें.

अगले चरण

अब आपके पास अपना एजेंट है, इसलिए यह तरीका अपनाया जा सकता है:

ब्रैंड मैनेज करने के लिए एजेंट बनाएं

दर्शकों की उम्मीद

एजेंट बनाएं

ज़रूरी शर्तें

डेवलपमेंट एनवायरमेंट

ब्रैंड की जानकारी

एजेंट के दिखने का तरीका और नीतियां

एजेंट से इंटरैक्शन

एजेंट के एंट्री पॉइंट

oauth2l को इंस्टॉल और टेस्ट करना

एजेंट बनाएं

cURL

Node.js

Java

Python

cURL

Node.js

Java

Python

उदाहरण: Growing ट्री बैंक के लिए कोई एजेंट बनाएं

ज़रूरी जानकारी सेव करें

एजेंट-लेवल का वेबहुक सेट करें

एजेंट को टेस्ट करें

एजेंट की जानकारी पाएं

किसी एक एजेंट के बारे में जानकारी पाएं

cURL

Node.js

Java

Python

किसी ब्रैंड के सभी एजेंट की सूची बनाएं

cURL

Node.js

Java

Python

एजेंट की जानकारी अपडेट करें

उदाहरण: डिसप्ले नेम अपडेट करना

cURL

Node.js

Java

Python

उदाहरण: NON_LOCAL और LOCATION एंट्री पॉइंट ग्रुप के बारे में बताएं

cURL

Node.js

Java

Python

उदाहरण: वेलकम मैसेज अपडेट करना

cURL

Node.js

Java

Python

किसी एजेंट को मिटाएं

cURL

Node.js

Java

Python

किसी ब्रैंड को मिटाना

cURL

Node.js

Java

Python

अगले चरण

उदाहरण: `NON_LOCAL` और `LOCATION` एंट्री पॉइंट ग्रुप के बारे में बताएं