Back

This article describes how to set up the Mocean connector in your Universal Data Hub account.

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Send SMS

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

  • API Key: Your account API key. For more information, see: Mocean Authentication
  • API Secret: Your account API secret.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Send SMS

Parameters

Parameter Description
From
  • SMS Sender ID (also referred as to SMS Sender Name) is the information that is displayed to the recipient as the sender of the SMS when a message is received at a mobile device.
  • For more information, see: https://moceanapi.com/docs/?shell#sms-api
To
  • Telephone number of the receiver.
  • To send to multiple receivers, separate each entry with white space (‘ ’) or comma (,).
  • Telephone number must include country code, for example, a Malaysian phone number would be 60123456789.
Text
  • Contents of the message.
  • If you are sending binary content, this will be a hex string.
User Data Header
  • User Data Header part of the message. For example, 0605040B8423F0.
Coding
  • Sets the coding scheme bits in DCS field.
  • Accepts the following values:
    • 1 for 7-bit
    • 2 for 8-bit
    • 3 for UCS2
  •  
  • If unset, the value defaults to 7 bits unless a mocean-udh is defined, which sets coding to 8 bits.
  • If the charset is not set or is not set to UTF-8 when non-GSM character is detected, coding will set to UCS2.
Delivery Report
  • Request for delivery reports with the state of the sent message.
  • To enable delivery reports, set this value to ‘ 1’.
  • If this field is not specified, the default value will be ‘ 0’ and no DLR will be returned.
Delivery Report URL
  • URL to receive delivery reports.
  • Required if DLR is requested.
Schedule
  • When this field is used, the message is sent out on the specified date time (on best effort basis due to large number of SMS is queued for scheduling).
  • The format of the date time is YYYY-MM-DD hh:mm:ss in 24-hours format.
    Example:  2007-02-11 23:30:00
  • The wrong date format will cause the gateway to reject the request.

    Use Malaysia time (or GMT +8:00) while making scheduled SMS request.

Charset
  • Indicates the character set used in the Text parameter.
  • Supported character sets are:
    • ISO-8859-1
    • ISO-8859-7
    • UTF-8
    • Windows-1252
Validity
  • Defines the validity period of message.
  • User has to input validity in terms of seconds.
  • For example, if user wants a message to expire after 5 minutes upon submission, user has to configure validity value as 300 (seconds).