Method: phones.agentMessages.delete

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

אם הפלטפורמה של RBM מבטלת הודעה בהצלחה, ההודעה נמחקת מתור ההודעות של המשתמש ולא נמסרת אף פעם.

השיטה הזו מחזירה באופן מיידי את הערך 200 OK, גם אם ההודעה בוטלה בהצלחה וגם אם לא.

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

בקשת HTTP

DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
name

string

"phones/{E.164}/agentMessages/{messageId}", כאשר {E.164} הוא מספר הטלפון של המשתמש בפורמט E.164 ו-{messageId} הוא המזהה שהוקצה על ידי הסוכן של ההודעה לנציג תמיכה שיש לבטל. לדוגמה, עם מספר הטלפון בארה"ב +1-222-333-4444 והודעת נציג תמיכה עם המזהה '12345xyz', נקודת הקצה שתתקבל תהיה https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz.

פרמטרים של שאילתה

פרמטרים
agentId

string

חובה. המזהה הייחודי של הסוכן.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה הוא אובייקט JSON ריק.

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

מידע נוסף זמין בOAuth 2.0 Overview.