Operatörler için temel RBM iş akışında, yeni aracılarla ilgili bilgilerin incelenmesi, temsilcilerin operatörün ağında lansman yapma ve abonelerine mesaj gönderme izninin onaylanması veya reddedilmesi yer alır.
Bu sayfadaki kod snippet'leri JavaScript ve Curl örneklerimizden alınmıştır.
Operatöre gönderilen tüm aracıları listeleme
Operatör, geliştiricilerin operatör ağında lansman için gönderdiği tüm aracıların listesini alabilir.
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`"
Tüm aracıların listesini alırken gerekli olmaması nedeniyle marka - olarak ayarlandı.
Bu kod, operatörde başlatmak için gönderilen tüm temsilcilerin bir listesini döndürür:
{
"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"
}
}
]
}
Sonuçlar her seferinde tek bir sayfadan alınabilir. Ayrıntılar için API referansına bakın.
Temsilci başlatma durumunu ve anketini alma
Operatör, bir temsilcinin mevcut başlatma durumunu ve geliştirici lansman anketini alabilir.
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`"
Arayanın, marka adı da dahil olmak üzere temsilcinin tam adını kullanması gerekmez.
Yalnızca aracı kimliği (@rbm.goog öncesinde) gerekir. Marka adı - olarak ayarlanmıştır.
Bu kod başlatma bilgilerini döndürür:
{
"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"
}
}
}
}
Aracı tanımı alma
Bir aracının bilgilerini, benzersiz tanımlayıcısını (name) kullanarak alabilirsiniz.
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`"
Arayanın, marka adı da dahil olmak üzere temsilcinin tam adını kullanması gerekmez.
Yalnızca aracı kimliği (@rbm.goog öncesinde) gerekir. Marka adı - olarak ayarlanmıştır.
Bu kod, temsilci bilgilerini döndürür:
{
"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"
}
}
Temsilci başlatma durumunu değiştir
Operatör, temsilcinin başlatma durumunu güncelleyebilir ve geliştiriciye e-postayla gönderilecek bir mesaj ekleyebilir.
Durum, şu şekilde değiştirilmelidir:
LAUNCH_STATE_PENDING-LAUNCH_STATE_LAUNCHEDveyaLAUNCH_STATE_REJECTEDLAUNCH_STATE_LAUNCHED-LAUNCH_STATE_SUSPENDEDLAUNCH_STATE_SUSPENDED-LAUNCH_STATE_LAUNCHEDveyaLAUNCH_STATE_REJECTED
Arayanın, marka adı da dahil olmak üzere temsilcinin tam adını kullanması gerekmez.
Yalnızca aracı kimliği (@rbm.goog öncesinde) gerekir. Marka adı - olarak ayarlanmıştır.
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',
}
}
}
}"
Bu kod, başlatma durumu değiştirilmiş olarak güncellenmiş başlatma bilgilerini döndürür:
{
"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"
}
}
}
}
Temsilci silme
Güvenlik nedeniyle RBM temsilcileri artık silinemez. Yardım için RBM Destek Ekibi ile iletişime geçin.