Module bluevia :: Class BlueViaOutboundSms
[hide private]
[frames] | no frames]

Class BlueViaOutboundSms

source code

BlueVia --+
          |
         BlueViaOutboundSms

The BlueVia class for sending and tracking SMS.

Instance Methods [hide private]
 
__init__(self, sandbox='_Sandbox', realm='BlueVia', version='v1')
Initialize the BlueViaOutboundSms object
source code
 
sendSMS(self, addresses, message)
Send SMS via BlueVia to one or more recipients
source code
 
deliveryStatus(self, deliveryURL)
Track the delivery of a BlueVia SMS
source code

Inherited from BlueVia: hasCredentials, loadAccessToken, setAccessToken, setConsumer, setDebug

Inherited from BlueVia (private): _debug, _signAndSend

Class Variables [hide private]

Inherited from BlueVia: access_token, consumer, debugFlag, environment, http, realm, version

Method Details [hide private]

__init__(self, sandbox='_Sandbox', realm='BlueVia', version='v1')
(Constructor)

source code 

Initialize the BlueViaOutboundSms object

Parameters:
  • sandbox - (string): Indicates whether testing should be done in Sandbox mode. Use "" for real network access; Default: "_Sandbox"
  • realm - (string): Realm string; Default: "BlueVia"
  • version - (string): BlueVia API version; Default: "v1"

sendSMS(self, addresses, message)

source code 

Send SMS via BlueVia to one or more recipients

Parameters:
  • addresses - (array): An array of mobile numbers (string) in the form "44 (for UK) 7764735478" (Mobile number without first zero and no spaces)
  • message - (string): A maximum 160 char string containing the SMS message
Returns:
(tuple): (HTTP status, deliveryURL). HTTP status == "201" for success. Use deliverURL in method deliverStatus.

deliveryStatus(self, deliveryURL)

source code 

Track the delivery of a BlueVia SMS

Parameters:
  • deliveryURL - (string): deliveryURL provided by sendSMS method
Returns:
(tuple): (HTTP status, (dict) deliveryReceipt). HTTP status == "200" for success.