SMS Notify!
Send text messages worldwide or MMS messages to US recipients from your website or application through CDYNE's SMS Gateway. SMS Notify! uses DIDs or short codes assigned to your account license key to send MT text / MMS messages and receive MO text / MMS messages. Use a Web Services client in any programming language to interact with SMS Notify! API.
- Your server or application makes a CDYNE SMS Notify! API Request
- CDYNE replies with an API response
- CDYNE sends message to appropriate aggregator
- Aggregator delivers message to appropriate carrier
- Carrier acknowledges receipt of message (short codes only)
- Carrier delivers message to cell phone
Contents
- 1 Supports SMS/MMS Methods
- 1.1 SendMessage
- 1.2 RemoveMedia
- 1.3 ReadMessageStatus
- 1.4 ReadIncomingMessages
- 1.5 GetUnsubscribedNumbers
- 1.6 GetPostbackSettingsForPhoneNumber
- 1.7 GetPostbackSettingsForLicenseKey
- 1.8 GetMediaInfo
- 1.9 GetMedia
- 1.10 CreateMediaFromURL
- 1.11 CreateMediaFromContent
- 1.12 SetPostbackEnabledForPhoneNumber
- 1.13 SetPostbackEnabledForLicenseKey
- 1.14 SetPostbackURLForPhoneNumber
- 1.15 SetPostbackURLForLicenseKey
- 2 Supports SMS Methods
- 3 Error Returns
- 4 Documentation Links
- 5 API Features
- 6 SMS Notify! Best Practices
Supports SMS/MMS Methods
SendMessage
Send regular SMS or multimedia MMS message - to a single recipient or multiple recipients.
RemoveMedia
Remove media you have added to your license key.
ReadMessageStatus
Read the status of an incoming or outgoing message.
ReadIncomingMessages
Read incoming messages - you can view new or all incoming messages.
GetUnsubscribedNumbers
Retrieve a list of all recipient numbers who have opted out of your messaging campaign.
GetPostbackSettingsForPhoneNumber
Retrieve PostbackURL settings for DID or short code.
GetPostbackSettingsForLicenseKey
Retrieve PostBackURL settings for SMS Notify! license key.
GetMediaInfo
Retrieve info of a particular media file that was added to your SMS Notify! license key.
GetMedia
Retrieve the Base64 representation of a particular media file that was added to your SMS Notify! license key.
CreateMediaFromURL
Create and add media to your SMS Notify! license key from a URL.
CreateMediaFromContent
Create and add media to your SMS Notify! license key from the Base64 representation of the image.
SetPostbackEnabledForPhoneNumber
Enable or disable a Postback that you have assigned to a specific DID or short code.
SetPostbackEnabledForLicenseKey
Enable or disable a Postback that you have assigned to a specific license key.
SetPostbackURLForPhoneNumber
Assign a PostbackURL to a specific DID or short code.
SetPostbackURLForLicenseKey
Assign a PostbackURL to a specific license key.
Supports SMS Methods
SimpleSMSSend
Send single, immediate text messages from your website or application.
SimpleSMSSendWithPostback
Send single, immediate text messages from your website or application utilizing the PostBackURL feature.
AdvancedSMSSend
Immediately send or schedule a single text message to multiple phone numbers, or individual messages to multiple recipients. The AdvancedSMSSend method includes a PostBackURL parameter.
GetMessageStatus
The GetMessageStatus method uses the MessageID parameter to return the status of a message.
GetMessageStatusByReferenceID
This method returns all messages with a predefined user ReferenceID set in AdvancedSMSSend method.
GetUnreadIncomingMessages
This method returns all unread text message responses attached to a single License Key and marks them as read.
CancelMessage
CancelMessage uses the Message ID to cancel a message scheduled for a later time or date. Does not work if message was already sent out or queued.
GetKeywords
Gets all currently enabled keywords for a license key.
AssignKeyword
Assigns one or more keywords to a license key.
RemoveKeyword
Removes one or more assigned keywords from a license key.
Error Returns
MMS
SMS Notify! API contains a parameter called SMSError, which returns a string indicating errors when sending the multimedia message.
SMS
SMS Notify! API contains a parameter called SMSError, which returns a string indicating errors when sending the text message.
Documentation Links
MMS
SMS Notify! MMS Specification Sheet
PDF document containing all SMS Notify! MMS programming methods with request and response descriptions.
An XML format document that defines SMS Notify! endpoints.
Service operations at endpoint https://messaging.cdyne.com/messaging.svc/help
Service operations at https://messaging.cdyne.com/messaging.svc/help
SMS
SMS Notify! Specification Sheet
PDF document containing all SMS Notify! programming methods with request and response descriptions.
An XML format document that defines SMS Notify! endpoints.
Service operations at endpoint http://sms2.cdyne.com/sms.svc
Service operations at https://sms2.cdyne.com/sms.svc/SecureREST
International Extended Suppported Carriers
Excel doc containing carriers supported worldwide. Includes destination pricing, available DIDs, carrier restrictions, and reach.
API Features
Text Message Length
Within your AdvancedSMSSend request if you set:
IsUnicode = True & Concatenate = True, the max message length is 67 characters (including spaces) Concatenate = True, the max message length is 153 characters (including spaces) IsUnicode = True, the max message length is 70.0 characters (including spaces)
However, if you set both the IsUnicode and Concatenate parameters to false within your request, the maximum character limit is 160 (including spaces).
U.S. SMS
U.S. Carriers are standardized and all text messages are 160 characters (including spaces) in length. When sending a text message to a recipient in the U.S. with more than 160 characters, the SMS Notify! API will automatically split the message into two or more messages for delivery.
Canadian SMS
Canadian Carriers vary from 136 to 160 characters (including spaces) in length. CDYNE sends to Canada the same way as the U.S. To ensure complete message delivery, CDYNE advises that your application only send messages to Canadian recipients in 136 character increments. If the message is longer than 136 characters, the best practice is to split the message on your application side at the 136 character mark to avoid data loss that may occur from Canadian Carriers that truncate anything over 136 or 140 characters.
PostBackURL
Know when your MT message has been sent or your application has received a MO or response message. CDYNE SMS Notify! API will automatically post information to a URL you specify each time an SMS has been sent or received.
DID System Keywords
SMS Notify! API will automatically respond to select keywords when receiving text messages with DIDs.
Short Code System Keywords
SMS Notify! API will automatically respond to select keywords when receiving text messages with short codes.
Short Code Incoming Keyword Management
Managing keywords assigned to short codes.
Unicode Support
SMS Notify! supports Unicode with International Extended DIDs.
Message Concatenation
SMS Notify! supports message concatenation.
SMS or MMS and Invalid Phone Numbers
How SMS Notify! handles invalid phone numbers.
IP Ranges
4.59.146.64-128 and 4.26.64.64-128
SMS Notify! Best Practices
DID Best Practices
Best practices for using SimpleSMSSend and AdvancedSMSSend with DIDs. Includes PostBack data, volume considerations and carrier coverage.
Short Code Best Practices
Best practices for using SimpleSMSSend and AdvancedSMSSend with short codes. Includes PostBack data, volume considerations and carrier coverage.
