smstools-api-client 0.0.9

Smstools API

smstools

The SMS Gateway API for smstools provides a robust and easy-to-integrate solution for sending and receiving SMS messages programmatically. It enables developers to integrate text messaging capabilities into their applications, websites, and software, offering features such as sending single or bulk SMS, managing contacts and groups, receiving inbound messages, and accessing delivery reports. This API facilitates various communication needs, from marketing campaigns to CRM integrations and automated alerts. Please note that this API description is independently created and not affiliated with smstools.com. Official documentation at: https://www.smstools.com/en/sms-gateway-api/

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.0.1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import smstools

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import smstools

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

from pprint import pprint

from smstools import Smstools, ApiException


if __name__ == '__main__':
    smstools_client = Smstools(
        client_id="CLIENT_ID",
        client_secret="CLIENT_SECRET",
    )

    try:
        response = smstools_client.get_account()
        pprint(response.to_dict())
    except ApiException as e:
        print("Exception when calling smstools API: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.smsgatewayapi.com

Class	Method	HTTP request	Description
DefaultApi	create_contact	POST /v1/contact	Add contact
DefaultApi	create_group	POST /v1/groups	Add group
DefaultApi	create_message_template	POST /v1/messagetemplates	Add message template
DefaultApi	create_optout	POST /v1/optouts	Add Opt-out
DefaultApi	create_subaccount	POST /v1/subaccount	Create subaccount
DefaultApi	format_number	POST /v1/format/number	Format number
DefaultApi	get_account	GET /v1/account	Get account
DefaultApi	get_balance	GET /v1/balance	Get balance
DefaultApi	get_conversation	GET /v1/conversation/{phone}	Get a conversation with a number.
DefaultApi	get_country_codes	GET /v1/countrycodes/{language}	Get country codes
DefaultApi	get_group	GET /v1/groups/{id}	Get group
DefaultApi	get_history	GET /v1/message/logging	Get history
DefaultApi	get_inbox	GET /v1/message/inbox	Get inbox
DefaultApi	get_message_template	GET /v1/messagetemplates/{id}	Get specific message template
DefaultApi	get_outbox	GET /v1/outbox	Get outbox
DefaultApi	get_sender_id	GET /v1/senderids	Get sender ID
DefaultApi	get_specific_inbox	GET /v1/message/inbox/{id}	Get specific inbox
DefaultApi	get_subaccount	GET /v1/subaccount/{id}	Get subaccount
DefaultApi	get_subaccount_history	GET /v1/message/logging/subaccount/{id}	Get History subaccount
DefaultApi	get_webhook	GET /v1/webhook/{id}	Get webhook
DefaultApi	get_whitelabel_account	GET /v1/customer/{accountName}	Get whitelabel account
DefaultApi	get_whitelabel_account_sso	GET /v1/customer/{accountName}/login	Get whitelabel account SSO
DefaultApi	list_contacts	GET /v1/contact	Get all contacts
DefaultApi	list_groups	GET /v1/groups	Get all groups
DefaultApi	list_message_templates	GET /v1/messagetemplates	Get message templates
DefaultApi	list_optouts	GET /v1/optouts/list	List Opt-out
DefaultApi	list_statistics	GET /v1/statistics	Get statistics
DefaultApi	list_subaccount_statistics	GET /v1/statistics/subaccount/{id}	Get statistics subaccount
DefaultApi	list_subaccounts	GET /v1/subaccount	List subaccounts
DefaultApi	list_virtual_mobile_numbers	GET /v1/vmn	Get virtual mobile numbers
DefaultApi	list_whitelabel_accounts	GET /v1/customer	List whitelabel accounts
DefaultApi	remove_contact	DELETE /v1/contact/{id}	Remove contact
DefaultApi	remove_from_outbox	DELETE /v1/outbox/{id}	Remove from outbox
DefaultApi	remove_group	DELETE /v1/groups/{id}	Remove group
DefaultApi	remove_message_template	DELETE /v1/messagetemplates/{id}	Remove message template
DefaultApi	remove_optout	DELETE /v1/optouts/{phone}	Remove Opt-out
DefaultApi	search_contact	GET /v1/contact/search/{keyword}	Search contact
DefaultApi	send_text_message	POST /v1/message/send	Send text message
DefaultApi	send_voice_message	POST /v1/voice/send	Send voice message
DefaultApi	update_contact	PATCH /v1/contact	Update contact
DefaultApi	update_group	PATCH /v1/groups	Update group
DefaultApi	update_message_template	PATCH /v1/messagetemplates	Update message template
DefaultApi	update_subaccount	PATCH /v1/subaccount/{id}	Update subaccount
DefaultApi	whatsapp_is_window_open	POST /v1/whatsapp/is_window_open	is 24H window open
DefaultApi	whatsapp_list_numbers	GET /v1/whatsapp/numbers	Get account numbers
DefaultApi	whatsapp_list_templates	GET /v1/whatsapp/templates	Get account templates
DefaultApi	whatsapp_send_action	POST /v1/whatsapp/send_action	Send Action
DefaultApi	whatsapp_send_file	POST /v1/whatsapp/send_file	Send File
DefaultApi	whatsapp_send_list	POST /v1/whatsapp/send_list	Send List
DefaultApi	whatsapp_send_location	POST /v1/whatsapp/send_location	Send Location
DefaultApi	whatsapp_send_template	POST /v1/whatsapp/send_template	Send Template
DefaultApi	whatsapp_send_text	POST /v1/whatsapp/send_text	Send Text

Documentation For Models

• AccountResponse
• BalanceResponse
• ContactInfoCreateRequest
• ContactInfoResponse
• ContactInfoUpdateRequest
• CreateMessageTemplateRequest
• CreateOptoutRequest
• CreateSubaccountRequest
• ErrorResponse
• FormatNumber200Response
• FormatNumberRequest
• GetConversation200Response
• GetConversation200ResponseAllOfConversationInner
• GetConversation200ResponseAllOfConversationInnerFile
• GetCountryCodes200ResponseInner
• GetGroup200Response
• GetHistory200Response
• GetHistory200ResponseAllOfMessagesInner
• GetHistory200ResponseAllOfMessagesInnerResponse
• GetInbox200Response
• GetInbox200ResponseAllOfMessagesInner
• GetOutbox200Response
• GetSpecificInbox200Response
• GetSpecificInbox200ResponseAllOfMessagesInner
• GetWebhook200ResponseInner
• GetWebhook200ResponseInnerMessage
• GetWhitelabelAccountSSO200Response
• GroupInfoCreateRequest
• GroupInfoResponse
• GroupInfoUpdateRequest
• IdsResponse
• ListContacts200Response
• ListStatistics200Response
• ListVirtualMobileNumbers200ResponseInner
• ListWhitelabelAccounts200Response
• MessageParameter
• MessageResponse
• MessageTemplateResponse
• OptoutResponse
• PaginationResponse
• SendParameters
• SendResponse
• SendTextMessageRequest
• SendVoiceMessageRequest
• SenderIdResponse
• SenderParameter
• SubaccountResponse
• ToParameter
• UpdateMessageTemplateRequest
• UpdateSubaccountRequest
• WhatsappIsWindowOpen200Response
• WhatsappIsWindowOpen200ResponseRemainingTime
• WhatsappIsWindowOpenRequest
• WhatsappListNumbers200Response
• WhatsappListNumbers200ResponseNumbersInner
• WhatsappListTemplates200Response
• WhatsappListTemplates200ResponseTemplatesInner
• WhatsappSendActionRequest
• WhatsappSendActionRequestAllOfButtonsInner
• WhatsappSendFileRequest
• WhatsappSendListRequest
• WhatsappSendLocationRequest
• WhatsappSendLocationRequestAllOfLocation
• WhatsappSendTemplateRequest
• WhitelabelAccountResponse
• WhitelabelAccountResponseInbox

Documentation For Authorization

Authentication schemes defined for the API:

clientId

• Type: API key
• API key parameter name: X-Client-Id
• Location: HTTP header

clientSecret

• Type: API key
• API key parameter name: X-Client-Secret
• Location: HTTP header

Author