Skip to content

Latest commit

 

History

History
321 lines (222 loc) · 9.65 KB

BlacklistApi.md

File metadata and controls

321 lines (222 loc) · 9.65 KB
Raw

messente_api.BlacklistApi

All URIs are relative to https://api.messente.com/v1

Method HTTP request Description
add_to_blacklist POST /phonebook/blacklist Adds a phone number to the blacklist
delete_from_blacklist DELETE /phonebook/blacklist/{phone} Deletes a phone number from the blacklist
fetch_blacklist GET /phonebook/blacklist Returns all blacklisted phone numbers
is_blacklisted GET /phonebook/blacklist/{phone} Checks if a phone number is blacklisted

add_to_blacklist

add_to_blacklist(number_to_blacklist)

Adds a phone number to the blacklist

Example

  • Basic Authentication (basicAuth):
import messente_api
from messente_api.models.number_to_blacklist import NumberToBlacklist
from messente_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.messente.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = messente_api.Configuration(
    host = "https://api.messente.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = messente_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with messente_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = messente_api.BlacklistApi(api_client)
    number_to_blacklist = {"phoneNumber":"+37251000000"} # NumberToBlacklist | Phone number to be blacklisted

    try:
        # Adds a phone number to the blacklist
        api_instance.add_to_blacklist(number_to_blacklist)
    except Exception as e:
        print("Exception when calling BlacklistApi->add_to_blacklist: %s\n" % e)

Parameters

Name Type Description Notes
number_to_blacklist NumberToBlacklist Phone number to be blacklisted

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Phone number added to the blacklist -
400 Invalid phone number provided -
401 Unauthorized -
409 Phone number already blacklisted -
0 General error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_from_blacklist

delete_from_blacklist(phone)

Deletes a phone number from the blacklist

Example

  • Basic Authentication (basicAuth):
import messente_api
from messente_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.messente.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = messente_api.Configuration(
    host = "https://api.messente.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = messente_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with messente_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = messente_api.BlacklistApi(api_client)
    phone = '+37251000000' # str | A phone number

    try:
        # Deletes a phone number from the blacklist
        api_instance.delete_from_blacklist(phone)
    except Exception as e:
        print("Exception when calling BlacklistApi->delete_from_blacklist: %s\n" % e)

Parameters

Name Type Description Notes
phone str A phone number

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Phone number deleted from the blacklist -
400 Invalid phone number provided -
401 Unauthorized -
404 Phone number is not in the blacklist -
0 General error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_blacklist

FetchBlacklistSuccess fetch_blacklist()

Returns all blacklisted phone numbers

Example

  • Basic Authentication (basicAuth):
import messente_api
from messente_api.models.fetch_blacklist_success import FetchBlacklistSuccess
from messente_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.messente.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = messente_api.Configuration(
    host = "https://api.messente.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = messente_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with messente_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = messente_api.BlacklistApi(api_client)

    try:
        # Returns all blacklisted phone numbers
        api_response = api_instance.fetch_blacklist()
        print("The response of BlacklistApi->fetch_blacklist:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BlacklistApi->fetch_blacklist: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

FetchBlacklistSuccess

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An object containing a list of blacklisted phone numbers -
401 Unauthorized -
0 General error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

is_blacklisted

is_blacklisted(phone)

Checks if a phone number is blacklisted

Example

  • Basic Authentication (basicAuth):
import messente_api
from messente_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.messente.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = messente_api.Configuration(
    host = "https://api.messente.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = messente_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with messente_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = messente_api.BlacklistApi(api_client)
    phone = '+37251000000' # str | A phone number

    try:
        # Checks if a phone number is blacklisted
        api_instance.is_blacklisted(phone)
    except Exception as e:
        print("Exception when calling BlacklistApi->is_blacklisted: %s\n" % e)

Parameters

Name Type Description Notes
phone str A phone number

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Phone number is in the blacklist -
400 Invalid phone number provided -
401 Unauthorized -
404 Phone number is not in the blacklist -

[Back to top] [Back to API list] [Back to Model list] [Back to README]