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, הסוכן מועבר לארכיון ולא נכלל בתוצאות הרשימה כברירת מחדל.

שדה איחוד detail_info. הכרטיסייה מכילה את השדות הנדרשים למוצר הספציפי.

חובה. הערך detail_info יכול להיות רק אחד מהבאים:
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

מידע מפורט על נציגים ב-RCS for Business.

RcsBusinessMessagingAgent

מידע על נציג שקשור ספציפית ל-RCS for Business. כשיוצרים נציג, מומלץ לספק לפחות דרך אחת ליצירת קשר (טלפון, אימייל או אתר) עם תווית מתאימה. כדי להפעיל את הנציג, צריך לציין לפחות דרך אחת ליצירת קשר (טלפון, אימייל או אתר) עם תווית מתאימה.

ייצוג ב-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 שגלויה לכולם של הלוגו של הסוכן. עד 50KB.

אי אפשר לשנות את ההגדרה הזו אחרי אימות הנציג.
heroUri

string

חובה. כתובת URL שזמינה לציבור של התמונה הראשית של הסוכן. עד 200KB.

אי אפשר לשנות את ההגדרה הזו אחרי אימות הנציג.
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)

חובה. אזור האירוח של הנציג.
partner

object (PartnerEntry)

פלט בלבד. השותף שמשויך לסוכן.
launchDetails

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

פלט בלבד. פרטי ההפעלה של הנציג. השדה הזה מאוכלס רק עבור ספקי סלולר, ורק עם פרטי ההשקה שקשורים לספק שמבצע את השיחה.
indiaPrincipalEntityId

string

אופציונלי. מזהה ישות עסקית ראשית (PE ID) של העסק בהודו שמשויך לסוכן. נדרש אם מתכננים להשיק את הסוכן בהודו.

PhoneEntry

מספר טלפון שמשויך לנציג.

ייצוג ב-JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
שדות
phoneNumber

object (Phone)

חובה. מספר טלפון באחד משני פורמטים אפשריים: או בפורמט 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 בחוויית התכתבות עשירה יותר. לעולם לא יחויב כשיחה.
BASIC_MESSAGE

מודל החיוב דומה לחיוב על הודעות SMS. לעולם לא יחויב כשיחה.
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 לעסק שלי'. האימות מחדש ב-'Google לעסק שלי' יפעיל מחדש את התכונה באופן אוטומטי. המאפיין הזה רלוונטי רק למיקומים.

Methods

create

 יוצר סוכן חדש שמייצג מותג.

delete
(deprecated)

 הוצא משימוש: מחיקת סוכנים הוצאה משימוש.

get

 קבלת מידע על נציג.

getLaunch

 קבלת פרטי ההפעלה של נציג.

getVerification

 קבלת פרטי האימות של נציג.

list

 רשימה של כל הסוכנים שמשויכים למותג.

patch

 עדכון המידע על נציג.

requestLaunch

 מתחילים את תהליך ההשקה של סוכן.

requestVerification

 שליחת פרטים לאימות העסק של נציג.

updateLaunch

 עדכון פרטי ההפעלה של נציג.

updateVerification

 עדכון של סטטוס האימות של נציג.