Connectors Reference
Sms77.io offers you the possibility to send SMS, text2voice messages, perform home register lookups, mobile number portability status lookups, phone number formats and much more.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Get Balance |
|
|
Lookup HLR, CNAM, MNP or Format |
|
|
Get Pricing |
|
|
Send Sms |
|
|
Get SMS Status |
|
|
Validate Caller ID for Voice |
|
|
Voice (string to, string text, [Optional]number xml, [Optional]string from) |
Send Text2Speech Voice Call |
|
Name |
Summary |
|
Name |
Summary |
Summary: Get Balance
Description: Retrieves the account balance for given API key
Syntax:
sms77io.Balance ()
Returns:
Summary: Lookup HLR, CNAM, MNP or Format
Description: Retrieves CNAM, MNP, HLR or number format info
Syntax:
sms77io.Lookup (string type, string number, [Optional]string json)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
type |
string (Lookup Type)Values: [cnam, format, hlr, mnp] |
The type of lookup to perform |
True |
|
|
number |
string (Number) |
The phone number to look up |
True |
|
|
json |
string (JSON) |
Determines whether the response shall be returned in JSON format. Works only if "type" is set to "mnp". |
False |
Returns:
Summary: Get Pricing
Description: Retrieves pricing information for a single country or all
Syntax:
sms77io.Pricing ([Optional]string country, [Optional]string format)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
country |
string (Country Restriction) |
The countries ISO code to get pricing for. Example values are "de" for Germany or "fr" for France. Omit to show pricing for all channels. |
False |
|
|
format |
string (Response Format)Values: [json, csv] |
Determines the response format. Allowed values are json and csv. The default value is json. |
False |
Returns:
Summary: Send Sms
Description: Sends one or multiple SMS to one or multiple recipients
Syntax:
sms77io.Sms (string text, string to, [Optional]string from, [Optional]string foreign_id, [Optional]string label, [Optional]string udh, [Optional]string delay, [Optional]number debug, [Optional]number no_reload, [Optional]number unicode, [Optional]number flash, [Optional]number utf8, [Optional]number details, [Optional]number return_msg_id, [Optional]number json, [Optional]number performance_tracking)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
text |
string (Message Content) |
The actual text message to send |
True |
|
|
to |
string (Recipient(s)) |
The recipient number(s) or contact name(s) - separate multiple recipients by comma |
True |
|
|
from |
string (Sender Identifier) |
A custom sender name. A maximum of 11 alphanumeric or 16 numeric characters. |
False |
|
|
foreign_id |
string (Foreign ID) |
Identifer to return in callbacks for status reports etc. Allowed characters: a-z, A-Z, 0-9, .-_@ |
False |
|
|
label |
string (Label) |
A custom label for your own usage |
False |
|
|
udh |
string (User Data Header) |
A custom user data deader - if set and message contains hex code, the message gets sent as 8-bit binary |
False |
|
|
delay |
string (Delay) |
Date/Time for delayed dispatch - expects a timestamp "1141511104" or date time "2016-03-04 23:25:04" |
False |
|
|
debug |
number (Debug)Values: [, ] |
Disable actual message sending |
False |
|
|
no_reload |
number (No Reload)Values: [, ] |
Enable sending of duplicated messages within 180 seconds |
False |
|
|
unicode |
number (Unicode)Values: [, ] |
Force Unicode encoding - reduces SMS length to 70 characters |
False |
|
|
flash |
number (Flash)Values: [, ] |
Send as flash SMS which appears directly on the recipients screen |
False |
|
|
utf8 |
number (UTF-8)Values: [, ] |
Force UTF-8 encoding regardless of server detection |
False |
|
|
details |
number (Details)Values: [, ] |
Attach message details to response |
False |
|
|
return_msg_id |
number (Return Message ID)Values: [, ] |
Attach message ID to second row in the response |
False |
|
|
json |
number (JSON)Values: [, ] |
Return a detailed JSON response |
False |
|
|
performance_tracking |
number (Performance Tracking)Values: [, ] |
Enable performance tracking for found URLs |
False |
Returns:
Summary: Get SMS Status
Description: Retrieves dispatch status for a given SMS ID
Syntax:
sms77io.Status (string msg_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
msg_id |
string (Message ID) |
The ID from the SMS to check |
True |
Returns:
Summary: Validate Caller ID for Voice
Description: Validates the given phone number for the use of voice API
Syntax:
sms77io.ValidateForVoice (string number, [Optional]string callback)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
number |
string (Number) |
The number to validate for usage with the Voice API |
True |
|
|
callback |
string(uri) (Callback) |
The optional callback URL to query right after validation |
False |
Returns:
Summary: Send Text2Speech Voice Call
Description: Sends a text2voice message to a given recipient number
Syntax:
sms77io.Voice (string to, string text, [Optional]number xml, [Optional]string from)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
to |
string (Recipient) |
The message receiver - must be a valid phone number or contact from the address book |
True |
|
|
text |
string (Text) |
The text to convert to a voice message. Accepts valid XML too. |
True |
|
|
xml |
number (XML)Values: [, ] |
Decides whether the parameter "text" is plain text or XML. The default value is 0. |
False |
|
|
from |
string (From) |
Sets the sender - must be a verified sender - use an inbound number of yours or one of ours. |
False |
Returns: