Connectors Reference
Connect to your Sendmode Business Messaging account and Send SMS messages instantly to any country.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Send_SMS ([Optional]string Content-Type, Send_SMSParameterMessage message) |
Send SMS |
|
Optout_Customer (string Content-Type, Optout_CustomerParameterMessage message) |
Optout Customer |
|
Import_Customer ([Optional]string Content-Type, Import_CustomerParameterImportdata importdata) |
Import Customer |
|
Check Credits |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Send SMS
Description: Send an SMS to one or more recipients.
Syntax:
Sendmode.Send_SMS ([Optional]string Content-Type, Send_SMSParameterMessage message)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Header Content Type) |
Sendmode requires content type set to application json. |
False |
|
|
message |
|
|
True |
Returns:
Type:Send_SMSResponse
Summary: Optout Customer
Description: Optout Customer number from database.
Syntax:
Sendmode.Optout_Customer (string Content-Type, Optout_CustomerParameterMessage message)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Header Content Type) |
Sendmode requires content type set to application json. |
True |
|
|
message |
Optout_CustomerParameterMessage
|
|
True |
Returns:
Summary: Import Customer
Description: Import your customer details into your SendMode account.
Syntax:
Sendmode.Import_Customer ([Optional]string Content-Type, Import_CustomerParameterImportdata importdata)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Header Content Type) |
Sendmode requires content type set to application json. |
False |
|
|
importdata |
Import_CustomerParameterImportdata
|
|
True |
Returns:
Summary: Check Credits
Description: Check your SendMode credits balance.
Syntax:
Sendmode.Check_Credits ([Optional]string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Header Content Type) |
Sendmode requires content type set to application json. |
False |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Command Status |
|
statusCode |
integer(int32)
|
Command Status Code |
|
balance |
number(float)
|
Credit Balance |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
group |
string
|
Group to add the customer into. |
|
mobilenumber |
string
|
The customers mobile number. |
|
firstname |
string
|
The customers first name. |
|
surname |
string
|
The customers surname. |
|
address |
string
|
The customers address. |
|
town |
string
|
The customers address town. |
|
county |
string
|
The customers address county. |
|
|
string
|
The customers email address. |
|
custom1 |
string
|
The customers custom1 field. |
|
custom2 |
string
|
The customers custom2 field. |
|
businessname |
string
|
The customers business name. |
|
dateofbirth |
string
|
The customers date of birth in format dd/mm/yyyy |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Command Status |
|
statusCode |
integer(int32)
|
Command Status Code |
|
acceptedDateTime |
string
|
DateTime the Import request was accepted by Sendmdoe API. |
|
group |
string
|
Group to add the customer into. |
|
importdata |
|
importdata |
Summary:
Description: importdata
Properties:
|
Name |
Type |
Summary |
|
mobilenumber |
string
|
mobilenumber |
|
firstname |
string
|
firstname |
|
surname |
string
|
surname |
|
address |
string
|
address |
|
town |
string
|
town |
|
county |
string
|
county |
|
|
string
|
|
|
custom1 |
string
|
custom1 |
|
custom2 |
string
|
custom2 |
|
businessname |
string
|
businessname |
|
dateofbirth |
string
|
dateofbirth |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
mobilenumber |
string
|
Mobile numberof person Opting Out. |
|
optoutresponse |
string
|
Reposonse submitted by person when opting out. |
|
returnedresponse |
string
|
Used when forwarding a custom response to an Optout to downstream applications. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Command Status |
|
statusCode |
integer(int32)
|
Command Status Code |
|
acceptedDateTime |
string
|
DateTime optout request was accepted by Sendmode API |
|
mobilenumber |
string
|
mobilenumber |
|
optoutreason |
string
|
Reason given for OptingOut |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
senderid |
string
|
The sender id displayed on the recipients device. |
|
messagetext |
string
|
The content of the SMS message. |
|
customerid |
string
|
A reference id for your message. |
|
recipients |
array of (string)
|
recipients |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Command Status |
|
statusCode |
integer(int32)
|
Command Status Code |
|
acceptedDateTime |
string
|
DateTime message was accepted by Sendmode API. |
|
message |
|
message |
Summary:
Description: message
Properties:
|
Name |
Type |
Summary |
|
senderid |
string
|
The sender id displayed on the recipients device. |
|
messagetext |
string
|
The content of the SMS message. |
|
customerid |
string
|
A reference id for your message. |
|
scheduledate |
string
|
scheduledate |
|
recipients |
array of (string)
|
recipients |