Mocean
The Mocean modules enable you to send text messages, voice messages and get balance details in your Mocean account.
Getting Started with Mocean
Prerequisites
- A Mocean account
In order to use Mocean with Boost.space Integrator, it is necessary to have a Mocean account. If you do not have one, you can create a Mocean account at moceanapi.com/.
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory!
Connecting Mocean to Boost.space Integrator
To connect your Mocean account to Boost.space Integrator you need to obtain your Application Name and API Key from your Mocean account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Log in to your Mocean account.
2. In the Dashboard screen, copy the API Key and Secret Token to your clipboard.
3. Go to Boost.space Integrator and open the Mocean’s module _Create a connection_dialog.
5. In the Connection name field, enter a connection name.
6. In the API Key and API Secret fields, enter the API key and secret token copied in step 2 respectively.
7. Click Continue.
The connection has been established.
Actions
Send a Text Message
Sends SMS to the selected number.
Connection
Establish a connection to your Mocean account.
Sender
Enter the sender’s name that appears to the receiver when they receive the message.
Receiver
Enter the phone number of the receiver to whom you want to the text message. You can add multiple phone numbers separated by a comma.
Message
Enter the message content.
Send a Voice Message
Converts text to voice and send it to the selected receiver.
Connection
Establish a connection to your Mocean account.
Receiver
Enter the recipient’s number to whom you are sending the voice message.
Message
Enter the voice-message content.
Language
Select the language in which you want to send the voice message.
Get a Balance
Checks your account credit balance.
Connection
Establish a connection to your Mocean account.
Make an API Call
Performs an arbitrary authorized API call.
Connection
Establish a connection to your Mocean account.
URL
Enter a path relative to https://rest.moceanapi.com/rest. For example, /account/balance
For the list of available endpoints, refer to the Mocean API Documentation.
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry**.**
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use – Get Account Balance
The following API call returns the account balance from your Mocean account:
URL: /account/balance
Method: GET
The result can be found in the module’s Output under Bundle > Body. In our example, the account balance of the current user is returned:
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/communication/mocean/).
