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

إدارة الوكلاء باستخدام واجهة برمجة تطبيقات عمليات RBM

يتضمّن سير عمل RBM الأساسي لمشغّلي شبكات الجوّال مراجعة معلومات عن الوكلاء الجدد والموافقة على منحهم إذن الإطلاق على شبكة مشغّل شبكة الجوّال وإرسال الرسائل إلى المشتركين أو رفض ذلك.

تم أخذ مقتطفات التعليمات البرمجية في هذه الصفحة من نماذج JavaScript وCurl.

إدراج جميع الوكلاء الذين تم إرسالهم إلى مشغّل شبكة جوّال

يمكن لمشغّل شبكة الجوّال الحصول على قائمة بجميع الوكلاء الذين أرسلهم المطوّرون لإطلاقهم على شبكة مشغّل شبكة الجوّال.

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

تم ضبط العلامة التجارية على - لأنّها ليست مطلوبة عند استرداد قائمة بجميع الوكلاء.

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

{
  "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",
        "partner": {
          "partnerId": "unique-identifier-for-my-partner",
          "displayName": "My partner",
          "company": "Public name of the company for my partner"
        }
      }
    },
    {
      "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",
        "partner": {
          "partnerId": "unique-identifier-for-my-partner",
          "displayName": "My partner",
          "company": "Public name of the company for my partner"
        }
      }
    }
  ]
}

يمكن استرداد النتائج صفحة واحدة في كل مرة. يمكنك الاطّلاع على مرجع واجهة برمجة التطبيقات لمزيد من التفاصيل.

الحصول على معلومات التحقّق من الوكيل

يمكن لمشغّل شبكة الجوّال الحصول على حالة التحقّق من العلامة التجارية للوكيل. لمزيد من التفاصيل، يمكنك الاطّلاع على 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(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`"

لا يحتاج المتصل بالضرورة إلى اسم الوكيل بالكامل، بما في ذلك اسم العلامة التجارية. يجب إدخال رقم تعريف الوكيل فقط (قبل @rbm.goog)، مع ضبط اسم العلامة التجارية على -.

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

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

الحصول على حالة إطلاق الوكيل والاستبيان

يمكن لمشغّل شبكة الجوّال الحصول على حالة الإطلاق الحالية للوكيل واستبيان إطلاق المطوّر.

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

تعرض هذه التعليمات البرمجية معلومات الإطلاق:

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

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

يمكن لمشغّل شبكة الجوّال استرداد معلومات الوكيل باستخدام المعرّف الفريد (name).

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

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

{
  "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",
    "partner": {
      "partnerId": "unique-identifier-for-my-partner",
      "displayName": "My partner",
      "company": "Public name of the company for my partner"
    }
  }
}

تغيير حالة إطلاق الوكيل

يمكن لمشغّل شبكة الجوّال تعديل حالة إطلاق الوكيل وتضمين تعليق يوضّح سبب تغيير الحالة.

ملاحظة: تختلف متطلبات حقل comment حسب الإجراء:

اختياري: عمليات الموافقة على الإطلاق
مطلوب: حالات الرفض والتعليق وطلبات إلغاء الإطلاق

سجلّ التدقيق: يمكنك اختياريًا تضمين acting_party مَعلمة طلب البحث لتحديد عنوان البريد الإلكتروني أو المعرّف الخاص بالشخص الذي ينفّذ الإجراء. يضمن ذلك أن يحدّد حقل رقم تعريف المستخدم في سجلّات السجلّات الفرد بشكل صحيح بدلاً من ضبطه تلقائيًا على "طلب واجهة برمجة التطبيقات".

يتم إرسال هذا التعليق إلى المطوّر في رسالة إلكترونية، ويظهر في سجلّ الوكيل في كلّ من وحدة تحكّم المشرف و RCS for Business ، ويتم تضمينه في AgentLaunchEvent إشعارات الويب هوك. ينطبق هذا التسليم على جميع تعديلات الحالة.

يجب تغيير الحالة على النحو التالي:

LAUNCH_STATE_PENDING إلى LAUNCH_STATE_LAUNCHED أو LAUNCH_STATE_REJECTED
LAUNCH_STATE_LAUNCHED إلى LAUNCH_STATE_SUSPENDED
LAUNCH_STATE_SUSPENDED إلى LAUNCH_STATE_LAUNCHED أو LAUNCH_STATE_UNLAUNCHED

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?acting_party=user@example.com" \
  -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',
        }
      }
    }
  }"

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

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

إخفاء الوكلاء أو إظهارهم

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

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

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

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

تعديل حالة الإخفاء

لإخفاء إطلاق وكيل أو إظهاره لمشغّل شبكة الجوّال، استخدِم طريقة setAgentLaunchVisibility في مورد الإطلاق. للإخفاء، اضبط القيمة المنطقية isHidden على true ولإظهارها، اضبطها على false.

الطريقة: POST /v1/brands/{brandId}/agents/{agentId}/launch:setAgentLaunchVisibility

curl -v -X POST "https://businesscommunications.googleapis.com/v1/brands/$BRAND_ID/agents/$AGENT_ID/launch:setAgentLaunchVisibility" \
  -H "Content-Type: application/json" \
  -H "User-Agent: curl/business-messaging" \
  -H "$(oauth2l header --json serviceAccount.json businesscommunications)" \
  --data '{
    "name": "brands/$BRAND_ID/agents/$AGENT_ID/launch",
    "isHidden": true
  }'

{
  "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_SUSPENDED",
        "updateTime": "2026-02-20T15:10:36.528669Z",
        "isHidden": true
      }
    }
  }
}

إدراج الوكلاء باستخدام الفلاتر

تستبعد طريقة list تلقائيًا الوكلاء الذين أخفاهم مشغّل شبكة الجوّال. لتضمينهم في نتائجك، استخدِم المَعلمة includeHidden.

حذف وكيل

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

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

إدراج جميع الوكلاء الذين تم إرسالهم إلى مشغّل شبكة جوّال

Node.js

cURL

الحصول على معلومات التحقّق من الوكيل

Node.js

cURL

الحصول على حالة إطلاق الوكيل والاستبيان

Node.js

cURL

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

Node.js

cURL

تغيير حالة إطلاق الوكيل

Node.js

cURL

إخفاء الوكلاء أو إظهارهم

تعديل حالة الإخفاء

إدراج الوكلاء باستخدام الفلاتر

حذف وكيل

إدارة الوكلاء باستخدام واجهة برمجة تطبيقات عمليات RBM