SerwerSMS allows sending and receiving SMS messages. Our platform has the function of both single and mass SMS sending. Sending messages has never been so easy, fast and effective.
Status: Preview |
Tier: Premium |
Version: 2.0 |
Name |
Summary |
Add to blacklist |
|
Add a new contact |
|
Get groups |
|
Get senders |
|
Send SMS message |
Name |
Summary |
When new SMS message is received |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Add to blacklist
Description: This operation add phone number to blacklist
Syntax:
SerwerSMS.add_blacklist (add_blacklistParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Summary: Add a new contact
Description: This operation add contact to customer account
Syntax:
SerwerSMS.add_contact (add_contactParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:add_contactResponse
Summary: Get groups
Description: This operation retrieves contact groups
Syntax:
SerwerSMS.get_group ()
Returns:
Type:array of (get_groupResponseItem)
Summary: Get senders
Description: This operation retrieves sender's name which can be used for sending SMS
Syntax:
SerwerSMS.get_sender ()
Returns:
Type:array of (get_senderResponseItem)
Summary: Send SMS message
Description: This operation send SMS messages
Syntax:
SerwerSMS.send_sms (send_smsParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:send_smsResponse
Summary: When new SMS message is received
Description: This operation triggers when a new message is received
Syntax:
SerwerSMS.new_answer (new_answerParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:new_answerResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
phone |
string
|
Specify the phone number you want to add to the blacklist |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32)
|
id |
success |
boolean
|
success |
Summary:
Description:
Properties:
Name |
Type |
Summary |
address |
string
|
Specify the address of contact |
city |
string
|
Specify the city of contact |
company |
string
|
Specify the company of contact |
description |
string
|
Specify the description of contact |
|
string
|
Specify the email of contact |
first_name |
string
|
Specify the first name of contact |
group_id |
string
|
Specify the group name of contact |
last_name |
string
|
Specify the last name of contact |
phone |
string
|
Specify the phone number of contact |
tax_id |
string
|
Specify the VAT number of contact |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32)
|
id |
success |
boolean
|
success |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32)
|
id |
title |
string
|
title |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
id |
title |
string
|
title |
Summary:
Description:
Properties:
Name |
Type |
Summary |
type |
string
|
Specify the type of message received Values: [ECO, ND, NDI, MMS, 2WAY] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
items |
array of (ItemsItem)
|
items |
Summary:
Description:
Properties:
Name |
Type |
Summary |
blacklist |
boolean
|
blacklist |
id |
integer(int32)
|
id |
message_id |
string
|
message_id |
phone |
string
|
phone |
recived |
string
|
recived |
text |
string
|
text |
type |
string
|
type |
Summary:
Description:
Properties:
Name |
Type |
Summary |
group_id |
string
|
Specify the name of the group of recipients |
message |
string
|
Specify the message of the SMS |
phone |
string
|
Specify the recipient's phone number |
sender |
string
|
Specify the sender name (only for FULL SMS) |
utf |
boolean
|
Select the option to enable sending special characters like cyrylica etc. Values: [, ] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
queued |
integer(int32)
|
queued |
success |
boolean
|
success |
unsent |
integer(int32)
|
unsent |