HTTPS API v2 / Support blacklist

The system allows remote letters, add and delete numbers from the blacklist.

Listing numbers from the blacklist

Calling address

 

For using the remote operating list the numbers on the black list, call the specified URL using the POST method.

blacklist/index

Available parameters

Parameter Type An example value or format Description
username String Login Username to the account
password String Password Password to the account
phone String eg. +48500600700

Optional, allowing to narrow the search area to a specific number.

The parameters in bold are obligatory. Others are optional.

Return response

{
   "items":[{
      "phone":"+48500600702",
      "added":"2014-10-22 12:25:10"
   },
   {
      "phone":"+48500600701",
      "added":"2014-10-22 15:52:03"
   }]
}

Adding a number to the black list

Calling address

 

For using the remote operating add a number to the black list, call the specified URL using the POST method.

blacklist/add

Available parameters

Parameter Type Przykładowa wartość lub format Description
username String Login Username to the account
password String Password Password to the account
phone String eg. +48500600700 The number to be credited to a blacklist, preferably with international prefix preceded by "+" sign.

The parameters in bold are obligatory. Others are optional.

Return response

{
   "success":true,
   "id":12354
}

Deleting a number from the black list

Calling address

 

For using the remote operation to remove a number from the black list, call the specified URL using the POST method.

blacklist/delete

Available parameters

Parameter Type An example value or format Description
username String Login Username to the account
password String Password Password to the account
phone String eg. +48500600700

The number to be credited to a blacklist, preferably with international prefix preceded by "+" sign.

The parameters in bold are obligatory. Others are optional.

Return response

{
   "success":true
}

Checking if the number is on the black list

Calling address

 

For using the remote operating to check whether there is a number on the black list, call the specified URL using the POST method.

blacklist/check

Available parameters

Parameter Type An example value or format Description
username String Login Username to the account
password String Password Password to the account
phone String eg. +48500600700

The number to see the best of the international prefix preceded by "+" sign.

The parameters in bold are obligatory. Others are optional.

Return response

{
   "exists":true
}