Definitions
JobReport
Name | Description | string |
---|---|---|
billcode | Required | string |
customerRef | Required | string |
encoding | Required | string |
finishedTs | Timestamp which indicates when the job received its final status (in accordance with ISO-8601). Example | string (date-time) |
flash | Required | boolean |
jobId | Required | string |
qos | Required
| string |
receiptTs | Required Example | string (date-time) |
recipientIds | Required | < string > array |
src | Required | string |
statusRequested | Required | boolean |
validityMin | Required | integer (int64) |
JobRequest
Name | Description | Schema |
---|---|---|
messages | SMS messages with different texts and recipients. A minimum of one message must be specified in the list. Requests which result in more than 3.000 SMS (based on several messages or recipients) will be rejected. | <Message> array |
options |
JobResponse
Name | Schema |
---|---|
jobId | string |
Message
Name | Schema |
---|---|
recipients | <Recipient> array |
text | string |
Options
Global job options.
Name | Description | Schema |
---|---|---|
billcode | Optional billing information can be entered here. Max. 70 characters | string |
blackoutPeriods |
Examples
| < string > array |
customerRef | Optional reference information that will be included in getJobReport. Max. 70 characters (192 for US-ASCII encoding). | string |
duplicateDetection |
| boolean |
encoding | The preferred encoding of an SMS. Potential values:
When STANDARD is selected, the Webservice checks SMS messages for invalid characters. The selection of encoding impacts the maximum length of the SMS. Important information regarding SMS coding using GSM-7 (standard):
SMS encoding with UTF-16
In some countries, an SMS will not reach the recipient if it | string |
flash | You can set here whether you want the SMS sent as a Flash SMS, which is sent directly to the recipient’s mobile phone display without the recipient explicitly having to open it. An additional fee is required. The Flash SMS option is not supported in all countries. | boolean |
invalidCharacters | Defines how invalid characters in SMS text will be handled.
| string |
jobPeriod |
Examples
| string (date-time) |
maxParts | Sets the maximum amount of SMS in a multi-part (concatenated) SMS. If the SMS message is longer, it is truncated. Permitted values: from 1 to 20. If the specified value is outside of the range of permitted values, either the minimum or maximum value will automatically be selected. The actual length of an SMS is dependent on the selected encoding (see encoding earlier in this section for additional information). Multi-part SMS are not supported in CDMA | integer (int32) |
qos | Sets the priority of an SMS job. If you have time-critical SMS messages, we recommend that you select the express option. Supported values are:
An additional fee is required to send an express | string |
src | The Sender ID displayed to recipient. When entering the Sender ID, note the following technical restrictions:
No other characters are permitted. Java Regular Expressions p{Punct} stands for the following: !"#$%&'()*+,- ./:;<=>?@[\]^_{|}~. | string |
statusRequested | Requests a delivery notification. An additional fee is required for this option. | boolean |
validityMin | Expresses the validity of an SMS in minutes and thus the length of the delivery attempt when an SMS cannot instantly be delivered after being sent (e.g., if the recipient’s mobile phone is shut off). Supported values are between 5 and 2880 minutes. If the specified value is outside of the range of permitted values, either the minimum or maximum value will automatically be selected. | integer (int64) |
Recipient
Name | Description | Schema |
---|---|---|
blackoutPeriods |
| < string > array |
customerRef | Discretionary reference information. If no value is specified, the recipient mobile phone number specified in the dst field will be applied. This information is included in the status report. Max. 70 characters. | string |
dst | Recipient’s mobile phone number. If a number is specified without a country code, the value specified in the Country code parameter will automatically be applied. | string |
RecipientReport
Name | Description | Schema |
---|---|---|
customerRef | Discretionary reference information. Set during transmission. This information is included in the status report. Max. 64 characters. | string |
dst | Recipient’s mobile phone number. Set during transmission. | string |
finishedTs | Timestamp which indicates when the SMS received its final status (in accordance with ISO-8601). Example | string (date-time) |
processStatus | Current status of the process (see SMS outbound status codes - REST). | string |
reason | Explanation of the status. | string |
sentTs | Timestamp which indicates when the SMS was sent (in accordance with ISO-8601). Example | string (date-time) |
smsId | Recipient ID | string |
status | Status (see SMS outbound status codes - REST). | string |
VersionInfoResponse
Name | Description | Schema |
---|---|---|
buildNumber | Revision number. | integer (int32) |
buildTimestamp | Date created. | string |
majorVersion | First component of the version number. | integer (int32) |
message | Additional information about the current version. | string |
minorVersion | Second component of the version number. | integer (int32) |
versionInfo | Additional information about the REST interface. | string |