Phone
מספרים עסקיים שמצלצלים אצל הצוות, עם העברה, ניתוב והקלטה.
ל-Phone יש חמישים שיטות ציבוריות, ודף Phone של הדשבורד בנוי עליהן. ארבעים וארבע פועלות עבור החשבון שמפתח ה-API שלכם שייך לו. שש מיועדות למפעילים של Xuda עצמה ודורשות מפתח אדמין: הבדיקה של רשומות הציות של מדינה וההתחשבנות על שימוש והרשמות, וגם adopt_voice_number, ששייכת לפרופיל מספר ש-Xuda כבר מחזיקה בלי רכישה.
שולחים בקשה לשיטה עם המפתח שלכם:
שכירת מספר
זה מה ששכירת מספר עושה, באותו סדר.
רואים איפה אפשר לשכור מספרים
get_voice_country_catalog מפרטת את המדינות וסוגי המספרים הפתוחים. get_voice_compliance_status עבור country אומרת מה המדינה הזו עוד צריכה מכם לפני ששוכרים מספר: המדיניות שלה, הזהות שמאחורי המספר, ובמדינה מוסדרת, ההרשמה אצל ספק הטלפון.
עוברים את הבדיקות של המדינה
accept_voice_terms רושמת את המדיניות, עם כל מזהה שהמדינה מפרטת ועם ה-policy_version המדויק. get_voice_identity_requirements מחזירה את השדות שהמדינה מבקשת, update_profile_business_identity שומרת אותם ו-submit_voice_compliance שולחת אותם לבדיקה. במדינה מוסדרת, upload_voice_compliance_document שולחת כל מסמך שהספק מבקש ו-submit_voice_bundle שולחת את ההרשמה.
מחפשים ומקבלים הצעת מחיר
search_voice_numbers מחפשת מספרים חופשיים לפי country ו-type (local, mobile, tollFree או national), ומצמצמת לפי area_code, תבנית contains או capabilities נדרשות. get_voice_number_rates מראה מה המספר יכול לעשות ומה עולה השימוש בו. quote_voice_number מתמחרת מועמד אחד ומחזיקה את המחיר הזה לזמן קצר, כך שהוא לא יכול לזוז תחת רכישה שמתבצעת.
רוכשים
purchase_voice_number פודה את הצעת המחיר (quote_id ואותו phone_number) וגובה את דמי השכירות החוזרים. מעבירים payment_method_id כדי לבחור את הכרטיס שמשלם.
משחררים
release_voice_number מחזירה מספר. הוא מפסיק לצלצל מיד וההתחדשות החודשית שלו מבוטלת.
הודעות טקסט נבחרות כשמספר נשכר: רק מספר שיכול לשלוח הודעות יכול לשלוח או לקבל אותן, ואי אפשר להוסיף זאת אחר כך.
קובעים איך קו עונה
list_voice_numbers מפרטת את המספרים שלכם עם הפרופיל שכל אחד מחובר אליו. עם shared_only: true היא מפרטת במקום זה את הקווים שאנשים אחרים שיתפו איתכם ואישרתם, כל אחד עם shared_from; הם אף פעם לא נספרים מול התוכנית שלכם. attach_voice_number נותנת מספר לפרופיל (מספר אחד לפרופיל, ולפרופיל הראשי אסור שיהיה אחד) ו-detach_voice_number מסירה אותו בלי לשחרר אותו.
get_voice_number_setup קוראת בקריאה אחת את כל מה שקובע איך מספר אחד עונה: הפרופיל, מה התוכנית שלכם מאפשרת, והכללים עם רשימות האפשרויות שמאחוריהם. update_voice_number_setup שומרת אותה. כל קטע נוגעים בו רק כששולחים אותו, כך ששמירה של אחד אף פעם לא מאפסת אחר. ההגדרה נושאת גם auto_answer, העוזר הציבורי שעונה לקו ומתי (always, when_no_answer, when_closed, schedule), שנשמר בשליחת מה שמשתנה בלבד; בחירה שאינה אחד מהעוזרים הציבוריים החיים שלכם נדחית עם assistant_not_public. ה-ring.contacts וה-ring.groups של הכללים הם אנשי קשר וקבוצות אנשי קשר של סביבת העבודה של הקו עצמו שהוא מצלצל אליהם גם (אחד שנעלם נדחה עם voice_answerer_not_found), ו-shared_with מפרט את האנשים שהקו משותף איתם, ממתינים או מאושרים. get_profile_answering_rules ו-update_profile_answering_rules קוראות ושומרות את הכללים בלבד: שעות עבודה, זמן הצלצול, מי מקבל צלצול, העברה לנייד, תא קולי והקלטה.
הגדרה שהתוכנית שלכם לא כוללת נדחית עם voice_plan_upgrade_required, אף פעם לא נזרקת בשקט. הורדה בתוכנית נכנסת לתוקף בשיחה הבאה ממש, ומה ששמרתם נשאר במקומו כך ששדרוג מחזיר אותו.
list_voice_profile_members, share_voice_profile ו-revoke_voice_profile_member קובעות מי נמצא בפרופיל, ולכן למי קו יכול לצלצל ולמי אפשר להעביר שיחה. קו עצמו משותף דרך שיתופי הצוות (create_share עם סוג השיתוף voice_number); שיתוף שאושר מצלצל גם לאותו אדם. get_voice_browser_token עם answering: true נותנת לדפדפן טוקן אחד לכל קו של מישהו אחר שמצלצל לחשבון הזה, כך שהוא מצלצל גם שם; הם רק עונים.
שיחות
list_voice_callsקוראת את היסטוריית השיחות, של החשבון, של פרופיל או של מספר אחד.get_voice_call_transcriptקוראת את הטקסט של שיחה אחת, כשיש.get_voice_browser_tokenו-create_voice_call_intentנותנות לטלפון תוכנה בדפדפן לבצע שיחה: הכוונה מאשרת שיחה יוצאת אחת ממספר שיש לכם אל מספרto. אפליקציית Xuda ל-iPhone מבקשת את הטוקנים שלה עםpush_env(sandboxאוproduction): כל טוקן נושא אז את אישורי ה-push של Twilio מחשבון ה-Twilio שלו, כך ששיחה מצלצלת בטלפון גם כשהאפליקציה סגורה, והתשובה אומרתpush: true.list_voice_transfer_targetsו-transfer_voice_callמעבירות שיחה חיה לאדם אחר בפרופיל, ו-takeover_voice_callמעבירה שיחה מפקידת הקבלה של ה-AI אל הדפדפן שלכם.send_voice_announcementמבצעת שיחה מאחד המספרים שלכם ומקריאה הודעה שהוקלדה למי שעונה.
הודעות טקסט
list_voice_message_threads מפרטת שיחות עם ההודעה האחרונה, מספר ההודעות שלא נקראו והאם איש הקשר ביטל הסכמה. list_voice_messages קוראת שיחה אחת. send_voice_message שולחת הודעה אחת ממספר שיכול לשלוח; נותנים לה idempotency_key וניסיון חוזר מחויב פעם אחת. איש קשר ששלח STOP נדחה עד שהוא שולח START. mark_voice_message_thread_read מנקה את מספר ההודעות שלא נקראו בשיחה.
תוכנית, שימוש והשירות
get_voice_plans קוראת את סולם התוכניות ואת התוכנית שאתם בה. set_voice_plan מפעילה אותה, משדרגת או מורידה, עם tier או עם מזהה התוכנית (profile_phone_phone); היא דורשת חשבון Xuda בתשלום. get_voice_usage קוראת את השיחות וההודעות של החודש, עם תקרת ההוצאה שנותרה. get_voice_service_status ו-activate_voice_service קוראות ומכינות את שירות הטלפון של החשבון.