Skip to main content

SMS framework: GatewayApi provider

Project description

Build Status Pythons

SMSframework GatewayAPI Provider

GatewayAPI Provider for smsframework.


Install from pypi:

$ pip install smsframework_gatewayapi

To receive SMS messages, you need to ensure that Flask microframework is also installed, as well as the JWT library:

$ pip install smsframework_gatewayapi[receiver]


from smsframework import Gateway
from smsframework_gatewayapi import GatewayAPIProvider

gateway = Gateway()
gateway.add_provider('gapi', GatewayAPIProvider,
    key='AAABBBBCCCCDDDD', secret='XAD*HHH(aaaaa'


Source: /smsframework_gatewayapi/

  • key: API key
  • secret: API secret
  • jwt_secret: Secret token for the JWT header (only for REST webhook that receives messages)


from smsframework import Gateway, OutgoingMessage

# Send a regular message
gateway.send(OutgoingMessage('+19991112233', 'Test'))

# Send a premium message
gateway.send(OutgoingMessage('+19991112233', 'Test').options(escalate=True))

Supported Options

  • validity_period: Message expiration time in minutes
  • senderId: Alpha-numeric SenderId
  • escalate: Premium message

Provider-Specific Parameters



Source: /smsframework_gatewayapi/

GatewayApi uses a single webhook URL to receive both messages and status reports.

Webhook URL: <provider-name>/callback

In order to configure it, go to the API/Webhooks section in the control panel, and add a new "REST" webhook. The URL will be something like this: http://.../<prefix>/<provider-name>/callback

In the Authentication section, you can specify a JWT secret token. Pass it to the GatewayAPIProvider in order to have secure message reception.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smsframework_gatewayapi-0.0.1.tar.gz (6.3 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page