Method: phones.agentMessages.delete

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

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

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

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת 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

חובה. המזהה הייחודי של הנציג.

גוף הבקשה

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

גוף התגובה

אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.