AddBlackList
General Explanation
This method will allow you to easily add a destination (phonenumber) to you Voicenter organizational Blacklist.
URI
1
https://api.voicenter.com/Blacklist/AddBlackList
Acceptable Request Types
1. POST-JSON
2. GET
Possible Response Formats
1. POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| "Code" | "Personal identifier, provided by Voicenter." | "String" | "Mandatory" |
| "Phones" | "JSON array type. List of the requested destination to be added to the blacklist service." | "Array" | "Mandatory" |
| "Phone" | "The blocked destination phone number." | "String" | "Mandatory" |
| "Name" | "The name of the blocked call destination. Supported only in POST requests." | "String" | "Optional" |
Client Request Example (GET)
1
https://api.voicenter.com/Blacklist/AddBlackList?code=xxxxxxxxxxxxxxxxxxxx&phones=0501234567&phones=031234567
Client Request Example (POST - JSON)
{
"Code": "XXXXXXXXXXXXXXXXXXXX",
"Phones": [
{
"Phone": "0501234567",
"Name": "John doe"
},
{
"Phone": "031234567",
"Name": "Walter Melon"
}
]
}
Voicenter Response Parameters
| Field name | Description | Type |
| "ErrorCode" | "General response status: \"0\" – No errors. \"1\" – The Code value or format is invalid. \"2\" – The Phone field is missing or invalid." | "Integer" |
| "ErrorMessage" | "General response status description: \"OK\" – No errors. \"Authorization failed\" – The Code value or format is invalid. \"The Phone field is missing or invalid\" - The \"Phone\" field is mandatory. " | "String" |
| "Phones" | "JSON array type. For each phone destination sent to the blacklist service, the corresponding result of the attempt to add it to the service is returned." | "Array" |
| "ErrorCode" | "General response status: \"0\" – No errors. \"1\" – The sent phone destination is not in a valid format. Please send phone destination in the international standard format – E.164. \"2\" – There was an internal error when trying to add the specific destination. Please contact Voicenter support team." | "Integer" |
| "ErrorMessage" | "Response status description to each sent destination in the request: \"OK\" – No errors. \"Please make sure the phone destination is in a valid format\" - The sent phone destination is not in a valid format. Please send phone destination in the international standard format – E.164. \"Internal Error\" – There was an internal error when trying to add the specific destination. Please contact Voicenter support team." | "String" |
Voicenter Response Example
{
"ErrorCode": 0,
"ErrorMessage": "OK",
"Phones": [
{
"ErrorCode": 0,
"ErrorMessage": "OK",
"Phone": "972501234567"
},
{
"ErrorCode": 0,
"ErrorMessage": "OK",
"Phone": "97231234567"
}
]
}
RemoveBulkFromBlacklist
General Explanation
A method for removing phone numbers from the organization blacklist service.
URI
https://api.voicenter.com/Blacklist/RemoveBulkFromBlacklist
Acceptable Request Types
1. POST-JSON
2. GET
Possible Response Formats
1. POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| "Code" | "Personal identifier, provided by Voicenter." | "String" | "Mandatory" |
| "Phones" | "JSON array type. List of the requested destination to be added to the blacklist service." | "Array" | "Mandatory" |
| "Phone" | "The blocked destination phone number." | "String" | "Mandatory" |
Client Request Example (GET)
1
https://api.voicenter.com/Blacklist/RemoveBulkFromBlacklist?code=xxxxxxxxxxxxxxxxxxxx&phones=0501234567&phones=031234567
Client Request Example (POST - JSON)
{
"Code": "XXXXXXXXXXXXXXXXXXXX",
"Phones": [
{
"Phone": "0501234567"
},
{
"Phone": "031234567"
}
]
}
Voicenter Response Parameters
| Field name | Description | Type |
| "ErrorCode" | "General response status: \"0\" – No errors. \"1\" – The Code value or format is invalid. \"2\" – The Phone field is missing or invalid." | "Integer" |
| "ErrorMessage" | "General response status description: \"OK\" – No errors. \"Authorization failed\" – The Code value or format is invalid. \"The Phone field is missing or invalid\" - The \"Phone\" field is mandatory. " | "String" |
| "Phones" | "JSON array type. For each phone destination sent to the blacklist service, the corresponding result of the attempt to add it to the service is returned." | "Array" |
| "ErrorCode" | "General response status: \"0\" – No errors. \"1\" – The sent phone destination is not in a valid format. Please send phone destination in the international standard format – E.164. \"2\" – There was an internal error when trying to add the specific destination. Please contact Voicenter support team." | "Integer" |
| "ErrorMessage" | "Response status description to each sent destination in the request: \"OK\" – No errors. \"Please make sure the phone destination is in a valid format\" - The sent phone destination is not in a valid format. Please send phone destination in the international standard format – E.164. \"Internal Error\" – There was an internal error when trying to add the specific destination. Please contact Voicenter support team." | "String" |
Voicenter Response Example
{
"ErrorCode": 0,
"ErrorMessage": "OK",
"Phones": [
{
"ErrorCode": 0,
"ErrorMessage": "OK",
"Phone": "972501234567"
},
{
"ErrorCode": 0,
"ErrorMessage": "OK",
"Phone": "97231234567"
}
]
}