Sign in
messaging

Sends a text message to a list of recipients

post/converged/text

Request body

recipientAddressListinteger[] required

List of recipients (E164 formatted MSISDNs - see Wikipedia en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The list of recipients may contain a maximum of 1000 entries.

senderAddressstring

Optional. Address of the sender (assigned to the account) from which the message is sent.

senderAddressType'national' | 'international' | 'alphanumeric' | 'shortcode'

Optional. The sender address type. The following address types are supported: national, international, alphanumeric or shortcode).

contentCategory'informational' | 'advertisement'

Optional. The content category that is used to categorize the message (used for blacklisting). The following content categories are supported: informational or advertisement. If no content category is provided, the default setting is used (may be changed inside the onlinesms web interface).

notificationCallbackUrlstring

Optional. When setting a notificationCallbackUrl all delivery reports are forwarded to this URL.

clientMessageIdstring

Optional. May contain a freely definable message id.

priorityinteger

Optional. Priority of the message. Must not exceed the value configured for the account used to send the message. For more information please contact our customer service.

testboolean

Optional. true: The transmission is only simulated, no SMS is sent. Depending on the number of recipients the status code 2000 or 2001 is returned. false (default): No simulation is done. The SMS is sent via the SMS Gateway.

validityPeriodeinteger

Optional. Specifies the validity periode (in seconds) in which the message is tried to be delivered to the recipient. A minimum of 1 minute and a maximum of 3 days are allowed.

sendAsFlashSmsboolean

Optional. true: The message is sent as flash SMS (displayed directly on the screen of the mobile phone). false (default): The message is sent as standard text SMS

messageContentstring required

UTF-8 encoded message content

maxSmsPerMessageinteger

Optional. Specifies the maximum number of SMS to be generated. If the system generates more than this number of SMS, the status code 4026 is returned. The default value of this parameter is 0.If set to 0, no limitation is applied.

messageType'default' | 'voice'

Optional. Specifies the message type. Allowed values are default and voice. When using the message type default, the outgoing message type is determined based on account settings. Using the message type voice triggers a voice call.

pushParametersobject
additionalPushParametersobject

Example request

{
  "senderAddress": "4369912345678",
  "senderAddressType": "international",
  "contentCategory": "informational",
  "notificationCallbackUrl": "https://user:pass@myservice.com/myservice/",
  "clientMessageId": "myUniqueId",
  "priority": 5,
  "validityPeriode": 300,
  "messageContent": "example message content",
  "maxSmsPerMessage": 1,
  "messageType": "default"
}

Response

successful operation

Changes

No recorded changes to this endpoint across all 1 revision of this API.