User:Bdriggers/SMSv3

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

SendMessage
Send regular SMS or multimedia MMS message - to a single recipient or multiple recipients.

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.

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.

RemoveMedia
Remove media you have added to your 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.

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.

GetPostbackSettingsForPhoneNumber
Retrieve PostbackURL settings for DID or short code.

GetPostbackSettingsForLicenseKey
Retrieve PostBackURL settings for SMS Notify! license key.

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.

Documentation Links
Specification Sheet

PDF document containing all SMS Notify! Messaging programming methods with request and response descriptions.

WSDL

An XML format document that defines SMS Notify! Messaging endpoints.

HTTP Service Operations

Service operations at endpoint https://messaging.cdyne.com/messaging.svc/help

HTTPS Service Operations

Service operations at https://messaging.cdyne.com/messaging.svc/help

Return Codes
SMS Notify! API contains a parameter called SMSError, which returns a string indicating any errors when utilizing non-deprecated API methods.

Methods
The methods listed below do NOT support MMS messaging.

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.

Documentation Links
'''[https://secure.cdyne.com/downloads/SPECS_SMS-Notify2.pdf SMS Notify! Specification Sheet]'''

PDF document containing all SMS Notify! deprecated programming methods with request and response descriptions.

WSDL

An XML format document that defines SMS Notify! deprecated endpoints.

HTTP Service Operations

Deprecated service operations at endpoint http://sms2.cdyne.com/sms.svc

HTTPS Service Operations

Deprecated 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.

Return Codes
SMS Notify! API contains a parameter called SMSError, which returns a string indicating errors when sending your request to CDYNE.

Message Length Restrictions
Messages over a specified number of characters (including spaces) will be split into multiple messages by the API if certain parameters/flags are set to "True" within your messaging request.

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.

Invalid Recipient 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.

IP Ranges
4.59.146.64-128 and 4.26.64.64-128

SMS Notify! Best Practices
DID Best Practices Best practices for using DIDs to send your message(s). Includes PostBack data, volume considerations and carrier coverage.

Short Code Best Practices Best practices for using short codes to send your message(s). Includes PostBack data, volume considerations and carrier coverage.