Difference between pages "SimpleSMSSend" and "SimpleSMSSendWithPostback"

From CDYNE Wiki
(Difference between pages)
Jump to navigation Jump to search
imported>Nfesette
(DESCRIPTION)
 
imported>Nfesette
 
Line 1: Line 1:
== DESCRIPTION ==
+
* Send single, immediate text messages.
 +
* Utilizes the [[http://wiki.cdyne.com/index.php/SMS_Notify!_PostBackURLs PostBackURL]] feature.
 +
* SMS Notify! uses account [http://wiki.cdyne.com/index.php/Glossary#DID DID]s or [http://wiki.cdyne.com/index.php/Glossary#Short_Code short codes] assigned to the license key that is passed to send [http://wiki.cdyne.com/index.php/Glossary#MT_.28Mobile_Terminated.29 MT] messages.
  
The SimpleSMSSend method is ideal for sending out single, basic notifications. Use this method to connect to a bank of shared phone numbers to send [[http://wiki.cdyne.com/index.php/Glossary#MT_.28Mobile_Terminated.29 MT]] messages and receive responses from those messages. [[http://wiki.cdyne.com/index.php/Glossary#MO_.28Mobile_Originated.29 MO]] messaging requires the use of a [[http://wiki.cdyne.com/index.php/Glossary#DID_.28Dedicated_Phone_Number.29 DID]] and the AdvancedSMSSend method.<br>
+
== SimpleSMSSendWithPostback Request ==
 
 
== OPERATION: SimpleSMSSend INPUT ==
 
  
 
{| class="wikitable" cellspacing="5"
 
{| class="wikitable" cellspacing="5"
Line 27: Line 27:
 
| ''String''
 
| ''String''
 
| This is a sample message from SMS Notify!
 
| This is a sample message from SMS Notify!
 +
|-
 +
 +
| '''StatusPostBackURL:''' Input to receive posts to your server when SMS
 +
has been sent, and when response is received.
 +
| ''String''
 +
| Server URL
 
|-
 
|-
  
 
|}
 
|}
  
== OPERATION: SimpleSMSSend OUTPUT ==
+
== SimpleSMSSendWithPostback Response ==
  
 
<br>
 
<br>
Line 90: Line 96:
 
|}
 
|}
  
== NOTES ==
+
== SimpleSMSSendWithPostback XML ==
 +
 
 +
'''HTTP Method: GET'''
 +
 
 +
The following is an example response Xml body:
 +
 
 +
<pre>
  
==== Preferred Phone Number Format ====
+
<SMSResponse xmlns="http://sms2.cdyne.com">
 +
  <Cancelled>true</Cancelled>
 +
  <MessageID>1627aea5-8e0a-4371-9022-9b504344e724</MessageID>
 +
  <Queued>true</Queued>
 +
  <ReferenceID>String content</ReferenceID>
 +
  <SMSError>NoError</SMSError>
 +
  <SMSIncomingMessages>
 +
    <SMSIncomingMessage>
 +
      <FromPhoneNumber>String content</FromPhoneNumber>
 +
      <IncomingMessageID>1627aea5-8e0a-4371-9022-9b504344e724</IncomingMessageID>
 +
      <MatchedMessageID>1627aea5-8e0a-4371-9022-9b504344e724</MatchedMessageID>
 +
      <Message>String content</Message>
 +
      <ResponseReceiveDate>1999-05-31T11:20:00</ResponseReceiveDate>
 +
      <ToPhoneNumber>String content</ToPhoneNumber>
 +
    </SMSIncomingMessage>
 +
    <SMSIncomingMessage>
 +
      <FromPhoneNumber>String content</FromPhoneNumber>
 +
      <IncomingMessageID>1627aea5-8e0a-4371-9022-9b504344e724</IncomingMessageID>
 +
      <MatchedMessageID>1627aea5-8e0a-4371-9022-9b504344e724</MatchedMessageID>
 +
      <Message>String content</Message>
 +
      <ResponseReceiveDate>1999-05-31T11:20:00</ResponseReceiveDate>
 +
      <ToPhoneNumber>String content</ToPhoneNumber>
 +
    </SMSIncomingMessage>
 +
  </SMSIncomingMessages>
 +
  <Sent>true</Sent>
 +
  <SentDateTime>1999-05-31T11:20:00</SentDateTime>
 +
</SMSResponse>
  
CDYNE SMS Notify! API coverage is worldwide. View CDYNE [http://www.cdyne.com/downloads/international-sms-coverage.pdf SMS International coverage PDF] by region, country, and network name.<br>
+
</pre>
  
'''USA/Canada'''
+
== SimpleSMSSendWithPostback Json ==
* 1 + NPA + NXX + XXXX
 
* 1 + (Area Code) + Number <br>
 
* ''Example:'' (1 + 757 + 544 + 9510) = 17575449510<br>
 
  
'''International'''
+
== SimpleSMSSendWithPostback Code Examples ==
* 0 + 11 + Country Code + Phone number<br>
 

Revision as of 10:14, 24 September 2012

  • Send single, immediate text messages.
  • Utilizes the [PostBackURL] feature.
  • SMS Notify! uses account DIDs or short codes assigned to the license key that is passed to send MT messages.

SimpleSMSSendWithPostback Request

Parameter Name Data Type Sample Input
Phone Number: Input phone number to send SMS text to. String 17575449510
LicenseKey: Required to authenticate users invoking this Web Service.

Trial Key. Production Key.

Guid F01d89fd-5155-5455-5585-e84ab8de8591
Message: Message to send to phone number String This is a sample message from SMS Notify!
StatusPostBackURL: Input to receive posts to your server when SMS

has been sent, and when response is received.

String Server URL

SimpleSMSSendWithPostback Response


Parameter Name Data Type Sample Input
MessageID: Returns unique Guid ID for every SMS message sent. Guid B01d89fd-5155-5455-5585-e84ab8de8591
Queued: Returns true or false if the SMS message has been queued. Boolean True
ReferenceID: A unique ID that can be set using the AdvancedSMSSend method. String
SMSError: Returns a string indicating if there was an error sending the SMS message.
  • NoError
  • STOPfromPhoneNumber
  • LicenseKeyInvalid
  • PhoneNumberInvalid
  • MessageInvalid
  • ScheduledDateTimeIsNotUTC
  • InvalidAssignedDID
  • NotFound (Occurs for Invalid MessageID)
  • InternalError
  • ContactCdyneAccountSuspended
String NoError
SMSIncomingMessages: Returns true or false if replies can be received. Boolean True
Sent: Returns true or false if the SMS message has been sent to the carrier. Boolean False
SentDateTime: Returns the UTC Date and Time of when the message was sent. Datetime 0001-01-01T00:00:00

SimpleSMSSendWithPostback XML

HTTP Method: GET

The following is an example response Xml body:


<SMSResponse xmlns="http://sms2.cdyne.com">
  <Cancelled>true</Cancelled>
  <MessageID>1627aea5-8e0a-4371-9022-9b504344e724</MessageID>
  <Queued>true</Queued>
  <ReferenceID>String content</ReferenceID>
  <SMSError>NoError</SMSError>
  <SMSIncomingMessages>
    <SMSIncomingMessage>
      <FromPhoneNumber>String content</FromPhoneNumber>
      <IncomingMessageID>1627aea5-8e0a-4371-9022-9b504344e724</IncomingMessageID>
      <MatchedMessageID>1627aea5-8e0a-4371-9022-9b504344e724</MatchedMessageID>
      <Message>String content</Message>
      <ResponseReceiveDate>1999-05-31T11:20:00</ResponseReceiveDate>
      <ToPhoneNumber>String content</ToPhoneNumber>
    </SMSIncomingMessage>
    <SMSIncomingMessage>
      <FromPhoneNumber>String content</FromPhoneNumber>
      <IncomingMessageID>1627aea5-8e0a-4371-9022-9b504344e724</IncomingMessageID>
      <MatchedMessageID>1627aea5-8e0a-4371-9022-9b504344e724</MatchedMessageID>
      <Message>String content</Message>
      <ResponseReceiveDate>1999-05-31T11:20:00</ResponseReceiveDate>
      <ToPhoneNumber>String content</ToPhoneNumber>
    </SMSIncomingMessage>
  </SMSIncomingMessages>
  <Sent>true</Sent>
  <SentDateTime>1999-05-31T11:20:00</SentDateTime>
</SMSResponse>

SimpleSMSSendWithPostback Json

SimpleSMSSendWithPostback Code Examples