board-mate/api-customer/api-resources/sms-components/docs/SmsApi.md

board_mate.sms.SmsApi

All URIs are relative to https://boardmate_api

Method	HTTP request	Description
example	POST /sms/send	POST sms/send

example

str example(body)

POST sms/send

Example

import time
import os
import board_mate.sms
from board_mate.sms.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://boardmate_api
# See configuration.py for a list of all supported configuration parameters.
configuration = board_mate.sms.Configuration(
    host = "https://boardmate_api"
)


# Enter a context with an instance of the API client
with board_mate.sms.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = board_mate.sms.SmsApi(api_client)
    body = 'body_example' # str | 

    try:
        # POST sms/send
        api_response = api_instance.example(body)
        print("The response of SmsApi->example:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SmsApi->example: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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