Github: VB SMS API

This article demonstrates how you can download the latest VB SMS API library from GitHub. You will learn how to download the GitHub Desktop app and sign into it. You will also learn how to clone a repository from the internet. We assume that you have already used GitHub and you are familiar with Visual Studio. You will be presented with some important information and well-structured step by step instructions. We hope you will find the presented instructions beneficial.

how to download latest vb sms api library from github
Figure 1 - How to download the latest VB SMS api library from Github

How to download the VB SMS API from GitHub (Quick steps)

To download the VB SMS API from GitHub:

  1. Create a GitHub account
  2. Download GitHub Desktop
  3. Sing in to GitHub.com
  4. Configure Git
  5. Clone the VB SMS repository in Github Desktop
  6. Open Ozeki.Libs.Rest.VB.sln
  7. Start the VB project
  8. Check the sent SMS in Ozeki SMS Gateway

Download Github Desktop(Video tutorial)

In this video, you will learn how to download the GitHub Desktop application. The video will start with opening the download page of GitHub Desktop and it will take you all the way to having the installer on your computer. The video is only 1 minute long, and you will learn every information you need to complete the download procedure.

Download GitHub Desktop installer

To access the GitHub Desktop download page, you will need to open the link. Here you can get the latest version of the program. Click the purple Download for Windows button(Figure 1). This will start the downloading process. Wait for the browser to finish the process to proceed.

download github desktop installer
Figure 1 - Download Github desktop installer

Install Github Desktop(Video tutorial)

In this video, we will show you how to start the installation process for GitHub Desktop. It will start with launching the installer and will take you all the way to having a working software on your computer. You will also learn how to login to the GitHub Desktop app. The video is only 1 minute long and very detailed. You will have no problem understanding the steps.

Start the installer

If your browser finished downloading the installer, search for it in the downloads folder on your computer. Click it to start the installation process. It will be an application type file named GitHubDesktopSetup-x64.

start github desktop installer
Figure 2 - Start Github desktop installer

Wait for the installer to finish

After you start the installation process, you will be presented with the window visible on Figure 3. It means that the GitHub Desktop is installing at the moment. You don't need to do anything here. The application will launch as soon as this window disappear.

installation procedure
Figure 3 - Installation procedure

Choose the Sign in to GitHub

The next step is to sign in to the GitHub Desktop application. This will require the login credentials of your GitHub user account. Click the Sign in to GitHub.com button to reach the login window. If you have never used GitHub before, you can create a new user account on this page. Click the Create free account link located above the sign in button. It will take you to the new user account creating page.

sign in to github
Figure 4 - Sign in to github

Provide username and password

The button will open a new browser window, where you need to log in (Figure 5). In this page, you need to use the username and password for your GitHub account. Type in both to the correct textbox and click the Sing in button to proceed to the next step.

define user name and password
Figure 5 - Define User name and password

Configure the Git

The Configure Git page will define what information will be visible as a commit detail. Check the Use my GitHub account name and email address checkbox (Figure 6). It means that the information from your GitHub will be used to identify the commits you create. It will be visible to any other GitHub user. Click the Finish button to confirm your settings.

configure git
Figure 6 - Configure Git

Clone the Ozeki.Libs.Rest.VB repository (Video tutorial)

In the next video you will see how to clone a repository. It will start with the opening page of the GitHub desktop app and will take you all the way to having the cloned repository on your computer for editing. You can learn which URL to copy ad where to paste it in GitHub Desktop. The rest is up to the GitHub Desktop. The video is 38 seconds long, but it has all the steps detailed. You will have no problem following it.

Select Clone the repository

To make any changes to the repository, you need to download the files to your computer. This means that you can edit them offline. It is necessary to have your own copy of the files before editing. In the Let’s get started page, you can choose to Create a tutorial repository if you would like to learn more about the GitHub desktop. To edit the files of the Ozeki repository, choose the Clone a repository from the internet option (Figure 7). It will open a new window where you need to copy the URL of the repository you wish to clone.

clone repository from internet
Figure 7 - Clone repository from Internet

Copy the URL of the code

Now you need to copy the URL of the repository you wish to make a clone of. To do so, please open GitHub in your browser and open the repository. To copy the URL you have two possible options. The first option is to search for the green Code button located above the list of files (Figure 8). Click it and look for the URL. If you have found it, click the copy icon on the right. The other method is simply copying the URL from the desktop. This will result in the same URL.

copy code url
Figure 8 - Copy code URL

Paste the URL code

Paste the URL into the clone repository form. Here you can set which repository to clone with the Repository URL textbox (Figure 9). In the Local path, you need to provide an access path, where a new folder will be created to store the files.

paste url and clone repository
Figure 9 - Paste URL and clone repository

Open the cloned folder

Open the folder you provided for the Clone the repository. To do so, copy the access path from the form before and past it into the File Explorers top bar (Figure 10). Hit enter and it will start loading the folder.

repository cloned
Figure 10 - Repository cloned

How to use the repository

In the final video, you will learn how to use the repository you just cloned to you computer. The video will start with the opened directory where the cloned files are located. It will end with the successfully launched SMS sending project. You will learn how to launch a project and how to check the log of it. The video is only 1:31 long and it features all the steps you need to take in a detailed format.

Start the Rest API solution

To launch the project where you could edit the code, look for the Ozeki.Libs.Rest.VB file. Open the file and it will launch Visual Studio. You can edit the code there to your likings.

open rest api solution
Figure 11 - Open Rest API solution

Start the Send SMS solution

Click the Send Sms button located on the top of the applications GUI (Figure 12).This will start the script and you can start sending SMS messages. In the code editor panel, you can make changes to the code to run it customized.

start send sms solution
Figure 12 - Start send SMS solution

Watch the response

Now you will get the response from the VB project. You will see the result of the SMS sending process, the recipients phone number and the body of the message. As you can see on Figure 13, you will se it printed on a console window.

message sent
Figure 13 - Message sent

SMS in the Sent folder

In case of a successful sending process, you can see the sent message in the Sent folder of the Ozeki SMS Gateway. To reach it, open the Ozeki SMS Gateway and search for the Sent folder under the users details panel on the left (Figure 14).

sms sent in sms gateway
Figure 14 - SMS Sent in SMS Gateway

Summary

This guide provided all the necessary information on how to download the latest VB SMS API library from GitHub. Having the most up-to-date SMS API library helps you to always use the API at its full potential with the latest updates.

To find out more about this technology, follow this guide which offers you even more valuable information. It is a good idea to visit the tutorial page about sending SMS with VB or sending scheduled SMS using VB. With the help of these solutions, you can start using the Ozeki SMS Gateway, which is a high-performance gateway software capable of sending up to 1000 SMS per second.

The next step is to download and install the Ozeki SMS Gateway, which should not take more than 10 minutes to do. Let's start the work now!

More information