webMethods CloudStreams Provider for Messagebird

This project provides a sample webMethods CloudStreams Provider Project for Messagebird. The following APIs are available:

Send SMS: Creates a new message object. MessageBird returns the created message object with each request. Per request, a max of 50 recipients can be entered. https://developers.messagebird.com/docs/messaging#messaging-send
View SMS: Retrieves the information of an existing message. This message can be a sent or a received message. You only need to supply the unique message id that was returned upon creation or receiving. https://developers.messagebird.com/docs/messaging#messaging-view
Send Voicemessage: Creates a new voice message object. MessageBird returns the created voice message object with each request. Per request, a max of 50 recipients can be entered. https://developers.messagebird.com/docs/voice#voicemessaging-send
View Voicemessage: Retrieves the information of an existing voice message. You only need to supply the unique voice message id that was returned upon creation. https://developers.messagebird.com/docs/voice#voicemessaging-view
Get Balance: Retrieves your MessageBird balance. https://developers.messagebird.com/docs/balance#balance-get

Requirements

The project was developed and tested on the following installation:

Integration Server 9.12
CloudStreams Server 9.12
Software AG Designer 9.12 with Service Development and CloudStreams Development

Quick start

To install the project on your local development environment follow these steps.

Prepare CloudStreams connection

In Software AG Designer open Window > Preferences.
Navigate to Software AG > CloudStreams Servers.
Add your local Integration Server. If there is already an entry make sure username and password are correct by clicking the Test button.

Import CloudStreams Provider Project

In Software AG Designer switch to the CloudStreams Development perspective.
Select File > Import and choose Software AG > CloudStreams Provider Project. Click Next.
Select the root of this repository as the Root Directory.
Select the Messagebird project.
Check Copy project into workspace.
Click Finish.
Expand the newly imported project.
Right-click com.softwareag.messagebird and select Deploy.

Import Integration Server packages

The CloudStreams Provider Project does not contain neccessary doctypes.

Copy Messagebird.zip and MessagebirdTests.zip to <install_dir>/IntegrationServer/instances/<instance>/replicate/inbound.
Open Integration Server Administration in your browser.
Install both packages with Install Inbound Releases in Package Management.

Add Messagebird Accesskey and activate connection

To access Messagebird an Accesskey is neccessary. Generate your Messagebird Trial account here: https://www.messagebird.com.

Open Integration Server Administration in your browser.
Navigate to Solutions > CloudStreams > Providers > Messagebird.
Select com.softwareag.messagebird from the Connector List.

You will find one (disabled) connection: wmmessagebirdTests:connection. You need to modify this connections:

Click the Edit button of the connection.
Enter your Accesskey and save the changes. Note: The Accesskey field needs the following content: "AccessKey [live|test]_[apikey]"
Enable the connection.

Run tests

In Software AG Designer switch to the Service Development perspective.
Expand the MessagebirdTests package.
Run the *Test flow services you find in the subsequent directories.

These tools are provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.

SoftwareAG/webmethods-cloudstreams-messagebird