आरबीएम ऑपरेशंस एपीआई की मदद से एजेंट मैनेज करें

कैरियर के लिए आरबीएम का मुख्य वर्कफ़्लो, नए एजेंटों की जानकारी की समीक्षा करना और उन्हें कैरियर के नेटवर्क पर लॉन्च करने और उनके सदस्यों को मैसेज भेजने की अनुमति देना या न देना शामिल है.

इस पेज पर दिए गए कोड स्निपेट, हमारे Javascript और Curl के सैंपल से लिए गए हैं.

किसी कैरियर को सबमिट किए गए सभी एजेंट की सूची

कैरियर उन सभी एजेंट की सूची पा सकता है जिन्हें डेवलपर ने कैरियर के नेटवर्क पर लॉन्च करने के लिए सबमिट किया है.

Node.js

const businessCommunicationsApiHelper =
  require('@google/rbm-businesscommunications');

const privateKey =
  require('../../resources/businesscommunications-service-account-credentials.json');

businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);

// Retrieve all agents targeting the carrier
businessCommunicationsApiHelper.listAgents('brands/-').then((response) => {
  console.log('Current agents are:');
  console.log(JSON.stringify(response.data, null, 2));
}).catch((err) => {
  console.log(err);
});

cURL

curl -v "https://businesscommunications.googleapis.com/v1/brands/-/agents" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json serviceAccount.json businesscommunications`"

ब्रैंड को - पर सेट किया गया है, क्योंकि सभी एजेंट की सूची पाने के लिए इसकी ज़रूरत नहीं होती.

यह कोड, मोबाइल और इंटरनेट सेवा देने वाली कंपनी के साथ लॉन्च करने के लिए सबमिट किए गए सभी एजेंट की सूची दिखाता है:

{
  "agents": [
    {
      "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_4fpd1psz_agent",
      "displayName": "My new agent",
      "rcsBusinessMessagingAgent": {
        "description": "This is the agent description that will be displayed in the Agent info tab in Messages",
        "logoUri": "https://agent-logos.storage.googleapis.com/_/kt90w53vzw2QSxK6PG1uCeJf",
        "heroUri": "https://agent-logos.storage.googleapis.com/_/kt90vzob74GQcfeHoEQbVRTP",
        "phoneNumbers": [
          {
            "phoneNumber": {
              "number": "+12223334444"
            },
            "label": "Call support"
          }
        ],
        "privacy": {
          "uri": "https://policies.google.com/privacy",
          "label": "Our privacy policy"
        },
        "termsConditions": {
          "uri": "https://policies.google.com/terms",
          "label": "Our Terms and Conditions"
        },
        "color": "#0B78D0",
        "billingConfig": {
          "billingCategory": "BASIC_MESSAGE"
        },
        "agentUseCase": "MULTI_USE",
        "hostingRegion": "NORTH_AMERICA"
      }
    },
    {
      "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_7jo0trhw_agent",
      "displayName": "My second agent",
      "rcsBusinessMessagingAgent": {
        "description": "Another agent description",
        "logoUri": "https://agent-logos.storage.googleapis.com/_/kt90w53vzw2QSxK6PG1uCeJf",
        "heroUri": "https://agent-logos.storage.googleapis.com/_/kt90vzob74GQcfeHoEQbVRTP",
        "phoneNumbers": [
          {
            "phoneNumber": {
              "number": "+12228885768"
            },
            "label": "Call support"
          }
        ],
        "privacy": {
          "uri": "https://policies.google.com/privacy",
          "label": "Our privacy policy"
        },
        "termsConditions": {
          "uri": "https://policies.google.com/terms",
          "label": "Our Terms and Conditions"
        },
        "color": "#0B78D0",
        "billingConfig": {
          "billingCategory": "CONVERSATIONAL_LEGACY"
        },
        "agentUseCase": "PROMOTIONAL",
        "hostingRegion": "NORTH_AMERICA"
      }
    }
  ]
}

एक बार में एक पेज के नतीजे देखे जा सकते हैं. ज़्यादा जानकारी के लिए, एपीआई रेफ़रंस देखें.

एजेंट की पुष्टि करने के लिए दी गई जानकारी पाना

कैरियर, एजेंट के ब्रैंड की पुष्टि की स्थिति देख सकता है. ज़्यादा जानकारी के लिए, brands.agents.getVerification देखें.

Node.js

  const businessCommunicationsApiHelper =
    require('@google/rbm-businesscommunications');
  const privateKey =
    require('../../resources/businesscommunications-service-account-credentials.json');
  businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);
  businessCommunicationsApiHelper.getAgentVerification(agents[0].name).then((response) => {
  }).catch((err) => {
    console.log(err);
  });

cURL

  curl -v "https://businesscommunications.googleapis.com/v1/brands/-/agents/AGENT ID/verification" \
    -H "Content-Type: application/json" \
    -H "User-Agent: curl/business-messaging" \
    -H "`oauth2l header --json serviceAccount.json businesscommunications`"

कॉल करने वाले को एजेंट का पूरा नाम बताना ज़रूरी नहीं है. इसमें ब्रैंड का नाम भी शामिल है. सिर्फ़ एजेंट आईडी (@rbm.goog से पहले) की ज़रूरत होती है. साथ ही, ब्रैंड का नाम - पर सेट होना चाहिए.

यह कोड, पुष्टि के स्टेटस और पार्टनर की जानकारी दिखाता है:

{
  "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_ciymyd2b_agent/verification",
  "verificationState": "VERIFICATION_STATE_UNVERIFIED",
  "agentVerificationContact": {
    "partnerName": "John Doe",
    "partnerEmailAddress": "john.doe@gmail.com",
    "brandContactName": "Bob",
    "brandContactEmailAddress": "bob@brand.com",
    "brandWebsiteUrl": "https://www.brand.com"
  }
}

एजेंट लॉन्च की स्थिति और सवालों की सूची पाना

मोबाइल और इंटरनेट सेवा देने वाली कंपनी, किसी एजेंट के लॉन्च की मौजूदा स्थिति और डेवलपर के लॉन्च से जुड़े सवालों की सूची देख सकती है.

Node.js

const businessCommunicationsApiHelper =
  require('@google/rbm-businesscommunications');

const privateKey =
  require('../../resources/businesscommunications-service-account-credentials.json');

businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);

businessCommunicationsApiHelper.getAgentLaunch(agents[0].name).then((response) => {
  console.log('Launch details are:');
  console.log(JSON.stringify(response.data, null, 2));
}).catch((err) => {
  console.log(err);
});

cURL

curl -v "https://businesscommunications.googleapis.com/v1/brands/-/agents/AGENT ID/launch" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json serviceAccount.json businesscommunications`"

कॉल करने वाले को एजेंट का पूरा नाम बताना ज़रूरी नहीं है. इसमें ब्रैंड का नाम भी शामिल है. सिर्फ़ एजेंट आईडी (@rbm.goog से पहले) की ज़रूरत होती है. साथ ही, ब्रैंड का नाम - पर सेट होना चाहिए.

यह कोड, लॉन्च की जानकारी दिखाता है:

{
  "name": "brands/8b5c7f80-b025-486b-bc8a-2d0797559711/agents/my-agent-demo/launch",
  "rcsBusinessMessaging": {
    "questionnaire": {
      "contacts": [
        {
          "name": "John Doe",
          "title": "Mr",
          "email": "johndoe@developer.com"
        }
      ],
      "optinDescription": "Messages are sent to known MSISDNs",
      "triggerDescription": "We respond to any interaction",
      "interactionsDescription": "Simple conversations with a chatbot",
      "optoutDescription": "User sends stop"
    },
    "launchDetails": {
      "/v1/regions/thecarrier": {
        "launchState": "LAUNCH_STATE_LAUNCHED",
        "updateTime": "2023-02-20T15:10:36.528669Z"
      }
    }
  }
}

एजेंट की परिभाषा देखना

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

Node.js

const businessCommunicationsApiHelper =
  require('@google/rbm-businesscommunications');

const privateKey =
  require('../../resources/businesscommunications-service-account-credentials.json');

businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);

businessCommunicationsApiHelper.getAgent(agent[0].name).then((response) => {
  console.log('Agent details are:');
  console.log(JSON.stringify(response.data, null, 2));
}).catch((err) => {
  console.log(err);
});

cURL

curl -v "https://businesscommunications.googleapis.com/v1/brands/-/agents/AGENT ID" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json serviceAccount.json businesscommunications`"

कॉल करने वाले को एजेंट का पूरा नाम बताने की ज़रूरत नहीं है. इसमें ब्रैंड का नाम भी शामिल है. सिर्फ़ एजेंट आईडी (@rbm.goog से पहले) की ज़रूरत होती है. साथ ही, ब्रैंड का नाम - पर सेट होना चाहिए.

यह कोड एजेंट की जानकारी दिखाता है:

{
  "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_4fpd1psz_agent",
  "displayName": "My new agent",
  "rcsBusinessMessagingAgent": {
    "description": "This is the agent description that will be displayed in the Agent info tab in Messages",
    "logoUri": "https://agent-logos.storage.googleapis.com/_/kt90w53vzw2QSxK6PG1uCeJf",
    "heroUri": "https://agent-logos.storage.googleapis.com/_/kt90vzob74GQcfeHoEQbVRTP",
    "phoneNumbers": [
      {
        "phoneNumber": {
          "number": "+12223334444"
        },
        "label": "Call support"
      }
    ],
    "privacy": {
      "uri": "https://policies.google.com/privacy",
      "label": "Our privacy policy"
    },
    "termsConditions": {
      "uri": "https://policies.google.com/terms",
      "label": "Our Terms and Conditions"
    },
    "color": "#0B78D0",
    "billingConfig": {
      "billingCategory": "BASIC_MESSAGE"
    },
    "agentUseCase": "MULTI_USE",
    "hostingRegion": "NORTH_AMERICA"
  }
}

एजेंट लॉन्च की स्थिति बदलना

कैरियर, किसी एजेंट के लॉन्च की स्थिति को अपडेट कर सकता है. साथ ही, कोई मैसेज जोड़ सकता है, जिसे डेवलपर को ईमेल किया जाएगा.

स्टेटस को इस तरह बदला जाना चाहिए:

  • LAUNCH_STATE_PENDING को LAUNCH_STATE_LAUNCHED या LAUNCH_STATE_REJECTED पर सेट करें
  • LAUNCH_STATE_LAUNCHED से LAUNCH_STATE_SUSPENDED
  • LAUNCH_STATE_SUSPENDED को LAUNCH_STATE_LAUNCHED या LAUNCH_STATE_REJECTED पर सेट करें

कॉल करने वाले को एजेंट का पूरा नाम बताने की ज़रूरत नहीं है. इसमें ब्रैंड का नाम भी शामिल है. सिर्फ़ एजेंट आईडी (@rbm.goog से पहले) की ज़रूरत होती है. साथ ही, ब्रैंड का नाम - पर सेट होना चाहिए.

Node.js

const businessCommunicationsApiHelper =
  require('@google/rbm-businesscommunications');

const privateKey =
  require('../../resources/businesscommunications-service-account-credentials.json');

businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);

businessCommunicationsApiHelper
	.updateAgentLaunchState(agentId, 'LAUNCH_STATE_LAUNCHED').then((response) => {
		console.log('Updated launch details are:');
		console.log(JSON.stringify(response.data, null, 2));
	});

cURL

curl -v -X PATCH "https://businesscommunications.googleapis.com/v1/brands/-/agents/AGENT ID/launch" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json serviceAccount.json businesscommunications`" \
  -d "{
    'rcsBusinessMessaging': {
      'launchDetails': {
        '': {
          'launchState': 'LAUNCH_STATE_LAUNCHED',
        }
      }
    }
  }"

यह कोड, लॉन्च की अपडेट की गई जानकारी के साथ-साथ लॉन्च की स्थिति की जानकारी भी दिखाता है:

{
  "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_4fpd1psz_agent/launch",
  "rcsBusinessMessaging": {
    "questionnaire": {
      "contacts": [
        {
          "name": "Ian",
          "title": "The Boss",
          "email": "someone@somewhere.com"
        }
      ],
      "optinDescription": "Users accepted our terms of service online.",
      "triggerDescription": "We are reaching preregistered users",
      "interactionsDescription": "This agent does not do much.",
      "optoutDescription": "Reply stop and we stop.",
      "agentAccessInstructions": "This is a a simple agent that reaches registered users.",
      "videoUris": [
        "https://www.google.com/a/video"
      ],
      "screenshotUris": [
        "https://www.google.com/a/screenshot"
      ]
    },
    "launchDetails": {
      "/v1/regions/thecarrier": {
        "launchState": "LAUNCH_STATE_REJECTED",
        "comment": "We don't have a billing contract in place with you.",
        "updateTime": "2023-04-28T15:22:10.221191Z"
      }
    }
  }
}

एजेंट मिटाना

सुरक्षा की वजहों से, आरबीएम एजेंट अब मिटाए नहीं जा सकते. मदद पाने के लिए, आरबीएम सहायता टीम से संपर्क करें.