הסבר כללי
מטרת השירות
השירות Blacklist API של חברת Voicenter יאפשר לחסום לנהל חסימה של יעדים לחיוג על ידי הנציגים שלכם, תוכלו להגדיר בעזרת מערכת המידע שלכם שלא יהיה ניתן לחייג למספרי טלפון מסוימים.
בנוסף, תוכלו להסיר גם מספרי טלפון על מנת לאפשר חיוג אליהם על ידי הנציגים שלכם והכל נעשה בעזרת בקשת Web פשוטה.
AddBlackList
URI
1
https://api.voicenter.com/Blacklist/AddBlackList
פורמט בקשה
1. POST-JSON
2. GET
פורמט תשובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור | סוג | הערות |
| "Code" | "קוד ייחודי לחשבונכם, ניתן לפנות למחלקת התפעול לקבל את הקוד." | "מחרוזת" | "חובה" |
| "Phones" | "מערך של JSON, אשר יכיל את מספרי הטלפון אשר ברצונכם להוסיף לשירות ה Blacklist על מנת למנוע אליהם חיוג." | "מערך" | "חובה" |
| "Phone" | "מספר טלפון לחסימה לחיוג, נמצא בתוך המערך תחת Phones" | "מחרוזת" | "חובה" |
| "Name" | "שם של היעד שנחסם לחיוג. נתמך רק בבקשות בפורמט POST-JSON" | "מחרוזת" | "רשות" |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/Blacklist/AddBlackList?code=xxxxxxxxxxxxxxxxxxxx&phones=0501234567&phones=031234567
בקשה לדוגמא בפורמט POST-JSON
{
"Code": "XXXXXXXXXXXXXXXXXXXX",
"Phones": [
{
"Phone": "0501234567",
"Name": "John doe"
},
{
"Phone": "031234567",
"Name": "Walter Melon"
}
]
}
פרמטרים בתשובה
| שם שדה | תיאור | סוג |
| "ErrorCode" | "מציין סטטוס כללי לבקשה שלכם: סטטוס \"0\" - אין שגיאה. סטטוס \"1\" - הפרמטר קוד אינו תקין או הפורמט של הבקשה אינו תקין. סטטוס \"2\" - השדה Phone חסר או מכיל מידע לא תקין." | "מספר שלם." |
| "ErrorMessage" | "תיאור מילולי כללי של התגובה: תיאור \"OK\" - אין שגיאות והכל תקין. תיאור \"Authorization failed\" - ערך הקוד או פורמט הבקשה אינו תקין. תיאור \"The Phone field is missing or invalid\" - השדה \"Phones\" חסר." | "מחרוזת" |
| "Phones" | "מערך של JSON, עבור כל מספר טלפון שהתווסף ל Blacklist API יתקבל חיווי האם המספר נוסף בהצלחה." | "מערך" |
| "ErrorCode" | "סטטוס בתשובה של Blacklist API עבור כל מספר טלפון שהתווסף לשירות: סטטוס \"0\" - אין שגיאות. סטטוס \"1\" - מספרי הטלפון שנרשמו בבקשה אינם בפורמט תקין. מספרי טלפון יש לרשום בפורמט E.164 בבקשה שלכם. סטטוס \"2\" - הייתה שגיאה פנימית בעת ניסיון להוסיף את מספר הטלפון, נא צרו קשר עם מחלקת התמיכה." | "מספר שלם" |
| "ErrorMessage" | "תיאור בתשובה של Blacklist API עבור כל מספר טלפון שהתווסף לשירות: תיאור \"OK\" - אין שגיאות. תיאור \"Please make sure the phone destination is in a valid format\" - מספרי הטלפון שנרשמו בבקשה אינם בפורמט תקין של E.164, יש לרשום את מספרי הטלפון בפורמט זה. תיאור \"Internal Error\" - הייתה שגיאה פנימית בעת ניסיון להוסיף את מספר הטלפון, נא צרו קשר עם מחלקת התמיכה." | "מחרוזת" |
תשובה לדוגמא של השירות
{
"ErrorCode": 0,
"ErrorMessage": "OK",
"Phones": [
{
"ErrorCode": 0,
"ErrorMessage": "OK",
"Phone": "972501234567"
},
{
"ErrorCode": 0,
"ErrorMessage": "OK",
"Phone": "97231234567"
}
]
}
RemoveBulkFromBlacklist
URI
1
https://api.voicenter.com/Blacklist/RemoveBulkFromBlacklist
פורמט בקשה
1. POST-JSON
2. GET
פורמט תשובה
1. POST-JSON
פרמטרים בבקשה
| שם שדה | תיאור | סוג | הערות |
| "Code" | "מזהה ייחודי לחשבונכם, ניתן לקבל ממחלקת התפעול." | "מחרוזת" | "חובה" |
| "Phones" | "מערך של JSON אשר מציין את מספרי הטלפון שיש להסיר משירות Blacklist API" | "מערך" | "חובה" |
| "Phone" | "מספרי הטלפון אשר יוסרו משירות Blacklist." | "מחרוזת" | "חובה" |
בקשה לדוגמא בפורמט GET
1
https://api.voicenter.com/Blacklist/RemoveBulkFromBlacklist?code=xxxxxxxxxxxxxxxxxxxx&phones=0501234567&phones=031234567
בקשה לדוגמא בפורמט POST-JSON
{
"Code": "XXXXXXXXXXXXXXXXXXXX",
"Phones": [
{
"Phone": "0501234567"
},
{
"Phone": "031234567"
}
]
}
פרמטרים בתשובה
| שם שדה | תיאור | סוג |
| "ErrorCode" | "מציין סטטוס כללי לבקשה שלכם: סטטוס \"0\" - אין שגיאה. סטטוס \"1\" - הפרמטר קוד אינו תקין או הפורמט של הבקשה אינו תקין. סטטוס \"2\" - השדה Phone חסר או מכיל מידע לא תקין." | "מספר שלם" |
| "ErrorMessage" | "תיאור מילולי כללי של התגובה: תיאור \"OK\" - אין שגיאות והכל תקין. תיאור \"Authorization failed\" - ערך הקוד או פורמט הבקשה אינו תקין. תיאור \"The Phone field is missing or invalid\" - השדה \"Phones\" חסר." | "מחרוזת" |
| "Phones" | "מערך של JSON, עבור כל מספר טלפון שהתווסף ל Blacklist API יתקבל חיווי האם המספר הוסר מהרשימה בהצלחה." | "מערך" |
| "ErrorCode" | "סטטוס בתשובה של Blacklist API עבור כל מספר טלפון שהתווסף לשירות: סטטוס \"0\" - אין שגיאות. סטטוס \"1\" - מספרי הטלפון שנרשמו בבקשה אינם בפורמט תקין. מספרי טלפון יש לרשום בפורמט E.164 בבקשה שלכם. סטטוס \"2\" - הייתה שגיאה פנימית בעת ניסיון להוסיף את מספר הטלפון, נא צרו קשר עם מחלקת התמיכה." | "מספר שלם" |
| "ErrorMessage" | "תיאור בתשובה של Blacklist API עבור כל מספר טלפון שהוסר מהשירות: תיאור \"OK\" - אין שגיאות. תיאור \"Please make sure the phone destination is in a valid format\" - מספרי הטלפון שנרשמו בבקשה אינם בפורמט תקין של E.164, יש לרשום את מספרי הטלפון בפורמט זה. תיאור \"Internal Error\" - הייתה שגיאה פנימית בעת ניסיון להסיר את מספר הטלפון, נא צרו קשר עם מחלקת התמיכה של חברת Voicenter." | "מחרוזת" |
