Method: phones.agentMessages.delete

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

אם פלטפורמת RCS לעסקים מבטלת בהצלחה את ההודעה, ההודעה נמחקת מתור ההודעות של המשתמש והיא אף פעם לא נמסרת (200 OK).

תגובה מסוג 404 Not Found (לא נמצא) מציינת שניסיון הביטול נכשל כי ההודעה נמסרה.

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

בקשת HTTP

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

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

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

פרמטרים
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.