Aracıları RBM Operasyonları API'si ile yönetme

Operatörler için temel RBM iş akışı, yeni aracılarla ilgili bilgileri incelemeyi ve operatörün ağında başlatma ve abonelerine mesaj gönderme izni vermeyi veya reddetmeyi içerir.

Bu sayfadaki kod snippet'leri, JavaScript ve Curl örneklerimizden alınmıştır.

Bir operatöre gönderilen tüm temsilcileri listeleme

Operatör, geliştiricilerin operatörün ağında kullanıma sunmak 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 listesi alınırken gerekli olmadığından marka - olarak ayarlanır.

Bu kod, operatörde kullanıma sunulmak üzere gönderilen tüm temsilcilerin 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": "NON_CONVERSATIONAL"
        },
        "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"
        },
        "agentUseCase": "PROMOTIONAL",
        "hostingRegion": "NORTH_AMERICA"
      }
    }
  ]
}

Sonuçlar tek tek sayfalar halinde alınabilir. Ayrıntılar için API referansı bölümüne bakın.

Temsilci doğrulama bilgilerini alma

Kargo şirketi, bir acentenin marka doğrulama durumunu öğrenebilir. Daha fazla bilgi için brands.agents.getVerification başlıklı makaleyi inceleyin.

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

Arayanın, marka adı da dahil olmak üzere temsilcinin tam adına ihtiyacı olmayabilir. Yalnızca temsilci kimliği (@rbm.goog işaretinden önce) gereklidir. Marka adı - olarak ayarlanır.

Bu kod, doğrulama durumunu ve iş ortağı bilgilerini döndürür:

{
  "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"
  }
}

Temsilci başlatma durumu ve anketi alma

Operatör, bir temsilcinin mevcut lansman 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ına ihtiyacı olmayabilir. Yalnızca temsilci kimliği (@rbm.goog işaretinden önce) gereklidir. Marka adı - olarak ayarlanır.

Bu kod, lansman 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"
      }
    }
  }
}

Temsilci tanımını arama

Operatör, benzersiz tanımlayıcısını (name) kullanarak bir temsilcinin bilgilerini alabilir.

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ına ihtiyacı olmayabilir. Yalnızca temsilci kimliği (@rbm.goog işaretinden önce) gereklidir. Marka adı - olarak ayarlanır.

Bu kod, aracı 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": "NON_CONVERSATIONAL"
    },
    "agentUseCase": "MULTI_USE",
    "hostingRegion": "NORTH_AMERICA"
  }
}

Temsilci başlatma durumunu değiştirme

Bir operatör, temsilcinin lansman durumunu güncelleyebilir ve durum değişikliğinin nedenini açıklayan bir yorum ekleyebilir.

Not: comment alanı için koşullar işleme göre değişir:

İsteğe bağlı: Onayları başlatın.
Gerekli: Reddetme, askıya alma ve kullanıma sunmama istekleri.

Bu yorum, geliştiriciye e-postayla gönderilir, hem Yönetim hem de İşletme İletişimi konsollarının Aracı geçmişi bölümünde görünür ve AgentLaunchEvent webhook bildirimlerine dahil edilir. Bu teslimat, tüm durum güncellemeleri için geçerlidir.

Durum aşağıdaki gibi değiştirilmelidir:

LAUNCH_STATE_PENDING öğesini LAUNCH_STATE_LAUNCHED veya LAUNCH_STATE_REJECTED olarak ayarlayın
LAUNCH_STATE_LAUNCHED - LAUNCH_STATE_SUSPENDED
LAUNCH_STATE_SUSPENDED öğesini LAUNCH_STATE_LAUNCHED veya LAUNCH_STATE_REJECTED olarak ayarlayın

Arayanın, marka adı da dahil olmak üzere temsilcinin tam adına ihtiyacı olmayabilir. Yalnızca temsilci kimliği (@rbm.goog işaretinden önce) gereklidir. Marka adı - olarak ayarlanı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, lansman durumu değiştirilmiş olarak güncellenen lansman bilgilerini döndürür:

{
  "name": "brands/40bd963f-ff92-425c-b273-8f0892d2d017/agents/my_new_agent_4fpd1psz_agent/launch",
  "rcsBusinessMessaging": {
    "questionnaire": {
      "contacts": [
        {
          "name": "John Doe",
          "title": "Contact manager",
          "email": "john.doe@gmail.com"
        }
      ],
      "optinDescription": "Users accepted our terms of service online.",
      "triggerDescription": "We are reaching pre-registered users",
      "interactionsDescription": "This agent sends notifications and processes suggested replies.",
      "optoutDescription": "Reply stop and we stop.",
      "agentAccessInstructions": "This is 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.", // Note: The field is optional only for launch approval; otherwise, required.
        "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.

Aracıları RBM Operasyonları API'si ile yönetme Koleksiyonlar ile düzeninizi koruyun İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.

Bir operatöre gönderilen tüm temsilcileri listeleme

Node.js

cURL

Temsilci doğrulama bilgilerini alma

Node.js

cURL

Temsilci başlatma durumu ve anketi alma

Node.js

cURL

Temsilci tanımını arama

Node.js

cURL

Temsilci başlatma durumunu değiştirme

Node.js

cURL

Temsilci silme

Aracıları RBM Operasyonları API'si ile yönetme