Web Services .NET Wrapper Overview

Introduction

Aculab Cloud provides a number of Web Services that implement features such as initiating outbound services, managing files, sending SMS messages and managing telephone numbers and other resources on the cloud.

You can make requests to these web services directly or use this high-level language wrapper.

The Wrapper Library

The wrapper is supplied as a .Net class library Aculab.Cloud.WebServiceWrappers. It is available from nuget.

The PlatformAccount class identifies the cloud and user account on which the web service is to be called.
For each Web Service suite a set of classes exists that wraps the web service requests and unwraps the JSON format responses.

The main wrapper classes available on Aculab Cloud are:

• OutboundServiceWebService - invokes outbound services that start UAS applications
• OutboundRESTAPIService - invokes outbound services that start REST API applications
• ApplicationStatusWebService - retrieves the status of one or more application instances
• ConferenceManager - manages conference reservations and configures active conferences using ConferenceWebService
• FileWebService - manages media files played and recorded on calls, files sent and received on messages and REST API log files on the cloud media store
• TelephoneNumberPurchaseWebService - purchases inbound telephone number for use with Aculab Cloud
• ReportsWebService - requests and downloads detailed application, call or error reports
• MessageWebService - sends and receiveds SMS and MMS messages, keeps track of their progress and identifies blocked numbers
• MonitorWebService - accesses monitor recording media files
• NumberLookupWebService - lookup details of a telephone number
• RESTInterruptWebService - interrupts a REST API application
• SecurityWebService - accesses security facilities
• ServicesWebService - accesses service management facilities
• VoiceBiometricsUserWebService - register a user for voice verification using biometric analysis
• WebRTCClientWebService - generate WebRTC client token and list registered WebRTC clients

Samples

A number of C# samples that illustrate how to use the various wrapper classes are available for download from Web Services.

Please note that in the interests of clarity these samples are short on the kind of error handling and diagnostic aspects that would typically be required in a live environment.

How to Build and Run Them

These samples can be built using Visual Studio 2017 or later, depending on which version of .Net you require (versions up to and including .Net 6.0 are supported).
The Wrapper Library reference is downloaded automatically via NuGet.

The project files target multiple versions of .Net Framework and .Net Core.
To build for a single target, edit the project file and change <TargetFrameworks> to <TargetFramework> and select a single target.

The samples are console applications that require command line parameters to be supplied.