Difference between pages "PavcSharp" and "SimpleSMSSend"

From CDYNE Wiki
(Difference between pages)
Jump to navigation Jump to search
imported>Alauerman
 
imported>Nfesette
(DESCRIPTION)
 
Line 1: Line 1:
'''Using as a Service Reference'''<br>
+
== DESCRIPTION ==
Add a service reference to your project that will point to http://pav3.cdyne.com/PavService.svc?wsdl
 
  
==Sample Code==
+
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 DID and the AdvancedSMSSend method.<br>
  
====Verify Address====
+
== OPERATION: SimpleSMSSend INPUT ==
  
<code>
+
{| class="wikitable" cellspacing="5"
pav.PavServiceClient PSC = new pav.PavServiceClient("pavsoap");
 
pav.Address PavAdd = new pav.Address();
 
  
PavAdd = PSC.VerifyAddress("CDYNE Corporation", "2125 Smith Ave", " ", " ", "Chesapeake", "VA", "23320", "LICENSE KEY");
+
|-
        Console.WriteLine(
+
! '''Parameter Name'''
                PavAdd.FirmNameOrRecipient.ToString() + " " +
+
! align="left" | '''Data Type'''
                PavAdd.PrimaryAddressLine.ToString() + " " +
+
! align="left" | '''Sample Input'''
                PavAdd.SecondaryAddressLine.ToString() + " " +
+
|-
                PavAdd.CityName.ToString() + " " +
 
                PavAdd.StateAbbreviation.ToString() + " " +
 
                PavAdd.ZipCode.ToString() + " " +
 
                PavAdd.County.ToString() + " " +
 
                PavAdd.Urbanization.ToString() + " " +
 
                PavAdd.Country.ToString()
 
                );
 
</code>
 
  
====Verify Address Advanced====
+
| '''Phone Number:''' Input phone number to send SMS text to.
 +
| ''String''
 +
| 17575449510
 +
|-
  
====Get Intelligent Mail Barcode====
+
| '''LicenseKey:''' Required to authenticate users invoking this Web Service.
 +
[http://www.cdyne.com/developers/trial-key.aspx?ref=wiki Trial Key]. [https://secure.cdyne.com/support/register.aspx?qs=34 Production Key].
 +
| ''Guid''
 +
| F01d89fd-5155-5455-5585-e84ab8de8591
 +
|-
  
====Get Zip Codes For City and State====
+
| '''Message:''' Message to send to phone number
 +
| ''String''
 +
| This is a sample message from SMS Notify!
 +
|-
  
====Get City Names For A Zip Code====
+
|}
  
====Get Urbanization List For Zip Code====
+
== OPERATION: SimpleSMSSend OUTPUT ==
 +
 
 +
<br>
 +
 
 +
{| class="wikitable" cellspacing="5"
 +
 
 +
|-
 +
! '''Parameter Name'''
 +
! align="left" | '''Data Type'''
 +
! align="left" | '''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. <br>
 +
* 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
 +
|-
 +
 
 +
|}
 +
 
 +
== NOTES ==
 +
 
 +
==== Preferred Phone Number Format ====
 +
 
 +
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>
 +
 
 +
'''USA/Canada'''
 +
* 1 + NPA + NXX + XXXX
 +
* 1 + (Area Code) + Number <br>
 +
* ''Example:'' (1 + 757 + 544 + 9510) = 17575449510<br>
 +
 
 +
'''International'''
 +
* 0 + 11 + Country Code + Phone number<br>

Revision as of 12:18, 28 November 2011

DESCRIPTION

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 [MT] messages and receive responses from those messages. [MO] messaging requires the use of a DID and the AdvancedSMSSend method.

OPERATION: SimpleSMSSend INPUT

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!

OPERATION: SimpleSMSSend OUTPUT


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

NOTES

Preferred Phone Number Format

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

USA/Canada

  • 1 + NPA + NXX + XXXX
  • 1 + (Area Code) + Number
  • Example: (1 + 757 + 544 + 9510) = 17575449510

International

  • 0 + 11 + Country Code + Phone number