REST Resource: brands.agents

Tài nguyên: Agent

Một thực thể đàm thoại đại diện cho một thương hiệu.

Biểu diễn dưới dạng JSON

Biểu diễn dưới dạng JSON
{ "name": string, "displayName": string, "brandName": string, "isArchived": boolean, // Union field `detail_info` can be only one of the following: "rcsBusinessMessagingAgent": { object (`RcsBusinessMessagingAgent`) } // End of list of possible types for union field `detail_info`. }

{
  "name": string,
  "displayName": string,
  "brandName": string,
  "isArchived": boolean,

  // Union field detail_info can be only one of the following:
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}

Trường
`name`	`string` Giá trị nhận dạng riêng biệt của nhân viên. Chỉ đọc. Do nền tảng xác định.
`displayName`	`string` Bắt buộc. Tên mà nhân viên hỗ trợ hiển thị cho người dùng. Tối đa 40 ký tự. Không thể sửa đổi sau khi xác minh nhân viên hỗ trợ.
`brandName`	`string` Chỉ có đầu ra. Tên của thương hiệu được liên kết với nhân viên hỗ trợ.
`isArchived`	`boolean` Không bắt buộc. Nếu `true`, thì nhân viên hỗ trợ sẽ được lưu trữ và không có trong kết quả danh sách theo mặc định.
Trường nhóm `detail_info`. Chứa các trường bắt buộc đối với sản phẩm cụ thể. Bắt buộc. `detail_info` chỉ có thể là một trong những trạng thái sau:
`rcsBusinessMessagingAgent`	`object (RcsBusinessMessagingAgent)` Thông tin chi tiết về nhân viên hỗ trợ cho RCS for Business.

RcsBusinessMessagingAgent

Thông tin về tác nhân liên quan cụ thể đến RCS for Business. Để tạo tác nhân, bạn nên cung cấp ít nhất một phương thức liên hệ (điện thoại, email hoặc trang web) kèm theo nhãn tương ứng. Để triển khai nhân viên hỗ trợ, bạn phải có ít nhất một phương thức liên hệ (điện thoại, email hoặc trang web) kèm theo nhãn tương ứng.

Biểu diễn dưới dạng JSON

Biểu diễn dưới dạng JSON
{ "description": string, "logoUri": string, "heroUri": string, "phoneNumbers": [ { object (`PhoneEntry`) } ], "emails": [ { object (`EmailEntry`) } ], "websites": [ { object (`WebEntry`) } ], "privacy": { object (`WebEntry`) }, "termsConditions": { object (`WebEntry`) }, "color": string, "billingConfig": { object (`RcsBusinessMessagingAgentBillingConfig`) }, "agentUseCase": enum (`AgentUseCase`), "hostingRegion": enum (`HostingRegion`), "partner": { object (`PartnerEntry`) }, "launchDetails": { string: { object (`RcsBusinessMessagingRegionLaunch`) }, ... }, "indiaPrincipalEntityId": string }

{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion),
  "partner": {
    object (PartnerEntry)
  },
  "launchDetails": {
    string: {
      object (RcsBusinessMessagingRegionLaunch)
    },
    ...
  },
  "indiaPrincipalEntityId": string
}

Trường
`description`	`string` Bắt buộc. Nội dung mô tả về tác nhân mà người dùng có thể nhìn thấy. Tối đa 100 ký tự. Hãy xem bài viết Chỉnh sửa thông tin về đại lý để biết các yêu cầu chi tiết.
`logoUri`	`string` Bắt buộc. URL công khai của biểu trưng cho tác nhân. Tối đa 50 KB. Không thể sửa đổi sau khi xác minh nhân viên hỗ trợ.
`heroUri`	`string` Bắt buộc. URL công khai của hình ảnh chính cho tác nhân. Tối đa 200 KB. Không thể sửa đổi sau khi xác minh nhân viên hỗ trợ.
`phoneNumbers[]`	`object (PhoneEntry)` Không bắt buộc. Số điện thoại liên kết với nhân viên hỗ trợ. Bắt buộc nếu bạn không cung cấp email và trang web.
`emails[]`	`object (EmailEntry)` Không bắt buộc. Địa chỉ email được liên kết với nhân viên hỗ trợ. Bạn phải cung cấp thông tin này nếu không cung cấp số điện thoại và trang web.
`websites[]`	`object (WebEntry)` Không bắt buộc. Các trang web được liên kết với nhân viên hỗ trợ. Tối đa 3. Bắt buộc nếu bạn không cung cấp số điện thoại và email.
`privacy`	`object (WebEntry)` Bắt buộc. Chính sách quyền riêng tư liên kết với tác nhân.
`termsConditions`	`object (WebEntry)` Bắt buộc. Điều khoản và điều kiện liên quan đến nhân viên hỗ trợ.
`color`	`string` Bắt buộc. Màu giao diện của tác nhân mà người dùng nhìn thấy ở định dạng thập lục phân. Ví dụ: #FF6347.
`billingConfig`	`object (RcsBusinessMessagingAgentBillingConfig)` Bắt buộc. Cấu hình thanh toán cho đại lý.
`agentUseCase`	`enum (AgentUseCase)` Không bắt buộc. Trường hợp sử dụng bot.
`hostingRegion`	`enum (HostingRegion)` Bắt buộc. Khu vực lưu trữ của nhân viên hỗ trợ.
`partner`	`object (PartnerEntry)` Chỉ có đầu ra. Đối tác liên kết với nhân viên hỗ trợ.
`launchDetails`	`map (key: string, value: object (RcsBusinessMessagingRegionLaunch))` Chỉ có đầu ra. Thông tin chi tiết về việc ra mắt nhân viên hỗ trợ. Chỉ được điền sẵn cho hãng vận chuyển và chỉ có thông tin chi tiết về việc ra mắt liên quan đến hãng vận chuyển thực hiện cuộc gọi.
`indiaPrincipalEntityId`	`string` Không bắt buộc. Giá trị nhận dạng thực thể chính (PE ID) của doanh nghiệp ở Ấn Độ được liên kết với tác nhân. Bắt buộc nếu bạn dự định phát hành tác nhân ở Ấn Độ.

PhoneEntry

Số điện thoại liên kết với nhân viên hỗ trợ.

Biểu diễn dưới dạng JSON
{ "phoneNumber": { object (`Phone`) }, "label": string }

Trường

Trường
`phoneNumber`	`object (Phone)` Bắt buộc. Số điện thoại ở hai định dạng có thể có: định dạng E.164 đầy đủ (ví dụ: "+12223334444") hoặc số điện thoại địa phương/miễn phí không được định dạng, không có dấu "+", tiền tố hoặc mã quốc gia (ví dụ: "6502530000"). Lưu ý: Bạn không được phép sử dụng số khẩn cấp.
`label`	`string` Bắt buộc. Nhãn của số điện thoại.

phoneNumber

object (Phone)

Bắt buộc. Số điện thoại ở hai định dạng có thể có: định dạng E.164 đầy đủ (ví dụ: "+12223334444") hoặc số điện thoại địa phương/miễn phí không được định dạng, không có dấu "+", tiền tố hoặc mã quốc gia (ví dụ: "6502530000"). Lưu ý: Bạn không được phép sử dụng số khẩn cấp.

label

string

Bắt buộc. Nhãn của số điện thoại.

EmailEntry

Email được liên kết với nhân viên hỗ trợ.

Biểu diễn dưới dạng JSON
{ "address": string, "label": string }

Trường

Trường
`address`	`string` Bắt buộc. Địa chỉ email.
`label`	`string` Bắt buộc. Nhãn cho địa chỉ email.

address

string

Bắt buộc. Địa chỉ email.

label

string

Bắt buộc. Nhãn cho địa chỉ email.

WebEntry

Một tài nguyên dựa trên web liên kết với nhân viên hỗ trợ.

Biểu diễn dưới dạng JSON
{ "uri": string, "label": string }

Trường

Trường
`uri`	`string` Bắt buộc. Một URI có thể truy cập công khai được liên kết với tác nhân. Phải sử dụng giao thức HTTP hoặc HTTPS.
`label`	`string` Bắt buộc đối với `websites`, nếu không thì không bắt buộc. Nhãn cho URI.

uri

string

Bắt buộc. Một URI có thể truy cập công khai được liên kết với tác nhân. Phải sử dụng giao thức HTTP hoặc HTTPS.

label

string

Bắt buộc đối với websites, nếu không thì không bắt buộc. Nhãn cho URI.

RcsBusinessMessagingAgentBillingConfig

Cấu hình thanh toán cho đại lý.

Biểu diễn dưới dạng JSON
{ "billingCategory": enum (`BillingCategory`) }

Trường

Trường
`billingCategory`	`enum (BillingCategory)` Danh mục thanh toán cho nhân viên hỗ trợ.

billingCategory

enum (BillingCategory)

Danh mục thanh toán cho nhân viên hỗ trợ.

BillingCategory

Danh mục thanh toán được hỗ trợ.

Enum
`BILLING_CATEGORY_UNSPECIFIED`	Chưa chỉ định danh mục.
`CONVERSATIONAL_LEGACY`	Danh mục cũ để hỗ trợ cấu hình thanh toán của các trợ lý ảo hiện có. Thay vào đó, hãy sử dụng `CONVERSATIONAL`. Mục này không còn được dùng nữa!
`CONVERSATIONAL`	Được thiết kế cho các phiên dài hơn và phức tạp hơn, trong đó người dùng và thương hiệu trao đổi một loạt thông báo.
`SINGLE_MESSAGE`	Thay thế tin nhắn SMS bằng trải nghiệm nhắn tin phong phú hơn. Không bao giờ được tính phí là CONVERSATIONAL. Mục này không còn được dùng nữa!
`BASIC_MESSAGE`	Mô hình thanh toán tương tự như SMS. Không bao giờ được tính phí là CONVERSATIONAL. Mục này không còn được dùng nữa!
`NON_CONVERSATIONAL`	Đại diện cho một danh mục thanh toán không liên quan đến hoạt động trò chuyện, thay thế các danh mục cũ là SINGLE_MESSAGE và BASIC_MESSAGE. Đây là dành cho những nhân viên chủ yếu tham gia vào hoạt động giao tiếp một chiều (A2P).

AgentUseCase

Các loại trường hợp sử dụng của nhân viên hỗ trợ được dùng trong bộ nhớ.

Enum
`AGENT_USE_CASE_UNSPECIFIED`	Chưa chỉ định trường hợp sử dụng.
`TRANSACTIONAL`	Những tác nhân chỉ gửi các tin nhắn cần thiết, bắt buộc và khẩn cấp.
`PROMOTIONAL`	Những tác nhân gửi thông điệp bán hàng, tiếp thị và khuyến mãi. Loại mặc định.
`OTP`	Những tác nhân chỉ gửi mật khẩu một lần.
`MULTI_USE`	Các tác nhân có nhiều trường hợp sử dụng. Điều này bao gồm cả những tác nhân mà một trường hợp sử dụng được ra mắt ngay lập tức, trong khi trường hợp sử dụng thứ hai được lên kế hoạch phát hành trong tương lai. Để biết thêm thông tin, hãy xem tài liệu về Nhiều mục đích sử dụng.

HostingRegion

Các khu vực lưu trữ có thể có cho một nhân viên hỗ trợ, được dùng để định tuyến chính xác các thông báo P2A đến máy chủ theo khu vực.

Enum
`HOSTING_REGION_UNSPECIFIED`	Vùng lưu trữ chưa được chỉ định.
`NORTH_AMERICA`	Bắc Mỹ.
`EUROPE`	Châu Âu.
`ASIA_PACIFIC`	Châu Á – Thái Bình Dương.

PartnerEntry

Đối tác liên kết với nhân viên hỗ trợ.

Biểu diễn dưới dạng JSON
{ "partnerId": string, "displayName": string, "company": string }

Trường

Trường
`partnerId`	`string` Chỉ có đầu ra. Giá trị nhận dạng riêng biệt của đối tác.
`displayName`	`string` Chỉ có đầu ra. Tên sẽ được hiển thị cho doanh nghiệp để liên kết đối tác cho sản phẩm. Phải là duy nhất trong số các đối tác.
`company`	`string` Chỉ có đầu ra. Tên công khai của công ty đối với đối tác đã cho.

partnerId

string

Chỉ có đầu ra. Giá trị nhận dạng riêng biệt của đối tác.

displayName

string

Chỉ có đầu ra. Tên sẽ được hiển thị cho doanh nghiệp để liên kết đối tác cho sản phẩm. Phải là duy nhất trong số các đối tác.

company

string

Chỉ có đầu ra. Tên công khai của công ty đối với đối tác đã cho.

RcsBusinessMessagingRegionLaunch

Thông tin chi tiết về việc ra mắt tác nhân doanh nghiệp RCS for Business ở từng khu vực.

Biểu diễn dưới dạng JSON
{ "launchState": enum (`LaunchState`), "comment": string, "updateTime": string, "isHidden": boolean }

Trường
`launchState`	`enum (LaunchState)` Trạng thái phát hành của một khu vực.
`comment`	`string` Bình luận của hãng vận chuyển.
`updateTime`	`string (Timestamp format)` Thời gian cập nhật gần đây nhất. Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` hoặc `"2014-10-02T15:01:23+05:30"`.
`isHidden`	`boolean` Không bắt buộc. Chỉ định xem tác nhân có được đánh dấu là ẩn đối với hãng vận chuyển hay không. Điều này ảnh hưởng đến khả năng hiển thị của các chế độ xem trên bảng điều khiển và API.

LaunchState

Trạng thái phát hành của một thực thể. Để tìm hiểu về các trạng thái chuyển đổi được phép khi khởi chạy cho cả hãng vận chuyển và đối tác, hãy xem phần Nhận sự kiện.

Enum
`LAUNCH_STATE_UNSPECIFIED`	Trạng thái chưa xác định.
`LAUNCH_STATE_UNLAUNCHED`	Thực thể chưa được ra mắt.
`LAUNCH_STATE_PENDING`	Đang xem xét việc phát hành.
`LAUNCH_STATE_LAUNCHED`	Đã ra mắt.
`LAUNCH_STATE_REJECTED`	Yêu cầu phát hành bị từ chối.
`LAUNCH_STATE_SUSPENDED`	Đã tạm ngưng việc phát hành.
`LAUNCH_STATE_PENDING_UNLAUNCH`	Không dùng nữa: Trạng thái này không còn được dùng nữa. Yêu cầu huỷ phát hành đang được xem xét. Mục này không còn được dùng nữa!
`LAUNCH_STATE_INVALID_IN_GMB`	Không dùng nữa: Trạng thái này không còn được dùng nữa. Không thể khởi chạy vì Trang thông tin liên kết trên Google Doanh nghiệp của tôi không hỗ trợ tính năng nhắn tin. Việc xác minh lại trong Google Doanh nghiệp của tôi sẽ tự động khởi động lại tại đây. Chỉ áp dụng cho vị trí. Mục này không còn được dùng nữa!

Phương thức
`create`	Tạo một tác nhân mới đại diện cho một thương hiệu.
`delete (deprecated)`	Không dùng nữa: tính năng xoá nhân viên hỗ trợ không còn được dùng nữa.
`get`	Xem thông tin về một trợ lý ảo.
`getLaunch`	Lấy thông tin ra mắt của một nhân viên hỗ trợ.
`getVerification`	Lấy thông tin xác minh cho một nhân viên hỗ trợ.
`list`	Liệt kê tất cả các nhân viên hỗ trợ được liên kết với một thương hiệu.
`patch`	Cập nhật thông tin về một nhân viên hỗ trợ.
`requestLaunch`	Bắt đầu quy trình khởi chạy cho một tác nhân.
`requestVerification`	Gửi thông tin xác minh doanh nghiệp cho một nhân viên hỗ trợ.
`updateLaunch`	Cập nhật thông tin về việc ra mắt cho một nhân viên hỗ trợ.
`updateVerification`	Cập nhật trạng thái xác minh của một nhân viên hỗ trợ.

REST Resource: brands.agents

Tài nguyên: Agent

RcsBusinessMessagingAgent

PhoneEntry

EmailEntry

WebEntry

RcsBusinessMessagingAgentBillingConfig

BillingCategory

AgentUseCase

HostingRegion

PartnerEntry

RcsBusinessMessagingRegionLaunch

LaunchState

Phương thức

`create`

`delete (deprecated)`

`get`

`getLaunch`

`getVerification`

`list`

`patch`

`requestLaunch`

`requestVerification`

`updateLaunch`

`updateVerification`

REST Resource: brands.agents 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.

Tài nguyên: Agent

RcsBusinessMessagingAgent

PhoneEntry

EmailEntry

WebEntry

RcsBusinessMessagingAgentBillingConfig

BillingCategory

AgentUseCase

HostingRegion

PartnerEntry

RcsBusinessMessagingRegionLaunch

LaunchState

Phương thức

delete (deprecated)

REST Resource: brands.agents

`delete (deprecated)`