README.md

   1 csharp-client
   2 ===========
   3
   4 SMSAPI C# client may be used by *SMSAPI.pl* and *SMSAPI.com* clients.
   5
   6 ## How to pick a service?
   7
   8 ### *SMSAPI.IO* (default)
   9
  10 ```c#
  11 var smsApi = new SMSApi.Api.SMSFactory(client);
  12 //or
  13 var smsApi = new SMSApi.Api.SMSFactory(client, ProxyAddress.SmsApiIo);
  14 ```
  15
  16 ### *SMSAPI.PL*
  17
  18 ```c#
  19 var smsApi = new SMSApi.Api.SMSFactory(client, ProxyAddress.SmsApiPl);
  20 ```
  21
  22 ### *SMSAPI.COM*
  23
  24 ```c#
  25 var smsApi = new SMSApi.Api.SMSFactory(client, ProxyAddress.SmsApiCom);
  26 ```
  27
  28
  29 ### Example
  30
  31 ```c#
  32 try
  33 {
  34         SMSApi.Api.IClient client = new SMSApi.Api.ClientOAuth("token");
  35
  36         var smsApi = new SMSApi.Api.SMSFactory(client);
  37         // for SMSAPI.com clients:
  38         // var smsApi = new SMSApi.Api.SMSFactory(client, ProxyAddress.SmsApiCom);
  39
  40         var result =
  41                 smsApi.ActionSend()
  42                         .SetText("test message")
  43                         .SetTo("0000000000")
  44                         .SetSender("Test") //Sender name
  45                         .Execute();
  46
  47         System.Console.WriteLine("Send: " + result.Count);
  48
  49         string[] ids = new string[result.Count];
  50
  51         for (int i = 0, l = 0; i < result.List.Count; i++)
  52         {
  53                 if (!result.List[i].isError())
  54                 {
  55                         if (!result.List[i].isFinal())
  56                         {
  57                                 ids[l] = result.List[i].ID;
  58                                 l++;
  59                         }
  60                 }
  61         }
  62
  63         System.Console.WriteLine("Get:");
  64         result =
  65                 smsApi.ActionGet()
  66                         .Ids(ids)
  67                         .Execute();
  68
  69         foreach (var status in result.List)
  70         {
  71                 System.Console.WriteLine("ID: " + status.ID + " Number: " + status.Number + " Points:" + status.Points + " Status:" + status.Status + " IDx: " + status.IDx);
  72         }
  73 }
  74 catch (SMSApi.Api.ActionException e)
  75 {
  76         /**
  77          * Action error
  78          */
  79         System.Console.WriteLine(e.Message);
  80 }
  81 catch (SMSApi.Api.ClientException e)
  82 {
  83         /**
  84          * Error codes (list available in smsapi docs). Example:
  85          * 101  Invalid authorization info
  86          * 102  Invalid username or password
  87          * 103  Insufficient credits on Your account
  88          * 104  No such template
  89          * 105  Wrong IP address (for IP filter turned on)
  90          * 110  Action not allowed for your account
  91          */
  92         System.Console.WriteLine(e.Message);
  93 }
  94 catch (SMSApi.Api.HostException e)
  95 {
  96         /*
  97          * Server errors
  98          * SMSApi.Api.HostException.E_JSON_DECODE - problem with parsing data
  99          */
 100         System.Console.WriteLine(e.Message);
 101 }
 102 catch (SMSApi.Api.ProxyException e)
 103 {
 104         // communication problem between client and sever
 105         System.Console.WriteLine(e.Message);
 106 }
 107 ```
 108
 109 ## Requirements
 110
 111 * C# >= 3.5 + System.Runtime.Serialization, System.ServiceModel.Web
 112 * C# >= 4.0
 113
 114 ## LICENSE
 115 [Apache 2.0 License](https://github.com/smsapi/smsapi-php-client/blob/master/LICENSE)