Quản lý nhân viên hỗ trợ bằng RBM Operations API

Quy trình làm việc cốt lõi của RBM dành cho nhà mạng bao gồm việc xem xét thông tin về các tác nhân mới và phê duyệt hoặc từ chối quyền ra mắt của các tác nhân đó trên mạng của nhà mạng và gửi tin nhắn cho người đăng ký.

Đoạn mã trên trang này được lấy từ các mẫu Javascript và Curl của chúng tôi.

Liệt kê tất cả các tác nhân được gửi đến một nhà mạng

Nhà mạng có thể lấy danh sách tất cả các tác nhân mà nhà phát triển đã gửi để ra mắt trên mạng của nhà mạng.

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

Thương hiệu được đặt thành - vì không bắt buộc khi truy xuất danh sách tất cả các tác nhân.

Mã này trả về danh sách tất cả các tác nhân được gửi để ra mắt tại nhà mạng:

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

Bạn có thể truy xuất kết quả từng trang một. Xem tài liệu tham khảo API để biết thông tin chi tiết.

Lấy thông tin xác minh của tác nhân

Nhà mạng có thể lấy trạng thái xác minh thương hiệu của một tác nhân. Để biết thêm thông tin chi tiết, hãy xem 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`"

Người gọi không nhất thiết phải có tên đầy đủ của tác nhân, bao gồm cả tên thương hiệu. Bạn chỉ cần có mã tác nhân (trước @rbm.goog), với tên thương hiệu được đặt thành -.

Mã này trả về trạng thái xác minh và thông tin đối tác:

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

Lấy trạng thái ra mắt và bảng câu hỏi của tác nhân

Nhà mạng có thể lấy trạng thái ra mắt hiện tại của một tác nhân và bảng câu hỏi ra mắt của nhà phát triển.

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

Mã này trả về thông tin ra mắt:

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

Tra cứu định nghĩa của tác nhân

Nhà mạng có thể truy xuất thông tin của một tác nhân bằng cách sử dụng mã nhận dạng duy nhất (name) của tác nhân đó.

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

Mã này trả về thông tin của tác nhân:

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

Thay đổi trạng thái ra mắt của tác nhân

Nhà mạng có thể cập nhật trạng thái ra mắt của một tác nhân và đưa ra nhận xét giải thích lý do thay đổi trạng thái.

Lưu ý: Yêu cầu đối với trường comment thay đổi tuỳ theo hành động:

Không bắt buộc: Phê duyệt việc ra mắt.
Bắt buộc: Yêu cầu từ chối, tạm ngưng và huỷ ra mắt.

Nhận xét này được gửi cho nhà phát triển trong một email, hiển thị trong Lịch sử tác nhân của cả Bảng điều khiển quản trị và Bảng điều khiển Business Communications, đồng thời được đưa vào AgentLaunchEvent thông báo webhook. Quy trình phân phối này áp dụng cho tất cả các bản cập nhật trạng thái.

Bạn nên thay đổi trạng thái như sau:

LAUNCH_STATE_PENDING thành LAUNCH_STATE_LAUNCHED hoặc LAUNCH_STATE_REJECTED
LAUNCH_STATE_LAUNCHED thành LAUNCH_STATE_SUSPENDED
LAUNCH_STATE_SUSPENDED thành LAUNCH_STATE_LAUNCHED hoặc 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" \
  -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',
        }
      }
    }
  }"

Mã này trả về thông tin ra mắt đã cập nhật với trạng thái ra mắt đã thay đổi:

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

Ẩn hoặc hiện tác nhân

Để duy trì một không gian làm việc gọn gàng và có tổ chức, bạn có thể ẩn những tác nhân không còn được sử dụng trên mạng của mình. Việc ẩn một tác nhân sẽ xoá tác nhân đó khỏi kết quả phát hiện API mặc định.

Việc ẩn chỉ là thay đổi chế độ hiển thị. Việc này chỉ ảnh hưởng đến chế độ xem cho nhà mạng cụ thể của bạn và không ảnh hưởng đến trạng thái của tác nhân đối với đối tác hoặc các nhà mạng khác. Bạn có thể hiện tác nhân bất cứ lúc nào để khôi phục chế độ hiển thị và tiếp tục quản lý.

Để đảm bảo rằng các tác nhân đang hoạt động không bị vô tình xoá khỏi chế độ xem, hãy áp dụng các quy tắc sau:

Điều kiện: Bạn chỉ có thể ẩn những tác nhân đang ở trạng thái không hoạt động trên mạng của mình: Tạm ngưng hoặc Bị từ chối.
Hạn chế: Bạn không thể ẩn một tác nhân nếu trạng thái ra mắt của tác nhân đó trên mạng của bạn là Đã ra mắt hoặc Đang chờ xử lý. Nếu bạn cố gắng ẩn một tác nhân như vậy, yêu cầu sẽ bị từ chối kèm theo lỗi FAILED_PRECONDITION.

Cập nhật trạng thái ẩn

Để ẩn hoặc hiện một tác nhân ra mắt cho nhà mạng của bạn, hãy sử dụng phương thức setAgentLaunchVisibility trên tài nguyên ra mắt. Để ẩn, hãy đặt giá trị boolean isHidden thành true và để hiện, hãy đặt giá trị này thành false.

Phương thức: 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
      }
    }
  }
}

Liệt kê tác nhân bằng bộ lọc

Theo mặc định, phương thức list sẽ loại trừ các tác nhân bị nhà mạng của bạn ẩn. Để đưa các tác nhân đó vào kết quả, hãy sử dụng tham số includeHidden.

Xoá tác nhân

Vì lý do bảo mật, bạn không thể xoá tác nhân RBM nữa. Để được hỗ trợ, hãy liên hệ với nhóm hỗ trợ RCS for Business.

Quản lý nhân viên hỗ trợ bằng RBM Operations API Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Liệt kê tất cả các tác nhân được gửi đến một nhà mạng

Node.js

cURL

Lấy thông tin xác minh của tác nhân

Node.js

cURL

Lấy trạng thái ra mắt và bảng câu hỏi của tác nhân

Node.js

cURL

Tra cứu định nghĩa của tác nhân

Node.js

cURL

Thay đổi trạng thái ra mắt của tác nhân

Node.js

cURL

Ẩn hoặc hiện tác nhân

Cập nhật trạng thái ẩn

Liệt kê tác nhân bằng bộ lọc

Xoá tác nhân

Quản lý nhân viên hỗ trợ bằng RBM Operations API