Sending text, flash and binary messages
Base URL
The Nvia Platform allows messages to be sent using both the HTTP GET and the HTTP Post interfaces.
The base URL to which partners must request the sending of an SMS is:
Parameters
To send the SMS, partners must use the following parameters in the base URL:
user
User identifier within the Nvia Platform (contact e-mail).
Yes
apiKey
User generates the apiKey at the sms.nvia.com panel.
Yes
to
Phone number to where the SMS will be delivered. The number must be in international format and URL encoded (for instance: +1 222 333 444 will be URL encoded as %2B1222333444).
Yes
message
Content of the message to be delivered to the handset. The content must be URL encoded.
Yes
senderId
Sender of the message.
No
transactionId
User can specify a transaction id; if not, we generate one.
No
confirmation
Used if the user desires a delivery report with the status of the SMS. Can be set to true or false.
No
udh
User Data Header (UDH) is a binary structure which may be present at the start of a short message in the Short Message Service in GSM. It does not contain any text, but it specifies how the message should be formatted and processed.
No
dcs
Data coding scheme of the message. Allowed any value in the SMPP 3.4 standard. The supported values are:
0 (Default Encoding – ISO-8859-1 Latin1 Encoding)
1 (GSM7 Encoding)
2 (Binary SMS)
3 (ISO-8859-1 Latin1 Encoding)
4 (Binary SMS)
8 (UCS2 Encoding)
Do note that not all operators accept all forms of encoding. Contact your account manager for more information.
No
validityPeriod
Validity period can be set in a relative and an absolute format. Please check the section dedicated to datetime formats for more information. Please note that not all operators support validity period. Contact your account manager for more information.
No
scheduledDeliveryTime
Scheduled delivery time can be sent in a relative and an absolute format. Please check the section dedicated to datetime formats for more info.
No
responseType
The supported values are:
json
xml (webservices)
No
callbackUrl
URL where the user wants to receive the status of the DLR
No
Examples of the responseType parameter:
For responseType=json:
For responseType=xml:
Outputs
If the user’s petition is correct and responseType is left blank, the Nvia SMSC will answer in plain text the following:
Where transactionId is the identifier of the message in the system. This value can be used by the sender to match the SMS with the delivery report.
If the user’s petition is incorrect, the Nvia SMSC will answer in plain text the following:
Where <ID> is the numeric identifier of the error. Details regarding the error codes can be found at
Last updated