Skip to content

StopListApi.md

Latest commit

 

History

History
354 lines (250 loc) · 13 KB

StopListApi.md

File metadata and controls

354 lines (250 loc) · 13 KB

bsg_api.StopListApi

All URIs are relative to https://one-api.bsg.world

Method HTTP request Description
stoplist_add POST /api/stoplist/attach Add contacts to stop list
stoplist_items GET /api/stoplist List the contacts of stop lists
stoplist_remove POST /api/stoplist/detach Remove contacts from stop list
stoplist_search GET /api/stoplist/search Search contacts in Stop lists

stoplist_add

StoplistAdd200Response stoplist_add(stoplist_add_request)

Add contacts to stop list

Performs adding one or more contacts to the stop list

Example

  • Bearer (JWT) Authentication (ExternalAuth):
import bsg_api
from bsg_api.models.stoplist_add200_response import StoplistAdd200Response
from bsg_api.models.stoplist_add_request import StoplistAddRequest
from bsg_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://one-api.bsg.world
# See configuration.py for a list of all supported configuration parameters.
configuration = bsg_api.Configuration(
    host = "https://one-api.bsg.world"
)

# 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 Bearer authorization (JWT): ExternalAuth
configuration = bsg_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with bsg_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bsg_api.StopListApi(api_client)
    stoplist_add_request = bsg_api.StoplistAddRequest() # StoplistAddRequest | 

    try:
        # Add contacts to stop list
        api_response = api_instance.stoplist_add(stoplist_add_request)
        print("The response of StopListApi->stoplist_add:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StopListApi->stoplist_add: %s\n" % e)

Parameters

Name Type Description Notes
stoplist_add_request StoplistAddRequest

Return type

StoplistAdd200Response

Authorization

ExternalAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful attached -
429 Too many requests -

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

stoplist_items

StoplistItems200Response stoplist_items(page_offset=page_offset, page_limit=page_limit, type=type)

List the contacts of stop lists

The method allows getting a list of contacts that were added to the SMS and/or Viber stop list

Example

  • Bearer (JWT) Authentication (ExternalAuth):
import bsg_api
from bsg_api.models.stoplist_items200_response import StoplistItems200Response
from bsg_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://one-api.bsg.world
# See configuration.py for a list of all supported configuration parameters.
configuration = bsg_api.Configuration(
    host = "https://one-api.bsg.world"
)

# 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 Bearer authorization (JWT): ExternalAuth
configuration = bsg_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with bsg_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bsg_api.StopListApi(api_client)
    page_offset = 0 # int |  (optional) (default to 0)
    page_limit = 20 # int | The number of items in the response (optional) (default to 20)
    type = 'type_example' # str | Specify the type of the stop list for which we need to return the contact list. If the stop list type is not specified, the method will return data for all the stop list types (optional)

    try:
        # List the contacts of stop lists
        api_response = api_instance.stoplist_items(page_offset=page_offset, page_limit=page_limit, type=type)
        print("The response of StopListApi->stoplist_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StopListApi->stoplist_items: %s\n" % e)

Parameters

Name Type Description Notes
page_offset int [optional] [default to 0]
page_limit int The number of items in the response [optional] [default to 20]
type str Specify the type of the stop list for which we need to return the contact list. If the stop list type is not specified, the method will return data for all the stop list types [optional]

Return type

StoplistItems200Response

Authorization

ExternalAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful operation -

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

stoplist_remove

object stoplist_remove(stoplist_remove_request)

Remove contacts from stop list

Performs the removal of one or more contacts from the stop list

Example

  • Bearer (JWT) Authentication (ExternalAuth):
import bsg_api
from bsg_api.models.stoplist_remove_request import StoplistRemoveRequest
from bsg_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://one-api.bsg.world
# See configuration.py for a list of all supported configuration parameters.
configuration = bsg_api.Configuration(
    host = "https://one-api.bsg.world"
)

# 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 Bearer authorization (JWT): ExternalAuth
configuration = bsg_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with bsg_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bsg_api.StopListApi(api_client)
    stoplist_remove_request = bsg_api.StoplistRemoveRequest() # StoplistRemoveRequest | 

    try:
        # Remove contacts from stop list
        api_response = api_instance.stoplist_remove(stoplist_remove_request)
        print("The response of StopListApi->stoplist_remove:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StopListApi->stoplist_remove: %s\n" % e)

Parameters

Name Type Description Notes
stoplist_remove_request StoplistRemoveRequest

Return type

object

Authorization

ExternalAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful detached -
429 Too many requests -

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

stoplist_search

StoplistSearch200Response stoplist_search(page_offset=page_offset, page_limit=page_limit, sort=sort, way=way, contact_group_id=contact_group_id, search_field=search_field, search_operator=search_operator, search_value=search_value, search_fields_0_field=search_fields_0_field, search_fields_0_operator=search_fields_0_operator, search_fields_0_value=search_fields_0_value)

Search contacts in Stop lists

Search contacts in stop lists by criteria

Example

  • Bearer (JWT) Authentication (ExternalAuth):
import bsg_api
from bsg_api.models.search_operator import SearchOperator
from bsg_api.models.sort_way import SortWay
from bsg_api.models.stoplist_search200_response import StoplistSearch200Response
from bsg_api.models.stoplist_search_field import StoplistSearchField
from bsg_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://one-api.bsg.world
# See configuration.py for a list of all supported configuration parameters.
configuration = bsg_api.Configuration(
    host = "https://one-api.bsg.world"
)

# 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 Bearer authorization (JWT): ExternalAuth
configuration = bsg_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with bsg_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bsg_api.StopListApi(api_client)
    page_offset = 0 # int |  (optional) (default to 0)
    page_limit = 50 # int | The number of items in the response (optional) (default to 50)
    sort = id # str | Sort by conditions: id, phone (optional) (default to id)
    way = asc # SortWay |  (optional) (default to asc)
    contact_group_id = 56 # int | Find only phone numbers in stop list that included into specified contact list (optional)
    search_field = bsg_api.StoplistSearchField() # StoplistSearchField |  (optional)
    search_operator = bsg_api.SearchOperator() # SearchOperator |  (optional)
    search_value = 'search_value_example' # str |  (optional)
    search_fields_0_field = bsg_api.StoplistSearchField() # StoplistSearchField |  (optional)
    search_fields_0_operator = bsg_api.SearchOperator() # SearchOperator |  (optional)
    search_fields_0_value = 'search_fields_0_value_example' # str |  (optional)

    try:
        # Search contacts in Stop lists
        api_response = api_instance.stoplist_search(page_offset=page_offset, page_limit=page_limit, sort=sort, way=way, contact_group_id=contact_group_id, search_field=search_field, search_operator=search_operator, search_value=search_value, search_fields_0_field=search_fields_0_field, search_fields_0_operator=search_fields_0_operator, search_fields_0_value=search_fields_0_value)
        print("The response of StopListApi->stoplist_search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StopListApi->stoplist_search: %s\n" % e)

Parameters

Name Type Description Notes
page_offset int [optional] [default to 0]
page_limit int The number of items in the response [optional] [default to 50]
sort str Sort by conditions: id, phone [optional] [default to id]
way SortWay [optional] [default to asc]
contact_group_id int Find only phone numbers in stop list that included into specified contact list [optional]
search_field StoplistSearchField [optional]
search_operator SearchOperator [optional]
search_value str [optional]
search_fields_0_field StoplistSearchField [optional]
search_fields_0_operator SearchOperator [optional]
search_fields_0_value str [optional]

Return type

StoplistSearch200Response

Authorization

ExternalAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful operation -

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