---
title: "Sends a text message to a list of recipients"
method: POST
path: "/converged/text"
tags: ["messaging"]
---

# Sends a text message to a list of recipients

`POST /converged/text`

## Request body

- TextMessageSendRequest
  - `recipientAddressList` integer[], 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.
  - `senderAddress` string — _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).
  - `notificationCallbackUrl` string — _Optional._ When setting a notificationCallbackUrl all delivery reports are forwarded to this URL.
  - `clientMessageId` string — _Optional._ May contain a freely definable message id.
  - `priority` integer — _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.
  - `test` boolean — _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.
  - `validityPeriode` integer — _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.
  - `sendAsFlashSms` boolean — _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
  - `messageContent` string, required — `UTF-8` encoded message content
  - `maxSmsPerMessage` integer — _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.
  - `pushParameters` object
  - `additionalPushParameters` object

## Response `200`

successful operation

## Other responses

- `2000` — OK - Accepted. The request has been accepted by the network operator.
- `2001` — OK - Queued. Request with multiple recipients has been queued for immediate delivery.
- `4001` — ERR - Invalid Credentials. Inactive account or customer.
- `4002` — ERR - Invalid Recipients. One or more recipients are not in the correct format or contain invalid msisdns (i.e: 436761234567).
- `4003` — ERR - Invalid Sender. Sender address or type is invalid.
- `4008` — ERR - Invalid clientMessageId.
- `4009` — ERR - Message text (messageContent) is invalid
- `4013` — ERR - Message limit is reached.
- `4014` — ERR - Sender IP address is not authorized.
- `4015` — ERR - Invalid message priority.
- `4016` — ERR - Invalid COD ReturnAddress (notificationCallbackUrl)
- `4019` — ERR - A required parameter was not given. The parameter name is shown in the statusMessage
- `4021` — ERR - Invalid account.
- `4022` — ERR - Access to the API was denied.
- `4023` — ERR - Request limit exceeded for this IP address
- `4025` — ERR - Recipients amount over limit. A maximum of 50 recipients per message is allowed in a single request
- `4026` — ERR - MaxSmsPerMessage exceeded. SMS amount limit per message was hit.
- `4040` — ERR - Invalid contentCategory.
- `4041` — ERR - Invalid validityPeriode. A minimum of 60 seconds is allowed
- `5000` — ERR - Internal error. Please contact support.
- `5003` — ERR - The service is currently not available

---

[API](https://skmtc.dev/linkmobility/apis/untitled-api.md) · [All operations](https://skmtc.dev/linkmobility/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/linkmobility/untitled-api/revisions/db84f79799b9/schema)