SMS Notify!

From CDYNE Wiki for Web Services
Revision as of 15:24, 15 March 2012 by Srhodes (Talk | contribs)
Jump to: navigation, search

CDYNE SMS Notify! API is a two-way SMS Web Service that sends and receives text messages world-wide through secure gateways. Click here for SMS Notify! product details.

  • Use shared and/or dedicated phone numbers to send and receive SMS messages
  • Send up to 1500 messages per minute with CDYNE shared phone numbers for only 1 cent per transaction
  • Give your application the ability to receive Mobile Originated SMS (incoming SMS) with dedicated phone numbers (DIDs)
  • Integrate telephony features with SMS-enabled phone numbers (when used with Phone Notify services. Please call 1-800-984-3710, inquire or initiate a chat.)
  • Send immediate or schedule SMS messages one at a time, or thousands simultaneously
  • Set up a “StatusPostBackURL” to automatically receive posts to your server when an SMS message has been sent, and when a response is received

Contents

DEVELOPER RESOURCES

SMS Notify! 2.0 Specification Sheet

SMS Notify! 2.0 API - WCF/SOAP/REST Service

Simple Test

Simply change the 17575449510 to your cell phone number to get a test message.

http://sms2.cdyne.com/sms.svc/SimpleSMSsend?PhoneNumber=17575449510&Message=TestMessage

Examples

Service Endpoint Help Pages

3rd Party Tutorials

  • 3rd party C# .NET Simple Send SMS tutorial can be found here > Video and Source

Calling via REST (POST/GET)

WCF Help page: REST Help Page


RESPONSIBLE USE OF SMS NOTIFY! API

CDYNE Corporation is committed to consumer protection and privacy and we do not allow the use of CDYNE SMS Notify! API for any type of unsolicited messaging. In an effort to ensure that all text messaging sent through CDYNE SMS Notify! API is conducted responsibly; we are providing the following summary guideline for CDYNE SMS Notify! API use.

  • At all times, text messages sent from CDYNE SMS Notify! API must be in accordance with applicable federal and state laws, rules and regulations.
  • Proof of recipient opt-in or explicit consent is required for all SMS text messaging through CDYNE SMS Notify! API.
  • A recipient can stop participating and receiving messages through SMS Notify! by texting STOP. SMS Notify! will block sending to that recipient until they text RESUME.
  • Users of CDYNE SMS Notify! API should record and store all opt-in and opt-out transactions.
  • Content must be sent to age appropriate customers.
  • Selling mobile opt-in lists is prohibited.

Telemarketing Text Messages and Explicit Consent

A telemarketing message is any message that seeks to sell or advertise goods or services.

  • Users of CDYNE SMS Notify! API must obtain approval from recipients before sending telemarketing messages to wireless numbers.
  • Opt-in must explicitly communicate to the recipient the types of messages they will receive (i.e., order confirmation and upcoming offers, etc), and opt-in should occur at the time the wireless number is provided.
  • The following is a list of opt-in examples for telemarketing text messages.
    • Recipient may send a Mobile Originated (MO) message from their handset to the dedicated phone number.
    • Recipient may initiate opt-in from a website form.
    • Recipient may initiate opt-in from an IVR system (telephone keypress).
    • Recipient may initiate opt-in from a paper form.
  • Oral consent is not an acceptable opt-in method for any telemarketing text message.

Non-Telemarketing Text Messages and Explicit Consent

A non-telemarketing text message is a purely informational message requested by the recipient (by paper, electronic, or oral consent) for a specific purpose. It does not contain an unsolicited advertisement, and is not sent for commercial purposes. Some examples of non-telemarketing text messages include bank account balance, credit card fraud alert, package delivery, school closing, customer-care, surveys, and messages by or on behalf of tax-exempt, non-profit entities.

Reselling CDYNE SMS Notify! and 3rd Party Marketing Applications

Due to the ambiguous nature of the opt-ins that occur for clients of a reseller, we are unable to approve reseller accounts unless there is an explicit and verifiable opt-in that occurs for all customers through one portal or application. We sincerely apologize for any inconvenience this may cause.

Additional Information


LICENSE KEYS AND PRICING

Free Trial License Keys

CDYNE offers trial license keys for all Web Services so that you may test the APIs for free. Trial keys do not expire, and are limited to approximately 50 transactions. Normal processing time for trial key requests during normal business hours (M-F, 9-6 eastern) typically ranges from ten minutes to two hours.

CDYNE SMS Notify! API trial keys do require a short verification process due to FCC regulations regarding SMS text messaging. CDYNE Corporation is committed to consumer protection and privacy and we do not allow the use of CDYNE SMS Notify! API for any type of unsolicited messaging. In an effort to ensure that all text messaging sent through CDYNE SMS Notify! API is conducted responsibly; we are providing the attached summary guideline for CDYNE SMS Notify! API use.

Verification will include proof of recipient opt-in or explicit consent to receive text messages. The following is a list of opt-in examples:

  • Recipient may send a Mobile Originated (MO) message from their handset to the dedicated phone number.
  • Recipient may initiate opt-in from a website form.
  • Recipient may initiate opt-in from an IVR system (telephone keypress).
  • Recipient may initiate opt-in from a paper form.

Oral consent is not an acceptable opt-in method for any telemarketing text message.

Production (Account) License Keys

Sign up here for a production SMS Notify! license key.

Upon registration, your account will be suspended for verification. This is due to FCC regulations regarding SMS text messaging. At all times, text messages sent from CDYNE SMS Notify! API must be in accordance with applicable federal and state laws, rules and regulations. In an effort to ensure that all text messaging sent through CDYNE SMS Notify! API is conducted responsibly; we are providing the attached summary guideline for CDYNE SMS Notify! API use.

You may call 1-800-984-3710 to expedite the verification process over the phone.

Pricing

There is a monthly licensing fee of $9.99 for SMS Notify! API. Each outgoing and incoming message is charged as a transaction and will be billed according to monthly volume:

  • Monthly licensing fee of $9.99
  • Outgoing and incoming transactions are only 1 cent each
  • Dedicated SMS-enabled phone numbers (DIDs) are $1 per month per assigned number


Response messaging is charged at the normal transaction rate.

Pricing for all CDYNE Web Services is based off a set monthly maintenance fee and a per-transaction fee. CDYNE does not require a contract and there are absolutely no start-up or cancellation fees. CDYNE services are post-pay. Your credit card will not be charged until one month from sign-up date and will be billed monthly thereafter unless you deactivate or cancel services. Net 30 billing is available upon application approval.

GENERAL TECHNICAL INFORMATION

Preferred Phone Number Format (USA/Canada)

  • 1 + NPA + NXX + XXXX
  • 1 + (Area Code) + Number

Example

  • (1 + 757 + 544 + 9510) = 17575449510

Preferred Phone Number Format (International)

  • 0 + 11 + Country Code + Phone number

CDYNE SMS Notify! API coverage is worldwide. View CDYNE SMS International coverage PDF by region, country, and network name.

IP Ranges

4.59.146.64-128 and 4.26.64.64-128


Dedicated Phone Numbers (DIDs)

Give your application the ability to receive Mobile Originated SMS (incoming SMS) with dedicated phone numbers assigned to your production SMS Notify! license key.

  • SMS-enabled dedicated phone numbers (DIDs) are available for both U.S. and Canadian phone numbers.
  • Throughput for each DID is 1 message per 6 seconds. This cannot be increased due to carrier restrictions.
  • Dedicated SMS-enabled phone numbers (DIDs) are $1 per month per assigned number.

In order to send messages from a DID, the dedicated number must be specified using the AdvancedSMSSend operation. Within that operation is a parameter named AssignedDID where the dedicated number will need to be inputted.

Please call 1-800-984-3710, inquire or initiate a chat to order a dedicated phone number. U.S. DIDs typically take five to seven business days to be assigned to your account license key. Canadian DIDs will take 14 - 18 business days. When placing an order for DIDs, it is necessary that you specify if you require international capability.

PostBackURLs

PostBackURLs allow SMS Notify! API customers to instantly know when a:

This eliminates the need for the customer to constantly query CDYNE servers for responses. PostBackURLs are only sent to the server you specify in the Postback variables. An example of what a postbackURL link might look like is: http://www.blanksite.com/incomingsms.aspx.

Using shared numbers, the PostbackURL must be assigned using either the SimpleSMSSend with Postback operation or the AdvancedSMSSend operation. DID users may assign a PostBackURL to a DID by logging into your account at cdyne.com and doing the following:

  • Select “Manage Services” on the left-hand menu
  • Click open the SMS Notify! module
  • Select “DID,” which will open a new screen listing your
  • Click on the edit button on the right and add the URL.


Please call 1-800-984-3710, inquireor initiate a chatto assign your PostbackURL.

Automated Keyword Management

SMS Notify uses some “Key Words” developers should be aware of. Should an end user respond to one of your messages, and the first word is one of the following, it will cause our system to execute a special command.


  • HELP - When a recipient responds HELP, we will send contact information about the party who initiated the message to the recipient. This allows the recipient to know who is contacting them, and provides them information on how they can contact the sender.
  • STOP, END, CANCEL, UNSUBSCRIBE, or QUIT - This will block the recipient’s number from receiving messages from our system. This is to protect the recipient from unwanted or unsolicited messages.
  • RESUME - This will allow CDYNE to send messages to a recipient who previously sent a STOP, END, CANCEL, UNSUBSCRIBE, or QUIT command.


SMS Error Returns

SMS Notify! API contains a parameter called SMSError, which returns a string indicating errors when sending the text message.

Error Code Description
0 NoError
1 STOPfromPhoneNumber
2 LicenseKeyInvalid
3 PhoneNumberInvalid
4 MessageInvalid
5 ScheduledDateTimeIsNotUTC
6 InvalidAssignedDID
7 NotFound (Occurs for Invalid MessageID)
8 InternalError
9 ContactCdyneAccountSuspended

SMS and Special Characters

SMS Notify! supports most special characters, however, there are certain characters which most phones have trouble receiving. Most American and European phones don't support Unicode and thus will not correctly receive messages with certain characters. The following characters can only be received on phones that support Unicode:

Character Description
[ left square bracket
\ back slash
] right square bracket
^ caret
` grave accent
{ left curly brace
| pipe or vertical bar
} right curly brace
~ tilde
DEL Delete

SMS and Daylight Savings Time

SMS Notify recognizes the date and time in UTC (Coordinated Universal Time). When clocks move forward 1 hour in the spring, most time zones will need to remove one hour from their UTC offset. For example, Eastern Standard Time (EST) is UTC -5 hours but Eastern Daylight Time (EDT) is UTC -4 hours.

Invalid Phone Numbers

CDYNE’s SMS Notify! SMS Gateway API will automatically clean up certain errors for U.S. and Canadian phone numbers. For example, if you were to send a message to “7575449510e,” the API would take out the “e” and send the message to 7575449510. In this example, SMS Notify! API would return a parameter of “NoError” and continue to send the message to the cleaned up phone number.

While the SMS Notify! text message API will clean errors such as extra digits and/or letters, it will not clean numbers if it has been entered incorrectly and is still a valid number. For example if you wanted to send a notification to 7575449510, but instead you had the number as 7575449501 within your script, the message would be sent to 7575449501 as it is a valid number.

CDYNE SMS Notify! API does not do a phone verification check on phone numbers, and it will send all valid numbers out. One work around is to run your phone list through CDYNE Phone Verification API which will return whether a phone number is a landline or cell number. CDYNE Phone Verification API is a cost effective way to distinguish between a landline and cellular or even fake phone number.

Security

CDYNE does offer SMS Notify! API HTTPS URLs for added security.

CDYNE currently maintains 3 major server farms, bringing added redundancy to our networks and additional capacity. CDYNE's data centers are engineered with multiple levels of security, uninterruptible power supplies (UPS), redundant HVAC systems, and fire suppression, as well as 24 X 7 monitoring and management. They are protected by 24 hour surveillance with a HID security badge and biometric hand scanners. All server racks have locks on them. CDYNE never mines or sell information that crosses our servers or systems.

HIPAA Compliance with SMS Notify! API

You will be required to use HTTPS to provide a secure channel for SMS messaging to be HIPAA compliant. Also, all messages cannot include credit card information or personal health record information.

CDYNE SMS Notify! was built in WCF (Windows Communication Foundation). WCF uses Message and Transport Security protocols to ensure the protection of information. The xml (including all fields) is protected by these protocols, and it allows for end-to-end security. http://msdn.microsoft.com/en-us/library/ms733137.aspx

100% SLA

Because availability is important for your mission-critical environment, CDYNE's Service Level Agreement (SLA) is designed to protect our clients against unscheduled outages. As the leader in the Web Services industry, CDYNE is the only provider with such an uncompromising SLA, guaranteeing zero downtime of the services you rely on. The SLA provides unsurpassed levels of availability with correspondingly aggressive penalties for failure to comply with the SLA. This 100% uptime assurance is a direct result of CDYNE's relentless pursuit of service excellence.

Personal tools
Toolbox





Trial Key