Difference between revisions of "DID Best Practices"

From CDYNE Wiki
Jump to navigation Jump to search
imported>Nfesette
(Step by Step Message Flow)
imported>Nfesette
(Step by Step Message Flow)
Line 32: Line 32:
 
==== API Response ====
 
==== API Response ====
  
* CDYNE replies with an API response
+
# CDYNE replies with an API response
* In the Response, any errors immediately noticed are returned in the Response.
+
# In the Response, any errors immediately noticed are returned in the Response.
* Example Response: http://wiki.cdyne.com/index.php/SimpleSMSSend#SimpleSMSSend_Response
+
# Example Response: http://wiki.cdyne.com/index.php/SimpleSMSSend#SimpleSMSSend_Response
  
 
==== Send Message ====
 
==== Send Message ====
  
* CDYNE sends message to appropriate aggregator
+
# CDYNE sends message to appropriate aggregator
* Message is sent to aggregator
+
# Message is sent to aggregator
* CDYNE sends HTTP POST to your [http://wiki.cdyne.com/index.php/SMS_Notify!_PostBackURLs PostBackURL] indicating we sent the message to be delivered.
+
# CDYNE sends HTTP POST to your [http://wiki.cdyne.com/index.php/SMS_Notify!_PostBackURLs PostBackURL] indicating we sent the message to be delivered.
* Example Sent PostBack: http://wiki.cdyne.com/index.php/SMS_Message_Sent_Postback
+
# Example Sent PostBack: http://wiki.cdyne.com/index.php/SMS_Message_Sent_Postback
  
 
==== Deliver Message ====
 
==== Deliver Message ====
* Aggregator delivers message to appropriate carrier
+
# Aggregator delivers message to appropriate carrier
  
 
==== Handset Delivery ====
 
==== Handset Delivery ====
* Carrier delivers message to cell phone
+
# Carrier delivers message to cell phone
  
 
== PostBackURL System ==
 
== PostBackURL System ==

Revision as of 16:26, 1 October 2012

Send or receive text messages from your website or application with SMS-enabled phone numbers (DIDs): 10-digit phone numbers used for two-way text messaging. Each account license key is assigned one or more DIDs for sending and receiving text messages. CDYNE recommends sending no more than 500 MT messages per DID per day. Add DIDs for higher daily throughput needs, or use short codes for high volume needs.


SimpleSMSSend Method

SimpleSMSSend is recommended for sending single, immediate text messages.

  • When a license key is passed using this method, it will automatically send messages from the DIDs assigned to that license key. For license keys with more than one DID, SMS Notify! API will automatically balance the outgoing messages between assigned DIDs.
  • Additional SMS Notify! API license keys may be generated at no additional cost. Assigning DIDs to each additional license key allows you to pass a designated license key to control which DIDs sends the text message.

AdvancedSMSSend Method

AdvancedSMSSend is recommended for sending scheduled text messages and allows multiple numbers with one message, or multiple numbers with individual messages.

  • You can declare the sending DID in the "AssignedDID" parameter.
  • If a DID is not declared in the “AssignedDID” parameter, the method will automatically send messages from the DIDs assigned to that license key. For license keys with more than one DID, SMS Notify! API will automatically balance the outgoing messages between assigned DIDs.
  • Additional SMS Notify! API license keys may be generated at no additional cost. Assigning DIDs to each additional license key allows you to pass a designated license key to control which DIDs sends the text message.
  • If the DID does not match the license key passed, error code "6" for "InvalidAssignedDID" will return in the SMSError parameter.

Step by Step Message Flow

API Request

  1. Your server or application makes a CDYNE SMS Notify! API Request
  2. Message is sent to CDYNE through the API.
  3. Example GET Request: http://wiki.cdyne.com/index.php/SMS_Notify!#Calling_via_REST_.28POST.2FGET.29

API Response

  1. CDYNE replies with an API response
  2. In the Response, any errors immediately noticed are returned in the Response.
  3. Example Response: http://wiki.cdyne.com/index.php/SimpleSMSSend#SimpleSMSSend_Response

Send Message

  1. CDYNE sends message to appropriate aggregator
  2. Message is sent to aggregator
  3. CDYNE sends HTTP POST to your PostBackURL indicating we sent the message to be delivered.
  4. Example Sent PostBack: http://wiki.cdyne.com/index.php/SMS_Message_Sent_Postback

Deliver Message

  1. Aggregator delivers message to appropriate carrier

Handset Delivery

  1. Carrier delivers message to cell phone

PostBackURL System

Know when your SMS was sent or received with the PostBackURL System. CDYNE SMS Notify! API will automatically post information to a URL you specify when text messages are sent or received via DIDs and short codes. PostBackURL data is posted behind the scenes, and is not visible on your webpage. Code samples are provided on how to capture this data to store in a database. CDYNE recommends that the data returned to be stored within your systems for reporting and reference information.

API Throughput

Automated bulk sending or marketing text messages are not allowed with DIDs. Other volume limitations include:

  • Send MT SMS at a rate of 1 message every 2 seconds per DID (This throttle is imposed at server level, anything faster will get auto-queued)
  • Maximum daily volume per DID should be 500 MT messages per day (not limited by CDYNE servers, you will to program this limitation)
  • No restrictions on MO messages

Short codes should be used for projects that require high volume messaging.

Coverage & Area Codes

SMS Notify! will send messages to the U.S. and Canada only, or worldwide. The turnaround time to obtain account DIDs vary by coverage and whether or not you request an area code specific DID.

SMS to U.S. and Canada: all U.S. and Canadian carriers are supported.

  • Random U.S. DIDs are available immediately
  • Area code requests take 5 – 7 business days

SMS Worldwide: supports carriers worldwide (including all major U.S. and Canadian carriers).

  • Random DIDs are available in 1 – 2 business days
  • U.S. area code requests take 5 – 7 business days
  • Canada area code requests take 14 – 18 business days.* Only 2-way traffic allowed on Canadian DIDs

Phone Number Format

USA and Canada

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

Example

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

International

  • 0 + 11 + Country Code + Phone number

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.