REST Resource: brands.agents

แหล่งข้อมูล: ตัวแทน

เอนทิตีแบบสนทนาที่แสดงถึงแบรนด์

การแสดง 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

ต้องระบุ ชื่อที่ตัวแทนแสดงต่อผู้ใช้ สูงสุด 40 อักขระ

แก้ไขไม่ได้หลังจากยืนยันตัวแทนแล้ว
brandName

string

เอาต์พุตเท่านั้น ชื่อของแบรนด์ที่เชื่อมโยงกับเอเจนต์
isArchived

boolean

ไม่บังคับ หากเป็น true ระบบจะเก็บตัวแทนและไม่รวมไว้ในผลการค้นหาของรายการโดยค่าเริ่มต้น

ฟิลด์ Union detail_info มีช่องที่ต้องกรอกสำหรับผลิตภัณฑ์ที่เฉพาะเจาะจง

ต้องระบุ detail_info ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

ข้อมูลตัวแทนโดยละเอียดสำหรับ RCS for Business

RcsBusinessMessagingAgent

ข้อมูลตัวแทนที่เกี่ยวข้องกับ RCS for Business โดยเฉพาะ สําหรับการสร้าง Agent เราขอแนะนําให้ระบุวิธีติดต่ออย่างน้อย 1 วิธี (โทรศัพท์ อีเมล หรือเว็บไซต์) พร้อมป้ายกํากับที่เกี่ยวข้อง สำหรับการเปิดตัวตัวแทน คุณต้องระบุวิธีติดต่ออย่างน้อย 1 วิธี (โทรศัพท์ อีเมล หรือเว็บไซต์) พร้อมป้ายกำกับที่เกี่ยวข้อง

การแสดง 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

ต้องระบุ คำอธิบายของตัวแทนที่ผู้ใช้มองเห็นได้ ยาวไม่เกิน 100 อักขระ ดูข้อกำหนดโดยละเอียดได้ที่แก้ไขข้อมูลตัวแทน
logoUri

string

ต้องระบุ URL ที่เปิดเผยต่อสาธารณะของโลโก้สำหรับเอเจนต์ สูงสุด 50 KB

แก้ไขไม่ได้หลังจากยืนยันตัวแทนแล้ว
heroUri

string

ต้องระบุ URL ที่ใช้ได้แบบสาธารณะของรูปภาพหลักสำหรับ Agent สูงสุด 200 KB

แก้ไขไม่ได้หลังจากยืนยันตัวแทนแล้ว
phoneNumbers[]

object (PhoneEntry)

ไม่บังคับ หมายเลขโทรศัพท์ที่เชื่อมโยงกับตัวแทน ต้องระบุหากไม่ได้ระบุอีเมลและเว็บไซต์
emails[]

object (EmailEntry)

ไม่บังคับ อีเมลที่เชื่อมโยงกับตัวแทน ต้องระบุหากไม่ได้ระบุหมายเลขโทรศัพท์และเว็บไซต์
websites[]

object (WebEntry)

ไม่บังคับ เว็บไซต์ที่เชื่อมโยงกับตัวแทน สูงสุด 3 รายการ ต้องระบุหากไม่ได้ระบุหมายเลขโทรศัพท์และอีเมล
privacy

object (WebEntry)

ต้องระบุ นโยบายความเป็นส่วนตัวที่เชื่อมโยงกับเอเจนต์
termsConditions

object (WebEntry)

ต้องระบุ ข้อกำหนดและเงื่อนไขที่เชื่อมโยงกับตัวแทน
color

string

ต้องระบุ สีธีมของเอเจนต์ที่ผู้ใช้มองเห็นในรูปแบบเลขฐานสิบหก เช่น #FF6347
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

ต้องระบุ การกำหนดค่าการเรียกเก็บเงินสำหรับตัวแทน
agentUseCase

enum (AgentUseCase)

ไม่บังคับ กรณีการใช้งานบ็อต
hostingRegion

enum (HostingRegion)

ต้องระบุ ภูมิภาคที่โฮสต์สำหรับ Agent
partner

object (PartnerEntry)

เอาต์พุตเท่านั้น พาร์ทเนอร์ที่เชื่อมโยงกับตัวแทน
launchDetails

map (key: string, value: object (RcsBusinessMessagingRegionLaunch))

เอาต์พุตเท่านั้น รายละเอียดการเปิดตัวสำหรับเอเจนต์ จะมีการป้อนข้อมูลสำหรับผู้ให้บริการเท่านั้น และจะป้อนเฉพาะรายละเอียดการเปิดตัวที่เกี่ยวข้องกับผู้ให้บริการที่โทรเท่านั้น
indiaPrincipalEntityId

string

ไม่บังคับ ตัวระบุเอนทิตีหลักของธุรกิจในอินเดีย (PE ID) ของธุรกิจที่เชื่อมโยงกับตัวแทน ต้องระบุหากวางแผนที่จะเปิดตัวเอเจนต์ในอินเดีย

PhoneEntry

หมายเลขโทรศัพท์ที่เชื่อมโยงกับตัวแทน

การแสดง JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
ช่อง
phoneNumber

object (Phone)

ต้องระบุ หมายเลขโทรศัพท์ใน 2 รูปแบบที่เป็นไปได้ ได้แก่ รูปแบบ E.164 แบบเต็ม (เช่น "+12223334444") หรือหมายเลขโทรศัพท์ในประเทศ/หมายเลขโทรฟรีที่ไม่ได้จัดรูปแบบโดยไม่มี "+" คำนำหน้า หรือรหัสประเทศ (เช่น "6502530000") หมายเหตุ: ไม่อนุญาตให้ใช้หมายเลขฉุกเฉิน
label

string

ต้องระบุ ป้ายกำกับสำหรับหมายเลขโทรศัพท์

EmailEntry

อีเมลที่เชื่อมโยงกับตัวแทน

การแสดง JSON 
{
  "address": string,
  "label": string
}
ช่อง
address

string

ต้องระบุ ที่อยู่อีเมล
label

string

ต้องระบุ ป้ายกำกับสำหรับอีเมล

WebEntry

แหล่งข้อมูลบนเว็บที่เชื่อมโยงกับตัวแทน

การแสดง JSON 
{
  "uri": string,
  "label": string
}
ช่อง
uri

string

ต้องระบุ URI ที่เข้าถึงได้แบบสาธารณะซึ่งเชื่อมโยงกับตัวแทน ต้องใช้โปรโตคอล HTTP หรือ HTTPS
label

string

ต้องระบุสำหรับ websites ไม่บังคับสำหรับเนื้อหาในกรณีอื่น ป้ายกำกับสำหรับ URI

RcsBusinessMessagingAgentBillingConfig

การกำหนดค่าการเรียกเก็บเงินสำหรับตัวแทน

การแสดง JSON 
{
  "billingCategory": enum (BillingCategory)
}
ช่อง
billingCategory

enum (BillingCategory)

หมวดหมู่การเรียกเก็บเงินสำหรับตัวแทน

BillingCategory

หมวดหมู่การเรียกเก็บเงินที่รองรับ

Enum
BILLING_CATEGORY_UNSPECIFIED ไม่ได้ระบุหมวดหมู่
CONVERSATIONAL_LEGACY

หมวดหมู่เดิมเพื่อรองรับการกำหนดค่าการเรียกเก็บเงินของตัวแทนที่มีอยู่ โปรดใช้ CONVERSATIONAL แทน
CONVERSATIONAL ออกแบบมาสำหรับเซสชันที่ยาวขึ้นและซับซ้อนมากขึ้น ซึ่งผู้ใช้และแบรนด์จะแลกเปลี่ยนข้อความชุดหนึ่ง
SINGLE_MESSAGE

แทนที่ SMS ด้วยประสบการณ์การรับส่งข้อความที่สมบูรณ์ยิ่งขึ้น ไม่เรียกเก็บเงินเป็น CONVERSATIONAL
BASIC_MESSAGE

โมเดลการเรียกเก็บเงินคล้ายกับ SMS ไม่เรียกเก็บเงินเป็น CONVERSATIONAL
NON_CONVERSATIONAL แสดงหมวดหมู่การเรียกเก็บเงินที่ไม่ใช่การสนทนา ซึ่งแทนที่หมวดหมู่เดิมอย่าง SINGLE_MESSAGE และ BASIC_MESSAGE ซึ่งเหมาะสำหรับเอเจนต์ที่สื่อสารทางเดียว (A2P) เป็นหลัก

AgentUseCase

ประเภทกรณีการใช้งานของตัวแทนที่ใช้ในที่เก็บข้อมูล

Enum
AGENT_USE_CASE_UNSPECIFIED ไม่ได้ระบุกรณีการใช้งาน
TRANSACTIONAL เอเจนต์ที่ส่งเฉพาะข้อความที่จำเป็นและเร่งด่วน
PROMOTIONAL ตัวแทนที่ส่งข้อความด้านการขาย การตลาด และโปรโมชัน ประเภทเริ่มต้น
OTP ตัวแทนที่ส่งรหัสผ่านแบบใช้ครั้งเดียวเท่านั้น
MULTI_USE เอเจนต์ที่มีกรณีการใช้งานหลายอย่าง ซึ่งรวมถึงเอเจนต์ที่เปิดตัวกรณีการใช้งานหนึ่งทันที ในขณะที่อีกกรณีหนึ่งวางแผนที่จะเปิดตัวในอนาคต ดูข้อมูลเพิ่มเติมได้ในเอกสารประกอบการใช้งานหลายครั้ง

HostingRegion

เขตข้อมูลการโฮสต์ที่เป็นไปได้สำหรับตัวแทน ซึ่งใช้สำหรับการกำหนดเส้นทางข้อความ P2A ไปยังเซิร์ฟเวอร์ระดับภูมิภาคอย่างถูกต้อง

Enum
HOSTING_REGION_UNSPECIFIED ภูมิภาคที่โฮสต์ที่ไม่ได้ระบุ
NORTH_AMERICA อเมริกาเหนือ
EUROPE ยุโรป
ASIA_PACIFIC เอเชียแปซิฟิก

PartnerEntry

พาร์ทเนอร์ที่เชื่อมโยงกับตัวแทน

การแสดง JSON 
{
  "partnerId": string,
  "displayName": string,
  "company": string
}
ช่อง
partnerId

string

เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ำกันสำหรับพาร์ทเนอร์
displayName

string

เอาต์พุตเท่านั้น ชื่อที่จะแสดงต่อธุรกิจเพื่อเชื่อมโยงพาร์ทเนอร์กับผลิตภัณฑ์ ควรไม่ซ้ำกันในหมู่พาร์ทเนอร์
company

string

เอาต์พุตเท่านั้น ชื่อสาธารณะของบริษัทสำหรับพาร์ทเนอร์ที่ระบุ

RcsBusinessMessagingRegionLaunch

รายละเอียดเกี่ยวกับการเปิดตัวเอเจนต์ธุรกิจ RCS for Business สำหรับแต่ละภูมิภาค

การแสดง JSON 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string,
  "isHidden": boolean
}
ช่อง
launchState

enum (LaunchState)

สถานะการเปิดตัวสำหรับภูมิภาค
comment

string

ความคิดเห็นจากผู้ให้บริการ
updateTime

string (Timestamp format)

เวลาที่อัปเดตล่าสุด

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
isHidden

boolean

ไม่บังคับ ระบุว่าจะทำเครื่องหมายเอเจนต์เป็นซ่อนสำหรับผู้ให้บริการหรือไม่ ซึ่งจะส่งผลต่อระดับการมองเห็นของมุมมองคอนโซลและ API

LaunchState

สถานะการเปิดตัวของเอนทิตี ดูข้อมูลเกี่ยวกับการเปลี่ยนสถานะการเปิดตัวที่อนุญาตสำหรับทั้งผู้ให้บริการและพาร์ทเนอร์ได้ที่รับเหตุการณ์

Enum
LAUNCH_STATE_UNSPECIFIED สถานะที่ไม่ได้ระบุ
LAUNCH_STATE_UNLAUNCHED เอนทิตียังไม่ได้เปิดตัว
LAUNCH_STATE_PENDING การเปิดตัวอยู่ระหว่างการตรวจสอบ
LAUNCH_STATE_LAUNCHED เปิดตัวแล้ว
LAUNCH_STATE_REJECTED การเปิดตัวถูกปฏิเสธ
LAUNCH_STATE_SUSPENDED การเปิดตัวถูกระงับ
LAUNCH_STATE_PENDING_UNLAUNCH

เลิกใช้งานแล้ว: สถานะนี้ไม่ได้ใช้แล้ว

การยกเลิกการเปิดใช้กำลังอยู่ระหว่างตรวจสอบ
LAUNCH_STATE_INVALID_IN_GMB

เลิกใช้งานแล้ว: สถานะนี้ไม่ได้ใช้แล้ว

การเปิดตัวไม่ถูกต้องเนื่องจากข้อมูล Google My Business ที่เชื่อมโยงไม่รองรับการรับส่งข้อความ การยืนยันอีกครั้งใน Google My Business จะเปิดตัวที่นี่อีกครั้งโดยอัตโนมัติ ใช้ได้กับสถานที่เท่านั้น

เมธอด

create

 สร้างตัวแทนใหม่เพื่อเป็นตัวแทนของแบรนด์

delete
(deprecated)

 เลิกใช้งานแล้ว: การลบ Agent ถูกเลิกใช้งานแล้ว

get

 ดูข้อมูลเกี่ยวกับตัวแทน

getLaunch

 รับข้อมูลการเปิดตัวของเอเจนต์

getVerification

 รับข้อมูลการยืนยันสำหรับตัวแทน

list

 แสดงรายการตัวแทนทั้งหมดที่เชื่อมโยงกับแบรนด์

patch

 อัปเดตข้อมูลเกี่ยวกับตัวแทน

requestLaunch

 เริ่มกระบวนการเปิดตัวเอเจนต์

requestVerification

 ส่งข้อมูลการยืนยันธุรกิจสำหรับตัวแทน

updateLaunch

 อัปเดตข้อมูลการเปิดตัวของเอเจนต์

updateVerification

 อัปเดตสถานะการยืนยันสำหรับตัวแทน