OAuth এজেন্টদের ব্যবহারকারীদের পরিচয় যাচাই করতে এবং নিরাপদ উপায়ে কথোপকথনে ব্যক্তিগতকৃত তথ্য প্রদান করার অনুমতি দেয়। ব্যবহারকারীদের একটি বিশ্বস্ত OAuth প্রদানকারীতে সাইন ইন করার মাধ্যমে, এজেন্টরা ব্যবহারকারীর ডেটা অ্যাক্সেস করতে পারে যা অটোমেশনের মাধ্যমে দ্রুত উত্তর দিতে এবং লাইভ এজেন্টদের জন্য সময় বাঁচাতে সাহায্য করতে পারে।
ব্যবসার বার্তাগুলি প্রমাণীকরণ অনুরোধের পরামর্শের সাথে OAuth 2.0 সমর্থন করে, যা ব্যবহারকারীদেরকে আপনি এজেন্টের জন্য কনফিগার করা OAuth প্রদানকারীতে সাইন ইন করতে অনুরোধ করে৷ ব্যবহারকারী সফলভাবে সাইন ইন করার পরে, বিজনেস মেসেজ এজেন্টের কাছে একটি বার্তা হিসাবে একটি অনুমোদন কোড ফেরত দেয়।
একবার আপনার কাছে OAuth প্রদানকারীর কাছ থেকে অনুমোদনের কোড পেয়ে গেলে, আপনি তাদের APIগুলির সাথে একীভূত করতে পারেন এবং কথোপকথন প্রবাহকে সমর্থন করতে পারেন যার জন্য ব্যবহারকারীর পরিচয় তথ্য প্রয়োজন। মনে রাখবেন যে প্রতিটি পরিষেবার সাথে আপনি ইন্টারঅ্যাক্ট করেন তার নিজস্ব ব্যবহারের শর্তাবলী রয়েছে৷
একটি এজেন্টের জন্য OAuth কনফিগার করুন
কোনো এজেন্টের জন্য প্রমাণীকরণ অনুরোধের পরামর্শ সক্ষম করতে, আপনাকে প্রথমে OAuth কনফিগার করতে হবে।
একটি OAuth কনফিগারেশন নির্দিষ্ট করতে, আপনি এজেন্টের endpointUrl ক্ষেত্র আপডেট করতে বিজনেস কমিউনিকেশন API- এর সাথে একটি প্যাচ অনুরোধ করেন।
আপনি এন্ডপয়েন্ট ইউআরএল নির্দিষ্ট করার পরে, আপনাকে আপনার এজেন্টের জন্য রিডাইরেক্ট ইউআরআই সঞ্চয় করতে হবে এবং আপনার OAuth প্রদানকারীর তথ্যে রিডাইরেক্ট ইউআরআই আপডেট করতে হবে।
পূর্বশর্ত
আপনার নিম্নলিখিত আইটেমগুলির প্রয়োজন:
- একটি OAuth প্রদানকারী যেটি OAuth 2.0 স্পেসিফিকেশন অনুসরণ করে
- আপনার ডেভেলপমেন্ট মেশিনে আপনার GCP প্রকল্পের পরিষেবা অ্যাকাউন্ট কী-এর পথ
এজেন্টের
name(উদাহরণস্বরূপ, "brands/12345/agents/67890")আপনি যদি এজেন্টের
nameনা জানেন তবে একটি ব্র্যান্ডের জন্য সমস্ত এজেন্টদের তালিকা দেখুন৷এন্ডপয়েন্ট URL যেখানে ব্যবহারকারীরা OAuth প্রদানকারীতে সাইন ইন করে
আপডেট অনুরোধ পাঠান
এজেন্ট আপডেট করতে, নিম্নলিখিত কমান্ডটি চালান। আপনার পূর্বশর্তগুলিতে চিহ্নিত মানগুলির সাথে ভেরিয়েবলগুলি প্রতিস্থাপন করুন।
curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?updateMask=businessMessagesAgent.authorizationConfig" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
'businessMessagesAgent': {
'authorizationConfig': {
'endpointUrl': 'ENDPOINT_URL',
},
},
}"
রিডাইরেক্ট ইউআরআই আপডেট করুন
এখন যেহেতু OAuth এজেন্টের জন্য কনফিগার করা হয়েছে, আপনাকে আপনার OAuth প্রদানকারীতে চারটি রিডাইরেক্ট URI যোগ করতে হবে:
-
https://business.google.com/callback -
https://business.google.com/callback? -
https://business.google.com/message?az-intent-type=1 -
https://business.google.com/message?az-intent-type=1&
আপনার OAuth প্রদানকারীর তথ্যে আপনাকে অবশ্যই সমস্ত রিডাইরেক্ট URL অন্তর্ভুক্ত করতে হবে।
রিডাইরেক্ট ইউআরআই আপডেট করার প্রক্রিয়া OAuth প্রদানকারীর দ্বারা পরিবর্তিত হয়। নির্দেশাবলীর জন্য আপনার OAuth প্রদানকারীর সাথে যোগাযোগ করুন।
এখন যেহেতু আপনার এজেন্টের জন্য OAuth কনফিগার করা হয়েছে, আপনি প্রমাণীকরণ অনুরোধের পরামর্শ দিয়ে ব্যবহারকারীদের প্রমাণীকরণ করতে পারেন।
একজন ব্যবহারকারীকে প্রমাণীকরণ করুন
আপনি একটি এজেন্টের জন্য OAuth কনফিগার করার পরে, আপনি ব্যবহারকারীদের প্রমাণীকরণ অনুরোধের পরামর্শ দিয়ে সাইন ইন করতে অনুরোধ করতে পারেন।
পূর্বশর্ত
আপনার নিম্নলিখিত আইটেমগুলির প্রয়োজন:
- আপনার ডেভেলপমেন্ট মেশিনে আপনার GCP প্রকল্পের পরিষেবা অ্যাকাউন্ট কী-এর পথ
এজেন্টের
name(উদাহরণস্বরূপ, "brands/12345/agents/67890")আপনি যদি এজেন্টের
nameনা জানেন তবে একটি ব্র্যান্ডের জন্য সমস্ত এজেন্টদের তালিকা দেখুন৷আপনার OAuth প্রদানকারীর ক্লায়েন্ট আইডি
আপনার OAuth প্রদানকারীর থেকে কোড চ্যালেঞ্জের প্রয়োজনীয়তা
আপনার OAuth প্রদানকারীর স্কোপ
প্রমাণীকরণ অনুরোধ পরামর্শ পাঠান
একজন ব্যবহারকারীকে প্রমাণীকরণ করতে,
- OAuth অনুরোধের জন্য কোড যাচাইকারী এবং কোড চ্যালেঞ্জ স্ট্রিং তৈরি করুন। প্রয়োজনীয়তা এবং বিকল্পগুলির জন্য আপনার OAuth প্রদানকারীর সাথে যোগাযোগ করুন।
- প্রমাণীকরণ অনুরোধের পরামর্শ সহ একটি বার্তা পাঠান।
cURL
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# https://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# This code sends a text message to the user with an authentication request suggestion
# that allows the user to authenticate with OAuth. It also has a fallback text.
# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#authentication-request-suggestion
# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
# Make sure a service account key file exists at ./service_account_key.json
# Replace the __CLIENT_ID__
# Replace the __CODE_CHALLENGE__
# Replace the __SCOPE__
curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/messages" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-messages" \
-H "$(oauth2l header --json ./service_account_key.json businessmessages)" \
-d "{
'messageId': '$(uuidgen)',
'text': 'Sign in to continue the conversation.',
'fallback': 'Visit support.growingtreebank.com to continue.',
'suggestions': [
{
'authenticationRequest': {
'oauth': {
'clientId': '__CLIENT_ID__',
'codeChallenge': '__CODE_CHALLENGE__',
'scopes': [
'__SCOPE__',
],
},
},
},
],
'representative': {
'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
'displayName': 'Chatbot',
'representativeType': 'BOT'
}
}"
Node.js
/**
* This code sends a text message to the user with an authentication request suggestion
* that allows the user to authenticate with OAuth. It also has a fallback text.
* Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#authentication-request-suggestion
*
* This code is based on the https://github.com/google-business-communications/nodejs-businessmessages Node.js
* Business Messages client library.
*/
/**
* Before continuing, learn more about the prerequisites for authenticating
* with OAuth at: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/oauth?hl=en
*
* Edit the values below:
*/
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';
const CONVERSATION_ID = 'EDIT_HERE';
const OAUTH_CLIENT_ID = 'EDIT_HERE';
const OAUTH_CODE_CHALLENGE = 'EDIT_HERE';
const OAUTH_SCOPE = 'EDIT_HERE';
const businessmessages = require('businessmessages');
const uuidv4 = require('uuid').v4;
const {google} = require('googleapis');
// Initialize the Business Messages API
const bmApi = new businessmessages.businessmessages_v1.Businessmessages({});
// Set the scope that we need for the Business Messages API
const scopes = [
'https://www.googleapis.com/auth/businessmessages',
];
// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);
/**
* Posts a message to the Business Messages API along with an authentication request.
*
* @param {string} conversationId The unique id for this user and agent.
* @param {string} representativeType A value of BOT or HUMAN.
*/
async function sendMessage(conversationId, representativeType) {
const authClient = await initCredentials();
if (authClient) {
// Create the payload for sending a message along with an authentication request
const apiParams = {
auth: authClient,
parent: 'conversations/' + conversationId,
resource: {
messageId: uuidv4(),
representative: {
representativeType: representativeType,
},
fallback: 'Visit support.growingtreebank.com to continue.',
text: 'Sign in to continue the conversation.',
suggestions: [
{
authenticationRequest: {
oauth: {
clientId: OAUTH_CLIENT_ID,
codeChallenge: OAUTH_CODE_CHALLENGE,
scopes: [OAUTH_SCOPE]
}
}
},
],
},
};
// Call the message create function using the
// Business Messages client library
bmApi.conversations.messages.create(apiParams,
{auth: authClient}, (err, response) => {
console.log(err);
console.log(response);
});
}
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);
}
});
});
}
sendMessage(CONVERSATION_ID, 'BOT');
পাইথন
"""Sends a text message to the user with an authentication request suggestion.
It allows the user to authenticate with OAuth and has a fallback text.
Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#authentication-request-suggestion
This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""
import uuid
from businessmessages import businessmessages_v1_client as bm_client
from businessmessages.businessmessages_v1_messages import BusinessMessagesAuthenticationRequest
from businessmessages.businessmessages_v1_messages import BusinessMessagesAuthenticationRequestOauth
from businessmessages.businessmessages_v1_messages import BusinessmessagesConversationsMessagesCreateRequest
from businessmessages.businessmessages_v1_messages import BusinessMessagesMessage
from businessmessages.businessmessages_v1_messages import BusinessMessagesRepresentative
from businessmessages.businessmessages_v1_messages import BusinessMessagesSuggestion
from oauth2client.service_account import ServiceAccountCredentials
# Before continuing, learn more about the prerequisites for authenticating
# with OAuth at: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/oauth?hl=en
# Edit the values below:
path_to_service_account_key = './service_account_key.json'
conversation_id = 'EDIT_HERE'
oauth_client_id = 'EDIT_HERE'
oauth_code_challenge = 'EDIT_HERE'
oauth_scope = 'EDIT_HERE'
credentials = ServiceAccountCredentials.from_json_keyfile_name(
path_to_service_account_key,
scopes=['https://www.googleapis.com/auth/businessmessages'])
client = bm_client.BusinessmessagesV1(credentials=credentials)
representative_type_as_string = 'BOT'
if representative_type_as_string == 'BOT':
representative_type = BusinessMessagesRepresentative.RepresentativeTypeValueValuesEnum.BOT
else:
representative_type = BusinessMessagesRepresentative.RepresentativeTypeValueValuesEnum.HUMAN
# Create a text message with an authentication request
message = BusinessMessagesMessage(
messageId=str(uuid.uuid4().int),
representative=BusinessMessagesRepresentative(
representativeType=representative_type
),
text='Sign in to continue the conversation.',
fallback='Visit support.growingtreebank.com to continue.',
suggestions=[
BusinessMessagesSuggestion(
authenticationRequest=BusinessMessagesAuthenticationRequest(
oauth=BusinessMessagesAuthenticationRequestOauth(
clientId=oauth_client_id,
codeChallenge=oauth_code_challenge,
scopes=[oauth_scope])
)
),
]
)
# Create the message request
create_request = BusinessmessagesConversationsMessagesCreateRequest(
businessMessagesMessage=message,
parent='conversations/' + conversation_id)
# Send the message
bm_client.BusinessmessagesV1.ConversationsMessagesService(
client=client).Create(request=create_request)
- যখন ব্যবহারকারী পরামর্শটি ট্যাপ করে এবং সফলভাবে সাইন ইন করে, তখন আপনি আপনার এজেন্টের ওয়েবহুকে একটি বার্তা পাবেন ।
authenticationResponse.codeক্ষেত্র থেকে অনুমোদন কোড পুনরুদ্ধার করুন।
একবার আপনি বার্তাটি পেয়ে গেলে, আপনি আপনার OAuth প্রদানকারীর কাছ থেকে একটি অ্যাক্সেস টোকেনের জন্য অনুমোদন কোড এবং কোড যাচাইকারী বিনিময় করতে পারেন। আপনি অ্যাক্সেস টোকেন দিয়ে ব্যবহারকারীর ডেটা অ্যাক্সেস করতে পারেন।
কোড নমুনা সহ প্রমাণীকরণের সাথে একটি নমুনা কথোপকথনের জন্য, ব্যবহারকারীকে প্রমাণীকরণ দেখুন।