Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

إدارة الوكلاء

ينتمي جميع العملاء إلى علامة تجارية (نشاط تجاري أو مؤسسة أو مجموعة). قبل إنشاء وكيل، يجب إنشاء علامة تجارية مالكة. العلامات التجارية هي تنظيمية بحتة لمساعدتك في تجميع الوكلاء ذوي الصلة معًا

تم أخذ مقتطفات الرموز البرمجية في هذه الصفحة من عيّنات Java وعيّنات Node.js.

إنشاء الوكلاء وتعريفهم

إنشاء وكيل

لإنشاء وكيل RBM، عليك تحديد المعلومات الأساسية الخاصة به.

لمزيد من التفاصيل، يُرجى الاطّلاع على brands.agents.create.

cURL

curl -v -X POST "https://businesscommunications.googleapis.com/v1/$BRAND_ID/agents" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json rbm-developer-service-account-credentials.json businesscommunications`" \
  -d "{
    'displayName': 'My test agent',
    'rcsBusinessMessagingAgent': {
      'description': 'My agent description',
      'logoUri': 'https://agent-logos.storage.googleapis.com/_/kt90w53vzw2QSxK6PG1uCeJf',
      'heroUri': 'https://agent-logos.storage.googleapis.com/_/kt90vzob74GQcfeHoEQbVRTP',
      'phoneNumbers': [
        {
            'phoneNumber': {
                'number': '+44800088088'
            },
            'label': 'My number'
        }
      ],
      'emails': [
        {
            'address': 'support@demo.test',
            'label': 'My email'
        }
      ],
      'websites': [
        {
            'uri': 'https://a.demo.test/',
            'label': 'My site'
        }
      ],
      'privacy': {
        'uri': 'https://a.demo.test/privacy',
        'label': 'My privacy policy'
      },
      'termsConditions': {
        'uri': 'https://a.demo.test/terms',
        'label': 'My terms'
      },
      'color': '#FFFFFF',
      'billingConfig': {
        'billingCategory': 'CONVERSATIONAL'
      },
      'agentUseCase': 'TRANSACTIONAL',
      'hostingRegion': 'EUROPE'
    }
  }"

هذا الرمز هو مقتطف من نموذج RBM Management API.

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'
      }
    ],
    // It's recommended to provide at least one contact method (phone or email) because
    // this is required for launch. For any phone, email, or website provided, a corresponding label
    // must also be included.
    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: 'TRANSACTIONAL',
    hostingRegion: 'EUROPE'
  }
};

businessCommunicationsApiHelper.createAgent(brandId, newAgentDetails).then((response) => {

}).catch((err) => {
  console.log(err);
});

جافا

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);

يعرض هذا الرمز معلومات الوكيل الجديد ومعرّفًا فريدًا مخصّصًا للوكيل:

{
  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: 'NON_CONVERSATIONAL' },
    agentUseCase: 'MULTI_USE',
    hostingRegion: 'EUROPE'
  }
}

البحث عن تعريف وكيل

يمكنك استرداد وكيل من خلال تحديد المعرّف الفريد الخاص به (name). لمزيد من التفاصيل، راجِع brands.agents.list.

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);
});

جافا

Agent agent = api.getAgent(flags.get("agent_id"));
logger.info("Agent: " + agent);

يعرض الرمز التالي معلومات الوكيل:

{
  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: 'NON_CONVERSATIONAL' },
    agentUseCase: 'MULTI_USE',
    hostingRegion: 'EUROPE'
  }
}

التحقّق والبدء

إرسال معلومات التحقّق

يجب تأكيد العلامة التجارية ليتمّ إطلاق الوكيل. يجب إرسال معلومات التحقّق من الوكيل قبل تقديم طلب إطلاقه. يُرجى العِلم أنّه ليس عليك انتظار الموافقة على العلامة التجارية قبل تقديم طلب الإطلاق، إذ تتم الموافقة على العلامة التجارية كجزء من عملية الموافقة على الإطلاق.

لمزيد من التفاصيل، يُرجى الاطّلاع على brands.agents.requestVerification.

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);
});

جافا

AgentVerificationContact contact = AgentFactory.createRbmAgentVerification();
AgentVerification verification = api.requestAgentVerification(agent.getName(), contact);
logger.info("Verification requested: " + verification);

يعرض هذا الرمز معلومات التحقّق:

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

البحث عن معلومات التأكّد من الوكيل

يمكنك استرداد حالة التحقّق من العلامة التجارية للوكيل. لمزيد من التفاصيل، يُرجى الاطّلاع على 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(agent.name).then((response) => {

}).catch((err) => {
  console.log(err);
});

جافا

AgentVerification verification = api.getAgentVerification(agent.getName());
logger.info("RBM agent verification: " + verification);

يعرض هذا الرمز حالة التحقّق ومعلومات الشريك:

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

إرسال وكيل لإطلاقه

يمكنك إرسال وكيل لإطلاقه على شبكة مشغّل واحد أو أكثر. تتولّى Google إدارة بعض عمليات الإطلاق، بينما يتولّى مشغّلو شبكات الجوّال إدارة عمليات الإطلاق الأخرى مباشرةً. قد تتضمّن عمليات الإطلاق التي تديرها شركات النقل متطلبات إضافية. لمزيد من المعلومات، اطّلِع على مقالة عمليات الإطلاق التي تديرها Google مقابل عمليات الإطلاق التي تديرها شركات الاتصالات.

قبل إطلاق وكيل للمرة الأولى، عليك إرسال معلومات التحقّق. يتيح ذلك لشركة Google أو مشغّلي شبكات الجوّال أو كليهما التحقّق من أنّك مفوّض بإدارة الوكيل نيابةً عن العلامة التجارية، وذلك من خلال التواصل مع الشخص المسؤول عن العلامة التجارية. لمزيد من التفاصيل، يُرجى الاطّلاع على مقالة تأكيد العلامة التجارية.

بعد إرسال معلومات إثبات الملكية واستيفاء متطلبات الإطلاق، يمكنك إرسال طلب إطلاق.

يمكنك إرسال وكيل لإطلاقه على شبكة مشغّل واحد أو أكثر. يجب تقديم استبيان الإطلاق المكتمل كجزء من طلب الإطلاق. لمزيد من التفاصيل، يمكنك الاطّلاع على brands.agents.requestLaunch.

cURL

curl -v -X POST "https://businesscommunications.googleapis.com/v1/$AGENT_ID:requestLaunch" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "`oauth2l header --json rbm-developer-service-account-credentials.json businesscommunications`" \
  -d "{
    'agentLaunch': {
      'rcsBusinessMessaging': {
        'questionnaire': {
          'contacts': [
            {
              'name': 'John Doe',
              'title': 'Product Owner',
              'email': 'support@demo.test'
            }
          ],
          'optinDescription': 'Thanks for your request.',
          'triggerDescription': 'Promotional messages will be triggered in a timely manner.',
          'interactionsDescription': 'Promotional messages are one way.',
          'optoutDescription': 'Sorry to see you go.',
          'agentAccessInstructions': 'Thanks for your request.',
          'videoUris': [
            'https://d2q4iodazzzt8b.cloudfront.net/MicrosoftTeamsvideo2_1758533835.mp4'
          ],
          'screenshotUris': [
            'https://rm.virbm.com/Il9ChvVEhS1na5mr/ee9bc94b468a40688fb7fc71cb1c069c.png'
          ]
        },
        'launchDetails': {
          '/v1/regions/$CARRIER_ID': {}
        }
      }
    }
  }"

هذا الرمز هو مقتطف من نموذج RBM Management API.

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);
});

جافا

Optional<Questionnaire> q = Optional.of(AgentFactory.createRbmQuestionnaire());
AgentLaunch launch = api.requestRbmAgentLaunch(agent.getName(), regionIds, q);
logger.info("RBM agent updated launch: " + launch);

تعرض هذه التعليمات البرمجية معلومات تشغيل الوكيل:

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

يُرجى العلم أنّه تم إيقاف launchRegion نهائيًا وسيتم إزالته قريبًا.

إطلاق وكيل في منطقة واحدة أو أكثر

لتشغيل وكيل في منطقة واحدة أو أكثر، إذا لم يتم تشغيل الوكيل من قبل، استدعِ طريقة requestLaunch باستخدام عنصر يحتوي على خريطة مفاتيح فقط لجميع المناطق التي تريد تشغيل الوكيل فيها. يتيح استخدام خريطة فارغة الحفاظ على اتساق واجهة برمجة التطبيقات الداخلية في العناصر المستخدَمة بين طلبات واجهة برمجة التطبيقات.

curl -X POST \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID:requestLaunch" \
-H "Content-Type: application/json" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
  'name': 'brands/BRAND_ID/agents/AGENT_ID/launch',
  'rcsBusinessMessaging': {
    'questionnaire': {
      'contacts': [
        {
          'name': 'Contact person 000',
          'title': 'Contact manager 000',
          'email': 'user@domain.com000'
        }
      ],
      'optinDescription': 'Opt-in description 0',
      'triggerDescription': 'Trigger description 0',
      'optoutDescription': 'Opt-out description 0',
      'agentAccessInstructions': 'Agent instructions 0',
      'videoUris': [
        'https://www.youtube.com/watch?v=NN75im_us4k'
      ],
      'screenshotUris': [
        'https://www.youtube.com/watch?v=NN75im_us4k'
      ]
    },
    'launchDetails': {
      '/v1/regions/fi-rcs': {}
    }
  }
}"

لتفعيل وكيل في منطقة واحدة أو أكثر (عندما يكون الوكيل قد تم تفعيله من قبل)، استدعِ طريقة requestLaunch مع عنصر يحتوي على خريطة مفاتيح فقط لجميع المناطق التي تم تفعيل الوكيل فيها و جميع المناطق التي يريد الوكيل تفعيلها فيها. يتيح استخدام خريطة فارغة الحفاظ على اتساق واجهة برمجة التطبيقات الداخلية في العناصر المستخدَمة بين طلبات البيانات من واجهة برمجة التطبيقات.

curl -X POST \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID:requestLaunch" \
-H "Content-Type: application/json" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
  'name': 'brands/BRAND_ID/agents/AGENT_ID/launch',
  'rcsBusinessMessaging': {
    'launchDetails': {
      '/v1/regions/fi-rcs': {},
      '/v1/regions/vodafone-idea-india': {}
    }
  }
}"

إذا استدعى أحد الوكلاء الطريقة requestLaunch بدون تضمين جميع المناطق التي تم إطلاق الوكيل فيها مسبقًا كمفاتيح، سيتم عرض الخطأ 400 - Bad Request.

البحث عن حالة إطلاق وكيل

يمكنك استرداد حالة الإطلاق الحالية لأحد الوكلاء. لمزيد من التفاصيل، يُرجى الاطّلاع على brands.agents.getLaunch.

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);
});

جافا

AgentLaunch launch = api.getAgentLaunch(agent.getName());
logger.info("RBM agent launch: " + launch);

إذا رفض مشغّل شبكة الجوّال عملية الإطلاق، يمكن للشريك طلب إطلاق التطبيق على مشغّل شبكة الجوّال مرة أخرى (يكون للطلب الحالة UNSPECIFIED وتكون الحالة REJECTED في الخلفية).

تعرض هذه التعليمات البرمجية معلومات الإطلاق وحالة الإطلاق لكل مشغّل شبكة جوّال مستهدف:

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

يُرجى العِلم أنّه تم إيقاف launchRegion نهائيًا وسيتم إزالته قريبًا.

إضافة مشغّلي شبكات جوّال آخرين إلى عملية إطلاق وكيل

بعد استرداد معلومات الإطلاق الحالية الخاصة بالوكيل باستخدام طلب البيانات من واجهة برمجة التطبيقات brands.agents.getLaunch، يمكنك إضافة المزيد من مشغّلي شبكات الجوّال المستهدَفين لتوسيع نطاق وصول الوكيل. لمزيد من التفاصيل، يمكنك الاطّلاع على brands.agents.updateLaunch.

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);
});

يعرض هذا الرمز معلومات الإطلاق المعدَّلة:

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

ما بعد الإطلاق والصيانة

عرض قائمة بجميع الوكلاء الذين تم إنشاؤهم لعلامة تجارية

يمكن للمطوّر استرداد قائمة بجميع البرامج التي أنشأها لعلامة تجارية. لمزيد من التفاصيل، يمكنك الاطّلاع على brands.agents.list.

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);
});

جافا

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()));
}

يعرض هذا الرمز قائمة بجميع الوكلاء التابعين للعلامة التجارية:

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

تضمين الوكلاء المؤرشفين

وفقًا للإعدادات التلقائية، تستبعد قائمة جميع الوكلاء الوكلاء الذين أرشَفهم الشريك. لتضمين الوكلاء المؤرشفين في النتائج، اضبط المَعلمة includeArchived على true.

Node.js

تقبل الطريقة `listAgents` كائن إعدادات اختياريًا لتضمين الوكلاء المؤرشفين.

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

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

businessCommunicationsApiHelper.initBusinessCommunicationsApi(privateKey);

// To list all agents including archived ones, set includeArchived to true
const listOptions = {
  includeArchived: true
};

businessCommunicationsApiHelper.listAgents(brand.name, listOptions).then((response) => {
 console.log('Current agents (including archived) are:');
 console.log(response.data);
 datastore.saveJsonData('agents', response.data.agents);
}).catch((err) => {
 console.log(err);
});

جافا

تتضمّن الطريقة `listAllAgents` مَعلمة منطقية للتحكّم في مستوى الظهور.

// To list all agents including archived ones, pass 'true' for the includeArchived parameter
boolean includeArchived = true;
Brand brand = api.getBrand(brandId);
logger.info("Brand: " + brand);

// Call listAllAgents with the brand and the includeArchived flag
ListAgentsResponse response = api.listAllAgents(brand, includeArchived);

List agents = response.getAgents().stream()
 .sorted(Comparator.comparing(Agent::getName)).collect(Collectors.toList());

logger.info(String.format("Found %d agents (including archived)", response.getAgents().size()));
for (Agent agent : agents) {
 logger.info(String.format("Agent [%s]: '%s' (Archived: %s)",
    agent.getName(), agent.getDisplayName(), agent.getIsArchived()));
}

إلغاء إطلاق وكيل

لإيقاف تشغيل وكيل في منطقة معيّنة، استدعِ طريقة updateLaunch، وحدِّد المنطقة المستهدَفة في خريطة الاستدعاء، واضبط launchState على LAUNCH_STATE_UNLAUNCHED.

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID" \
-H "Content-Type: application/json" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)"\
-d "{
  'rcsBusinessMessaging': {
    'launchDetails': {
      '/v1/regions/fi-rcs': {
        'launchState': 'LAUNCH_STATE_UNLAUNCHED'
      },
      '/v1/regions/vodafone-idea-india': {
        'launchState': 'LAUNCH_STATE_UNLAUNCHED'
      }
    }
  }
}"

حذف وكيل

لأسباب تتعلّق بالأمان، لم يعُد بإمكانك حذف وكلاء RBM. للحصول على المساعدة، يُرجى التواصل مع فريق دعم RCS for Business.

أرشفة الوكلاء أو إخراجهم من الأرشيف

للحفاظ على مساحة عمل منظَّمة ومرتّبة، يمكنك أرشفة الوكلاء الذين لم يعودوا قيد الاستخدام. تؤدي أرشفة وكيل إلى إخفائه من نتائج البحث التلقائي عن واجهات برمجة التطبيقات.

الأرشفة هي تغيير في مستوى الظهور فقط. ولا يؤدي ذلك إلى حذف الوكيل أو التأثير في حالة إطلاقه الأساسية. يمكنك إخراج وكيل من الأرشيف في أي وقت لاستعادة إمكانية الوصول إليه ومواصلة إدارته.

لضمان عدم إخفاء الوكلاء النشطين عن طريق الخطأ، تسري القواعد التالية:

الأهلية: يمكنك فقط أرشفة العملاء الذين يكونون في حالة غير نشطة: UNLAUNCHED أو SUSPENDED أو REJECTED.
القيود: لا يمكنك أرشفة وكيل لديه حالة LAUNCHED أو PENDING على أي شركة اتصالات. إذا حاولت أرشفة وكيل من هذا النوع، سيتم رفض الطلب مع ظهور رسالة خطأ.

تعديل حالة الأرشيف

لأرشفة وكيل أو إخراجه من الأرشيف، استخدِم طريقة التصحيح. يجب تضمين المَعلمة updateMask=is_archived في عنوان URL لتحديد الحقل الذي سيتم تعديله. لأرشفة الرسالة، اضبط قيمة isArchived المنطقية على true، ولإزالة الرسالة من الأرشيف، اضبط القيمة على false.

الطريقة: أضِف is_archived إلى قناع التعديل.PATCH /v1/brands/{brandId}/agents/{agentId}

{
  "isArchived": true
}

عرض قائمة بالوكلاء مع الفلاتر

تخفي الطريقة list تلقائيًا الوكلاء المؤرشفين. لتضمينها في نتائجك، استخدِم المَعلمة include_archived.

طريقة التشفير (Method): GET /v1/brands/{brandId}/agents?include_archived=true

إدارة العلامات التجارية

إدارة المشاركين في الاختبار

إدارة الوكلاء تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

إنشاء الوكلاء وتعريفهم

إنشاء وكيل

cURL

Node.js

جافا

البحث عن تعريف وكيل

Node.js

جافا

التحقّق والبدء

إرسال معلومات التحقّق

Node.js

جافا

البحث عن معلومات التأكّد من الوكيل

Node.js

جافا

إرسال وكيل لإطلاقه

cURL

Node.js

جافا

إطلاق وكيل في منطقة واحدة أو أكثر

البحث عن حالة إطلاق وكيل

Node.js

جافا

إضافة مشغّلي شبكات جوّال آخرين إلى عملية إطلاق وكيل

Node.js

ما بعد الإطلاق والصيانة

عرض قائمة بجميع الوكلاء الذين تم إنشاؤهم لعلامة تجارية

Node.js

جافا

تضمين الوكلاء المؤرشفين

Node.js

جافا

إلغاء إطلاق وكيل

حذف وكيل

أرشفة الوكلاء أو إخراجهم من الأرشيف

تعديل حالة الأرشيف

عرض قائمة بالوكلاء مع الفلاتر

إدارة الوكلاء