Semua agen adalah bagian dari merek (bisnis, organisasi, atau grup). Sebelum agen dapat dibuat, Anda harus membuat merek pemilik. Merek sepenuhnya merupakan organisasi untuk membantu Anda mengelompokkan agen terkait
Cuplikan kode di halaman ini diambil dari contoh Java dan contoh Node.js.
Buat agen
Untuk membuat agen RBM, Anda perlu menentukan informasi dasarnya.
Node.js
const businessCommunicationsApiHelper =
require('@google/rbm-businesscommunications');
const privateKey =
require('../../resources/businesscommunications-service-account-credentials.json');
businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);
const newAgentDetails = {
displayName: 'My new agent',
name: brandId + '/agents/',
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'
}
],
// emails and websites are optional
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: 'TRANSACTIONAL',
hostingRegion: 'EUROPE'
}
};
businessCommunicationsApiHelper.createAgent(brandId, newAgentDetails).then((response) => {
}).catch((err) => {
console.log(err);
});
Java
Brand brand = api.getBrand(brandId);
logger.info("Brand to operate on: " + brand);
String displayName = flags.getOrDefault("agent_name", "Test RBM Agent: " + now.getSecond());
String suffix = flags.getOrDefault("agent_data_suffix", "API");
RcsBusinessMessagingAgent agentData = AgentFactory.createRbmAgent(suffix);
Agent agent = api.createRbmAgent(brand, displayName, agentData);
logger.info("RBM agent has been created: " + agent);
Kode ini menampilkan informasi agen baru dan ID unik yang ditetapkan ke agen:
{
name: 'brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_dxuewtvy_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: [ [Object] ],
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: 'EUROPE'
}
}
Mencari definisi agen
Agen dapat diambil menggunakan ID uniknya (name).
Node.js
const businessCommunicationsApiHelper =
require('@google/rbm-businesscommunications');
const privateKey =
require('../../resources/businesscommunications-service-account-credentials.json');
businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);
// Retrieve details of the first agent (if one has already been created)
businessCommunicationsApiHelper.getAgent(agent.name).then((response) => {
}).catch((err) => {
console.log(err);
});
Java
Agent agent = api.getAgent(flags.get("agent_id"));
logger.info("Agent: " + agent);
Kode ini menampilkan informasi agen:
{
name: 'brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_dxuewtvy_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: [ [Object] ],
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: 'EUROPE'
}
}
Mengirimkan informasi verifikasi
Verifikasi merek diperlukan untuk peluncuran agen. Anda harus mengirimkan informasi verifikasi sebelum membuat permintaan peluncuran. Perhatikan bahwa Anda tidak perlu menunggu persetujuan merek sebelum membuat permintaan peluncuran; persetujuan merek terjadi sebagai bagian dari proses persetujuan peluncuran.
Node.js
const businessCommunicationsApiHelper =
require('@google/rbm-businesscommunications');
const privateKey =
require('../../resources/businesscommunications-service-account-credentials.json');
businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);
let agentVerificationContact = {
partnerName: 'Alice',
partnerEmailAddress: 'alice@thepartner.com',
brandContactName: 'Bob',
brandContactEmailAddress: 'bob@thebrand.com',
brandWebsiteUrl: 'https://thebrand.com/'
};
businessCommunicationsApiHelper.verifyAgent(agent.name, agentVerificationContact).then((response) => {
}).catch((err) => {
console.log(err);
});
Java
AgentVerificationContact contact = AgentFactory.createRbmAgentVerification();
AgentVerification verification = api.requestAgentVerification(agent.getName(), contact);
logger.info("Verification requested: " + verification);
Kode ini menampilkan informasi verifikasi:
{
"name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_ciymyd2b_agent",
"verificationState": "VERIFICATION_STATE_UNVERIFIED",
"agentVerificationContact": {
"partnerName": "Alice",
"partnerEmailAddress": "alice@thepartner.com",
"brandContactName": "Bob",
"brandContactEmailAddress": "bob@thebrand.com",
"brandWebsiteUrl": "https://thebrand.com/"
}
}
Mencari status verifikasi agen
Status verifikasi merek agen dapat dikueri.
Node.js
const businessCommunicationsApiHelper =
require('@google/rbm-businesscommunications');
const privateKey =
require('../../resources/businesscommunications-service-account-credentials.json');
businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);
businessCommunicationsApiHelper.getAgentVerification(agent.name).then((response) => {
}).catch((err) => {
console.log(err);
});
Java
AgentVerification verification = api.getAgentVerification(agent.getName());
logger.info("RBM agent verification: " + verification);
Kode ini menampilkan status verifikasi:
{
"name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_ciymyd2b_agent/verification",
"verificationState": "VERIFICATION_STATE_UNVERIFIED",
"agentVerificationContact": {}
}
Mengirimkan agen untuk peluncuran
Anda dapat mengirimkan agen untuk diluncurkan di satu atau beberapa operator. Beberapa peluncuran dikelola oleh Google dan yang lainnya dikelola langsung oleh operator. Peluncuran yang dikelola operator mungkin memiliki persyaratan tambahan. Lihat Peluncuran yang dikelola Google vs. yang dikelola Operator untuk mengetahui informasi selengkapnya.
Sebelum dapat meluncurkan agen untuk pertama kalinya, Anda harus mengirimkan informasi verifikasi. Tindakan ini memungkinkan Google, operator, atau keduanya memverifikasi dengan kontak brand Anda bahwa Anda diberi otorisasi untuk mengelola agen atas nama mereka. Lihat verifikasi brand untuk mengetahui detailnya.
Setelah mengirimkan informasi verifikasi dan menyelesaikan prasyarat peluncuran, Anda dapat mengirimkan permintaan peluncuran.
Agen dapat dikirimkan untuk diluncurkan di satu atau beberapa operator. Kuesioner peluncuran yang telah dilengkapi harus diberikan sebagai bagian dari peluncuran.
Node.js
const businessCommunicationsApiHelper =
require('@google/rbm-businesscommunications');
const privateKey =
require('../../resources/businesscommunications-service-account-credentials.json');
businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);
let agentLaunch = {
questionnaire: {
contacts: [
{
name: 'James Bond',
title: 'Mr 0 0 7',
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: {}
};
businessCommunicationsApiHelper.launchAgent(agent.name, agentLaunch).then((response) => {
}).catch((err) => {
console.log(err);
});
Java
Optional<Questionnaire> q = Optional.of(AgentFactory.createRbmQuestionnaire());
AgentLaunch launch = api.requestRbmAgentLaunch(agent.getName(), regionIds, q);
logger.info("RBM agent updated launch: " + launch);
Kode ini akan menampilkan informasi peluncuran agen:
{
"name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_7jo0trhw_agent/launch",
"rcsBusinessMessaging": {
"questionnaire": {
"contacts": [
{
"name": "James Bond",
"title": "Mr O O 7",
"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/some-carrier": {
"launchState": "LAUNCH_STATE_PENDING",
"updateTime": "2023-02-24T15:02:13.903554Z"
}
},
"launchRegion": "NORTH_AMERICA"
}
}
Perhatikan bahwa launchRegion tidak digunakan lagi dan dijadwalkan untuk segera dihapus.
Mencari status peluncuran agen
Status peluncuran agen saat ini dapat diambil.
Node.js
const businessCommunicationsApiHelper =
require('@google/rbm-businesscommunications');
const privateKey =
require('../../resources/businesscommunications-service-account-credentials.json');
businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);
businessCommunicationsApiHelper.getAgentLaunch(agent.name).then((response) => {
}).catch((err) => {
console.log(err);
});
Java
AgentLaunch launch = api.getAgentLaunch(agent.getName());
logger.info("RBM agent launch: " + launch);
Kode ini menampilkan informasi peluncuran dan status peluncuran untuk setiap operator target:
{
"name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_7jo0trhw_agent/launch",
"rcsBusinessMessaging": {
"questionnaire": {
"contacts": [
{
"name": "James Bond",
"title": "Mr O O 7",
"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/some-carrier": {
"launchState": "LAUNCH_STATE_PENDING",
"updateTime": "2023-02-24T15:02:13.903554Z"
}
},
"launchRegion": "NORTH_AMERICA"
}
}
Perhatikan bahwa launchRegion tidak digunakan lagi dan dijadwalkan untuk segera dihapus.
Menambahkan operator tambahan ke peluncuran agen
Operator target tambahan dapat ditambahkan dengan mengambil informasi peluncuran saat ini dan menambahkan lebih banyak operator.
Node.js
const businessCommunicationsApiHelper =
require('@google/rbm-businesscommunications');
const privateKey =
require('../../resources/businesscommunications-service-account-credentials.json');
businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);');
// To launch an agent to further carriers, we need to first obtain the existing
// launch information and extend it with the new carrier(s).
businessCommunicationsApiHelper.getAgentLaunch(agent.name).then((response) => {
let existingLaunch = response.data.rcsBusinessMessaging;
// Now we add the new carrier to the existing launch
existingLaunch.launchDetails[config.launchCarrier2] = null;
// And we submit the launch again
businessCommunicationsApiHelper.launchAgent(agent.name, existingLaunch).then((response) => {
console.log('Launch details are:');
console.log(JSON.stringify(response.data, null, 2));
}).catch((err) => {
console.log(err);
});
}).catch((err) => {
console.log(err);
});
Kode ini akan menampilkan informasi peluncuran yang telah diperbarui:
{
"name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_7jo0trhw_agent/launch",
"rcsBusinessMessaging": {
"questionnaire": {
"contacts": [
{
"name": "James Bond",
"title": "Mr O O 7",
"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/some-carrier": {
"launchState": "LAUNCH_STATE_PENDING",
"updateTime": "2023-02-24T15:02:13.903554Z"
},
"/v1/regions/another-carrier": {
"launchState": "LAUNCH_STATE_PENDING",
"updateTime": "2023-02-24T15:04:50.456552Z"
}
},
"launchRegion": "NORTH_AMERICA"
}
}
Mencantumkan semua agen yang dibuat untuk merek
Developer dapat mengambil daftar semua agen yang telah mereka buat untuk sebuah merek.
Node.js
const businessCommunicationsApiHelper =
require('@google/rbm-businesscommunications');
const privateKey =
require('../../resources/businesscommunications-service-account-credentials.json');
businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);
businessCommunicationsApiHelper.listAgents(brand.name).then((response) => {
console.log('Current agents are:');
console.log(response.data);
datastore.saveJsonData('agents', response.data.agents);
}).catch((err) => {
console.log(err);
});
Java
Brand brand = api.getBrand(brandId);
logger.info("Brand: " + brand);
ListAgentsResponse response = api.listAllAgents(brand);
List<Agent> agents = response.getAgents().stream()
.sorted(Comparator.comparing(Agent::getName)).collect(Collectors.toList());
logger.info(String.format("Found %d agents", response.getAgents().size()));
for (Agent agent : agents) {
logger.info(String.format("Agent [%s]: '%s'", agent.getName(), agent.getDisplayName()));
}
Kode ini menampilkan daftar semua agen yang dimiliki oleh brand:
{
agents: [
{
name: 'brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_4fpd1psz_agent',
displayName: 'My new agent',
rcsBusinessMessagingAgent: [Object]
},
{
name: 'brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_ciymyd2b_agent',
displayName: 'My second agent',
rcsBusinessMessagingAgent: [Object]
},
{
name: 'brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_helof85o_agent',
displayName: 'My third agent',
rcsBusinessMessagingAgent: [Object]
}
]
}
Menghapus agen
Karena alasan keamanan, agen RBM tidak dapat lagi dihapus. Hubungi Dukungan RBM untuk mendapatkan bantuan.