clicksend_client.EmailToSmsApi

All URIs are relative to https://rest.clicksend.com/v3

Method	HTTP request	Description
sms_email_sms_get	GET /sms/email-sms	Get list of email to sms allowed addresses
sms_email_sms_post	POST /sms/email-sms	Create email to sms allowed address
sms_email_sms_stripped_string_delete	DELETE /sms/email-sms-stripped-strings/{rule_id}	Delete email to sms stripped string rule
sms_email_sms_stripped_string_get	GET /sms/email-sms-stripped-strings/{rule_id}	Get email to sms stripped string rule
sms_email_sms_stripped_string_post	POST /sms/email-sms-stripped-strings	Create email to sms stripped string rule
sms_email_sms_stripped_string_put	PUT /sms/email-sms-stripped-strings/{rule_id}	Update email to sms stripped string rule
sms_email_sms_stripped_strings_get	GET /sms/email-sms-stripped-strings	Get list of email to sms stripped string rules

sms_email_sms_get

str sms_email_sms_get(page=page, limit=limit)

Get list of email to sms allowed addresses

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailToSmsApi(clicksend_client.ApiClient(configuration))
page = 1 # int | Page number (optional) (default to 1)
limit = 10 # int | Number of records per page (optional) (default to 10)

try:
    # Get list of email to sms allowed addresses
    api_response = api_instance.sms_email_sms_get(page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailToSmsApi->sms_email_sms_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page number	[optional] [default to 1]
limit	int	Number of records per page	[optional] [default to 10]

Return type

str

Authorization

BasicAuth

HTTP request headers

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

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

sms_email_sms_post

str sms_email_sms_post(email_sms_address)

Create email to sms allowed address

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailToSmsApi(clicksend_client.ApiClient(configuration))
email_sms_address = clicksend_client.EmailSMSAddress() # EmailSMSAddress | EmailSMSAddress model

try:
    # Create email to sms allowed address
    api_response = api_instance.sms_email_sms_post(email_sms_address)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailToSmsApi->sms_email_sms_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_sms_address	EmailSMSAddress	EmailSMSAddress model

Return type

str

Authorization

BasicAuth

HTTP request headers

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

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

sms_email_sms_stripped_string_delete

str sms_email_sms_stripped_string_delete(rule_id)

Delete email to sms stripped string rule

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailToSmsApi(clicksend_client.ApiClient(configuration))
rule_id = 56 # int | Your rule id

try:
    # Delete email to sms stripped string rule
    api_response = api_instance.sms_email_sms_stripped_string_delete(rule_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailToSmsApi->sms_email_sms_stripped_string_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
rule_id	int	Your rule id

Return type

str

Authorization

BasicAuth

HTTP request headers

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

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

sms_email_sms_stripped_string_get

str sms_email_sms_stripped_string_get(rule_id)

Get email to sms stripped string rule

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailToSmsApi(clicksend_client.ApiClient(configuration))
rule_id = 56 # int | Your rule id

try:
    # Get email to sms stripped string rule
    api_response = api_instance.sms_email_sms_stripped_string_get(rule_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailToSmsApi->sms_email_sms_stripped_string_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
rule_id	int	Your rule id

Return type

str

Authorization

BasicAuth

HTTP request headers

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

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

sms_email_sms_stripped_string_post

str sms_email_sms_stripped_string_post(stripped_string)

Create email to sms stripped string rule

Create email to sms stripped string rules

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailToSmsApi(clicksend_client.ApiClient(configuration))
stripped_string = clicksend_client.StrippedString() # StrippedString | StrippedString model

try:
    # Create email to sms stripped string rule
    api_response = api_instance.sms_email_sms_stripped_string_post(stripped_string)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailToSmsApi->sms_email_sms_stripped_string_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
stripped_string	StrippedString	StrippedString model

Return type

str

Authorization

BasicAuth

HTTP request headers

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

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

sms_email_sms_stripped_string_put

str sms_email_sms_stripped_string_put(stripped_string, rule_id)

Update email to sms stripped string rule

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailToSmsApi(clicksend_client.ApiClient(configuration))
stripped_string = clicksend_client.StrippedString() # StrippedString | StrippedString model
rule_id = 56 # int | Your rule id

try:
    # Update email to sms stripped string rule
    api_response = api_instance.sms_email_sms_stripped_string_put(stripped_string, rule_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailToSmsApi->sms_email_sms_stripped_string_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
stripped_string	StrippedString	StrippedString model
rule_id	int	Your rule id

Return type

str

Authorization

BasicAuth

HTTP request headers

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

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

sms_email_sms_stripped_strings_get

str sms_email_sms_stripped_strings_get(page=page, limit=limit)

Get list of email to sms stripped string rules

Example

from __future__ import print_function
import time
import clicksend_client
from clicksend_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: BasicAuth
configuration = clicksend_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = clicksend_client.EmailToSmsApi(clicksend_client.ApiClient(configuration))
page = 1 # int | Page number (optional) (default to 1)
limit = 10 # int | Number of records per page (optional) (default to 10)

try:
    # Get list of email to sms stripped string rules
    api_response = api_instance.sms_email_sms_stripped_strings_get(page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EmailToSmsApi->sms_email_sms_stripped_strings_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page number	[optional] [default to 1]
limit	int	Number of records per page	[optional] [default to 10]

Return type

str

Authorization

BasicAuth

HTTP request headers

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

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

FilesExpand file tree

EmailToSmsApi.md

Latest commit

History

EmailToSmsApi.md

File metadata and controls

clicksend_client.EmailToSmsApi

sms_email_sms_get

Example

Parameters

Return type

Authorization

HTTP request headers

sms_email_sms_post

Example

Parameters

Return type

Authorization

HTTP request headers

sms_email_sms_stripped_string_delete

Example

Parameters

Return type

Authorization

HTTP request headers

sms_email_sms_stripped_string_get

Example

Parameters

Return type

Authorization

HTTP request headers

sms_email_sms_stripped_string_post

Example

Parameters

Return type

Authorization

HTTP request headers

sms_email_sms_stripped_string_put

Example

Parameters

Return type

Authorization

HTTP request headers

sms_email_sms_stripped_strings_get

Example

Parameters

Return type

Authorization

HTTP request headers