https://github.com/infobip/oneapi-dot-net

oneapi-dot-net
https://github.com/infobip/oneapi-dot-net

Last synced: 4 days ago
JSON representation

oneapi-dot-net

• Host: GitHub
• URL: https://github.com/infobip/oneapi-dot-net
• Owner: infobip
• License: apache-2.0
• Created: 2012-07-31T12:39:02.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2014-07-21T15:36:49.000Z (over 10 years ago)
• Last Synced: 2024-09-30T06:44:12.657Z (about 2 months ago)
• Language: C#
• Size: 1.37 MB
• Stars: 11
• Watchers: 18
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
OneApi dot-net client

============================

Basic messaging example

-----------------------

First initialize the messaging client using your username and password:

    Configuration configuration = new Configuration(username, password);

    SMSClient smsClient = new SMSClient(configuration);

An exception will be thrown if your username and/or password are incorrect.

Prepare the message:

    SMSRequest smsRequest = new SMSRequest(senderAddress, message, recipientAddress);

Send the message:

    // Store request id because we can later query for the delivery status with it:

    string requestId = smsClient.SmsMessagingClient.SendSMS(smsRequest);

Later you can query for the delivery status of the message:

    DeliveryInfoList deliveryInfoList = smsClient.SmsMessagingClient.QueryDeliveryStatus(senderAddress, requestId);

    string deliveryStatus = deliveryInfoList.DeliveryInfos[0].DeliveryStatus;

Possible statuses are: **DeliveredToTerminal**, **DeliveryUncertain**, **DeliveryImpossible**, **MessageWaiting** and **DeliveredToNetwork**.

Messaging with notification push example

-----------------------

Same as with the standard messaging example, but when preparing your message:

    SMSRequest smsRequest = new SMSRequest(senderAddress, message, recipientAddress);

    // The url where the delivery notification will be pushed:

    smsRequest.NotifyURL = notifyUrl;

When the delivery notification is pushed to your server as a HTTP POST request, you must process the body of the message with the following code:

    DeliveryInfoNotification deliveryInfoNotification = smsClient.SmsMessagingClient.ConvertJsonToDeliveryInfoNotification(JSON);

HLR example

-----------------------

Initialize and login the data connection client:

    Configuration configuration = new Configuration(username, password);

    SMSClient smsClient = new SMSClient(configuration);

Retrieve the roaming status (HLR):

    Roaming roaming = smsClient.HlrClient.QueryHLR(address);

HLR with notification push example

-----------------------

Similar to the previous example, but this time you must set the notification url where the result will be pushed:

    smsClient.HlrClient.QueryHLR(address, notifyUrl);

When the roaming status notification is pushed to your server as a HTTP POST request, you must process the body of the message with the following code:

    RoamingNotification roamingNotification = smsClient.HlrClient.ConvertJsonToHLRNotification(JSON);

Retrieve inbound messages example

-----------------------

With the existing sms client (see the basic messaging example to see how to start it):

    InboundSMSMessageList inboundSMSMessageList = smsClient.SmsMessagingClient.GetInboundMessages();

Inbound message push example

-----------------------

The subscription to recive inbound messages can be set up on our site.

When the inbound message notification is pushed to your server as a HTTP POST request, you must process the body of the message with the following code:

    InboundSMSMessageList inboundSMSMessageList = smsClient.SmsMessagingClient.ConvertJsonToInboundSMSMessageNotification(JSON);

License

-------

This library is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)