Blacklist API

בעזרת הAPI של Blacklist תהיה לכם אפשרות לבצע פעולות של חסימת חיוג אל יעדים מסוימים בתוך מערכת המידע.
לחילופין תוכלו להסיר חסימה ולחייג שוב ליעד לבחירתכם.
חסימת/התרת יעדים

הסבר כללי

מטרת השירות

השירות 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.		מחרוזת