This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
The following commit(s) were added to refs/heads/main by this push:
new 4929e4a8a chore: the SMPP Kamelets can set delivery receipts, number
types, UCS-2 text and the enquire_link interval (#3170) (#3224)
4929e4a8a is described below
commit 4929e4a8a70ea6f6008664d94d974b88ddd2bb71
Author: Claus Ibsen <[email protected]>
AuthorDate: Wed Nov 18 22:34:26 2026 +0100
chore: the SMPP Kamelets can set delivery receipts, number types, UCS-2
text and the enquire_link interval (#3170) (#3224)
The SMPP sink always asked for a delivery receipt, always sent the
numbers with an unknown type and numbering plan, and encoded the text
with ISO-8859-1, so text in Cyrillic, Greek or emoji arrived as "?".
Both Kamelets checked the connection only once a minute.
smpp-sink now takes, all optional and without a default:
- registeredDelivery (0, 1 or 2), which receipts to ask for
- sourceAddrTon, sourceAddrNpi, destAddrTon and destAddrNpi, the type
of number and numbering plan of the sender and the recipient. The
NPI enum lists the values jSMPP accepts (0, 1, 3, 4, 6, 8, 9, 10, 14,
18); 2 fails every message
- dataCoding (0 to 127) and alphabet (0, 4 or 8); both set to 8 send
UCS-2 text in any language
- enquireLinkTimer
smpp-source takes enquireLinkTimer. systemType, sourceAddr and destAddr
were already there.
With none of the options set, the endpoint URIs are the same as on
main, checked with camel get endpoint. The descriptions now say how
long one SMS is (160 characters, or 70 with UCS-2) instead of 140
bytes, and the source says how a receipt matches the SMS it is for.
Verified with Camel JBang against SMPPSim (jookies/smppsim), from its
decoded PDU log: each option in the submit_sm or in the enquire_link
timing, the delivery receipt reaching smpp-source, and UCS-2 text
arriving intact through loopback.
Co-authored-by: Claude Opus 5.5 <[email protected]>
---
.../ROOT/partials/smpp-sink-description.adoc | 72 ++++++++++++++++++++++
.../ROOT/partials/smpp-source-description.adoc | 31 ++++++++++
kamelets/smpp-sink.kamelet.yaml | 63 ++++++++++++++++++-
kamelets/smpp-source.kamelet.yaml | 9 ++-
.../main/resources/META-INF/kamelets-index.json | 4 +-
.../main/resources/kamelets/smpp-sink.kamelet.yaml | 63 ++++++++++++++++++-
.../resources/kamelets/smpp-source.kamelet.yaml | 9 ++-
7 files changed, 241 insertions(+), 10 deletions(-)
diff --git a/docs/modules/ROOT/partials/smpp-sink-description.adoc
b/docs/modules/ROOT/partials/smpp-sink-description.adoc
index 2673d1743..1007e510e 100644
--- a/docs/modules/ROOT/partials/smpp-sink-description.adoc
+++ b/docs/modules/ROOT/partials/smpp-sink-description.adoc
@@ -5,9 +5,81 @@
The message body is sent as the short message text. The recipient is the
`CamelSmppDestAddr` header when it is
set, and the `destAddr` option otherwise.
+=== Delivery Receipts
+
+The Kamelet asks the SMSC for a delivery receipt of each SMS. The SMSC sends
the receipts to a receiver logged in to
+it, such as `smpp-source`, not to this Kamelet. `registeredDelivery` says
which receipts to ask for:
+
+[width="100%",cols="1,4",options="header"]
+|===
+| `registeredDelivery` | Receipts
+| not set, or `1` | A receipt whether the SMS reached the phone or not
+| `2` | A receipt only when the SMS failed
+| `0` | No receipt
+|===
+
+=== Sender and Recipient Numbers
+
+The type of number (TON) and the numbering plan (NPI) tell the SMSC how to
read `sourceAddr` and the recipient
+address. When they are not set, both are `0` (unknown), and the SMSC guesses.
Common settings:
+
+[width="100%",cols="2,1,1,3",options="header"]
+|===
+| Address | TON | NPI | Example
+| A phone number with its country code | `1` | `1` | `4598765432`
+| A name as the sender | `5` | `0` | `MyShop`
+|===
+
+Set them with `sourceAddrTon` and `sourceAddrNpi` for the sender, and
`destAddrTon` and `destAddrNpi` for the
+recipient. Ask your SMS provider which values it expects.
+
+=== Text in Any Language
+
+The text is encoded with `encoding`, ISO-8859-1 by default, so characters it
cannot hold, such as Cyrillic, Greek or
+emoji, are sent as `?`. To send text in any language, set both `alphabet` and
`dataCoding` to `8` (UCS-2): `alphabet`
+encodes the text as UCS-2, and `dataCoding` marks the SMS as UCS-2 so that the
phone can read it. One SMS then holds 70
+characters instead of 160.
+
+To send binary data, such as a body of bytes, set both `alphabet` and
`dataCoding` to `4`: the bytes are sent as they
+are.
+
=== Connection
The Kamelet binds to the SMSC when the integration starts, so an unreachable
SMSC makes the
integration fail to start, rather than failing each message.
+Every `enquireLinkTimer` milliseconds, one minute by default, the Kamelet
checks that the connection is alive. A lower
+value finds a lost connection sooner.
+
Set `usingSSL` to secure the connection with TLS, where the SMSC supports it.
+
+=== Example with Delivery Receipts and Unicode Text
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:timer-source"
+ parameters:
+ message: "Ihr Paket ist unterwegs. Ваша посылка в пути."
+ period: 3600000
+ steps:
+ - to:
+ uri: "kamelet:smpp-sink"
+ parameters:
+ host: "smsc.example.com"
+ systemId: "myaccount"
+ password: "{{smpp.password}}"
+ sourceAddr: "MyShop"
+ sourceAddrTon: 5
+ sourceAddrNpi: 0
+ destAddr: "4598765432"
+ destAddrTon: 1
+ destAddrNpi: 1
+ registeredDelivery: 1
+ alphabet: 8
+ dataCoding: 8
+ enquireLinkTimer: 30000
+----
+
+The delivery receipts of these SMS arrive at an `smpp-source` logged in to the
same SMSC.
diff --git a/docs/modules/ROOT/partials/smpp-source-description.adoc
b/docs/modules/ROOT/partials/smpp-source-description.adoc
index e99ce66fc..1f6609760 100644
--- a/docs/modules/ROOT/partials/smpp-source-description.adoc
+++ b/docs/modules/ROOT/partials/smpp-source-description.adoc
@@ -6,7 +6,38 @@ The short message text is emitted as the message body. Details
of the received P
the `CamelSmpp*` headers the component sets, such as `CamelSmppMessageType`,
`CamelSmppStatus` and `CamelSmppOptionalParameters`.
+=== Delivery Receipts
+
+The SMSC sends a delivery receipt for each SMS that `smpp-sink` sent with
`registeredDelivery` `1`, its default, and
+for each failed SMS with `registeredDelivery` `2`. A receipt has
`CamelSmppMessageType` `DeliveryReceipt`. Its
+`CamelSmppId` header is the ID that `smpp-sink` got for the SMS in its own
`CamelSmppId` header, and `CamelSmppStatus`
+is the final state of the SMS, such as `DELIVRD` or `UNDELIV`.
+
=== Address Range
`addressRange` is the consumer side option that tells the SMSC which messages
to route to
this ESME, as defined in section 5.2.7 of the SMPP 3.4 specification.
+
+=== Connection
+
+Every `enquireLinkTimer` milliseconds, one minute by default, the Kamelet
checks that the connection is alive. A lower
+value finds a lost connection sooner, and the Kamelet then connects again.
+
+=== Example with Delivery Receipts
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:smpp-source"
+ parameters:
+ host: "smsc.example.com"
+ systemId: "myaccount"
+ password: "{{smpp.password}}"
+ enquireLinkTimer: 30000
+ steps:
+ - filter:
+ simple: "$\{header.CamelSmppMessageType} == 'DeliveryReceipt'"
+ steps:
+ - log: "SMS $\{header.CamelSmppId} ended as
$\{header.CamelSmppStatus}"
+----
diff --git a/kamelets/smpp-sink.kamelet.yaml b/kamelets/smpp-sink.kamelet.yaml
index 3efc5e451..ab355f2a7 100644
--- a/kamelets/smpp-sink.kamelet.yaml
+++ b/kamelets/smpp-sink.kamelet.yaml
@@ -35,11 +35,11 @@ spec:
Use it to send alerts, one-time codes or notifications by SMS, through
an SMS provider or operator that offers SMPP access. Use `smpp-source` to
receive SMS replies and delivery receipts.
- Input: the body is the text of the SMS. The phone number to send it to
comes from the `CamelSmppDestAddr` header when it is set, and from `destAddr`
otherwise. A text longer than one SMS (140 bytes) is split, cut or refused, as
`splittingPolicy` says.
+ Input: the body is the text of the SMS. The phone number to send it to
comes from the `CamelSmppDestAddr` header when it is set, and from `destAddr`
otherwise. A text longer than one SMS (160 characters, or 70 with `alphabet`
`8`) is split, cut or refused, as `splittingPolicy` says.
Output: the message is unchanged, with the IDs that the SMSC gave the
SMS in the `CamelSmppId` header (a List), and how many SMS were sent in
`CamelSmppSentMessageCount`.
- Good to know: the defaults of `sourceAddr` (1616) and `destAddr` (1717)
are test numbers: set them, or set `CamelSmppDestAddr` on each message. It logs
in to the SMSC when the integration starts, and the integration fails to start
when the SMSC cannot be reached. It connects with no TLS unless `usingSSL` is
true.
+ Good to know: the defaults of `sourceAddr` (1616) and `destAddr` (1717)
are test numbers: set them, or set `CamelSmppDestAddr` on each message. It asks
the SMSC for a delivery receipt of each SMS, which `smpp-source` receives: set
`registeredDelivery` to `0` to not ask for them. The text is encoded with
`encoding`, so characters it cannot hold, such as Cyrillic or emoji in
ISO-8859-1, are sent as `?`: for text in any language, set `alphabet` and
`dataCoding` to `8`. It logs in to t [...]
required:
- host
type: object
@@ -92,7 +92,7 @@ spec:
default: "ISO-8859-1"
splittingPolicy:
title: "Splitting Policy"
- description: "What to do with a text longer than one SMS (140 bytes):
`ALLOW` splits it into several SMS, `TRUNCATE` cuts it at 140 bytes, and
`REJECT` fails the message."
+ description: "What to do with a text longer than one SMS (160
characters, or 70 with `alphabet` `8`): `ALLOW` splits it into several SMS,
`TRUNCATE` cuts it to fit in one SMS, and `REJECT` fails the message."
type: string
default: ALLOW
enum: ["ALLOW", "TRUNCATE", "REJECT"]
@@ -101,6 +101,55 @@ spec:
description: "Whether to secure the connection to the SMSC with TLS
(the smpps protocol). The SMSC must support it, usually on another port."
type: boolean
default: false
+ registeredDelivery:
+ title: "Delivery Receipt"
+ description: "Which delivery receipts to ask the SMSC for: `1` for a
receipt whether the SMS reached the phone or not, `2` only when it failed, and
`0` for none. When it is not set, it is `1`. The SMSC sends the receipts to a
receiver logged in to it, such as `smpp-source`: this Kamelet does not get
them."
+ type: integer
+ enum: [0, 1, 2]
+ example: 0
+ sourceAddrTon:
+ title: "Sender Type Of Number"
+ description: "The type of number (TON) of `sourceAddr`: `0` unknown,
`1` international, `2` national, `3` network specific, `4` subscriber number,
`5` alphanumeric (a name instead of a number), `6` abbreviated. When it is not
set, it is `0`. Use `5` to send from a name, such as `MyShop`, and `1`, with
`1` in `sourceAddrNpi`, for a number with its country code."
+ type: integer
+ enum: [0, 1, 2, 3, 4, 5, 6]
+ example: 5
+ sourceAddrNpi:
+ title: "Sender Numbering Plan"
+ description: "The numbering plan indicator (NPI) of `sourceAddr`: `0`
unknown, `1` ISDN (E.164, the plan of phone numbers), `3` data (X.121), `4`
telex, `6` land mobile (E.212), `8` national, `9` private, `10` ERMES, `14`
internet (IP), `18` WAP client ID. When it is not set, it is `0`."
+ type: integer
+ enum: [0, 1, 3, 4, 6, 8, 9, 10, 14, 18]
+ example: 1
+ destAddrTon:
+ title: "Recipient Type Of Number"
+ description: "The type of number (TON) of the recipient address, from
`destAddr` or `CamelSmppDestAddr`: `0` unknown, `1` international, `2`
national, `3` network specific, `4` subscriber number, `5` alphanumeric, `6`
abbreviated. When it is not set, it is `0`. Use `1`, with `1` in `destAddrNpi`,
for a phone number with its country code, such as `4598765432`."
+ type: integer
+ enum: [0, 1, 2, 3, 4, 5, 6]
+ example: 1
+ destAddrNpi:
+ title: "Recipient Numbering Plan"
+ description: "The numbering plan indicator (NPI) of the recipient
address: `0` unknown, `1` ISDN (E.164, the plan of phone numbers), `3` data
(X.121), `4` telex, `6` land mobile (E.212), `8` national, `9` private, `10`
ERMES, `14` internet (IP), `18` WAP client ID. When it is not set, it is `0`."
+ type: integer
+ enum: [0, 1, 3, 4, 6, 8, 9, 10, 14, 18]
+ example: 1
+ dataCoding:
+ title: "Data Coding"
+ description: "The data coding the SMS is marked with, from 0 to 127,
which tells the phone how to read its bytes, as in section 5.2.19 of the SMPP
3.4 specification: `0` the default alphabet of the SMSC, `3` Latin-1, `4` 8-bit
binary, `8` UCS-2 (Unicode). When it is not set, it is `0`. It does not change
how the text is encoded into bytes, which `alphabet` and `encoding` do: for
text in any language, such as Cyrillic or emoji, set both `alphabet` and
`dataCoding` to `8`."
+ type: integer
+ minimum: 0
+ maximum: 127
+ example: 8
+ alphabet:
+ title: "Alphabet"
+ description: "How to turn the body into the bytes of the SMS: `0`
encodes the text with `encoding`, `4` sends a body of bytes as it is (8-bit
binary data) and encodes text with `encoding`, and `8` encodes the text as
UCS-2 (UTF-16), which can hold text in any language. When it is not set, it is
`0`, and characters that `encoding` cannot hold, such as Cyrillic in
ISO-8859-1, are sent as `?`. It does not change the data coding the SMS is
marked with: set `dataCoding` to the same value."
+ type: integer
+ enum: [0, 4, 8]
+ example: 8
+ enquireLinkTimer:
+ title: "Enquire Link Interval"
+ description: "How often to check that the connection to the SMSC is
alive with an enquire_link, in milliseconds. When it is not set, it is 60000,
which is one minute. A lower value finds a lost connection sooner."
+ type: integer
+ minimum: 1
+ example: 30000
dataTypes:
in:
headers:
@@ -128,3 +177,11 @@ spec:
systemId: "RAW({{systemId}})"
systemType: "{{?systemType}}"
usingSSL: "{{usingSSL}}"
+ registeredDelivery: "{{?registeredDelivery}}"
+ sourceAddrTon: "{{?sourceAddrTon}}"
+ sourceAddrNpi: "{{?sourceAddrNpi}}"
+ destAddrTon: "{{?destAddrTon}}"
+ destAddrNpi: "{{?destAddrNpi}}"
+ dataCoding: "{{?dataCoding}}"
+ alphabet: "{{?alphabet}}"
+ enquireLinkTimer: "{{?enquireLinkTimer}}"
diff --git a/kamelets/smpp-source.kamelet.yaml
b/kamelets/smpp-source.kamelet.yaml
index d1ff779eb..ba4279191 100644
--- a/kamelets/smpp-source.kamelet.yaml
+++ b/kamelets/smpp-source.kamelet.yaml
@@ -37,7 +37,7 @@ spec:
Output: the body is the text of the SMS. The `CamelSmppSourceAddr`
header is the phone number of the sender, `CamelSmppDestAddr` the number it was
sent to, and `CamelSmppMessageType` is `DeliverSm` for an SMS and
`DeliveryReceipt` for a delivery receipt, whose body is the text of the receipt
and whose fields are in other `CamelSmpp` headers.
- Good to know: it logs in to the SMSC as a receiver when the integration
starts, and the integration fails to start when the SMSC cannot be reached. The
SMSC decides which messages it gets, from `systemId` and `addressRange`. It
connects with no TLS unless `usingSSL` is true.
+ Good to know: it logs in to the SMSC as a receiver when the integration
starts, and the integration fails to start when the SMSC cannot be reached. The
SMSC sends a delivery receipt for each SMS that `smpp-sink` sent with
`registeredDelivery` `1` (its default), or `2` when the SMS failed: the
`CamelSmppId` header of the receipt is the ID that `smpp-sink` got for the SMS,
and `CamelSmppStatus` its final state, such as `DELIVRD`. The SMSC decides
which messages it gets, from `systemI [...]
required:
- host
type: object
@@ -86,6 +86,12 @@ spec:
description: "Whether to secure the connection to the SMSC with TLS
(the smpps protocol). The SMSC must support it, usually on another port."
type: boolean
default: false
+ enquireLinkTimer:
+ title: "Enquire Link Interval"
+ description: "How often to check that the connection to the SMSC is
alive with an enquire_link, in milliseconds. When it is not set, it is 60000,
which is one minute. A lower value finds a lost connection sooner."
+ type: integer
+ minimum: 1
+ example: 30000
dataTypes:
out:
headers:
@@ -116,6 +122,7 @@ spec:
systemId: "RAW({{systemId}})"
systemType: "{{?systemType}}"
usingSSL: "{{usingSSL}}"
+ enquireLinkTimer: "{{?enquireLinkTimer}}"
steps:
- to:
uri: kamelet:sink
diff --git
a/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
b/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
index 2a0830e41..6b6b95909 100644
--- a/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
+++ b/library/camel-kamelets/src/main/resources/META-INF/kamelets-index.json
@@ -2035,7 +2035,7 @@
"supportLevel" : "Preview",
"title" : "SMPP Sink",
"summary" : "Sends each message as an SMS text message to a mobile phone,
through an SMS center (SMSC) that speaks the SMPP protocol.",
- "description" : "Sends each message as an SMS text message to a mobile
phone, through an SMS center (SMSC) that speaks the SMPP protocol.\n\nUse it to
send alerts, one-time codes or notifications by SMS, through an SMS provider or
operator that offers SMPP access. Use `smpp-source` to receive SMS replies and
delivery receipts.\n\nInput: the body is the text of the SMS. The phone number
to send it to comes from the `CamelSmppDestAddr` header when it is set, and
from `destAddr` otherwi [...]
+ "description" : "Sends each message as an SMS text message to a mobile
phone, through an SMS center (SMSC) that speaks the SMPP protocol.\n\nUse it to
send alerts, one-time codes or notifications by SMS, through an SMS provider or
operator that offers SMPP access. Use `smpp-source` to receive SMS replies and
delivery receipts.\n\nInput: the body is the text of the SMS. The phone number
to send it to comes from the `CamelSmppDestAddr` header when it is set, and
from `destAddr` otherwi [...]
"group" : "SMPP",
"namespace" : "Messaging",
"provider" : "Apache Software Foundation"
@@ -2045,7 +2045,7 @@
"supportLevel" : "Preview",
"title" : "SMPP Source",
"summary" : "Receives each SMS sent to your numbers, and the delivery
receipts of the SMS you sent, from an SMS center (SMSC) that speaks the SMPP
protocol.",
- "description" : "Receives each SMS sent to your numbers, and the delivery
receipts of the SMS you sent, from an SMS center (SMSC) that speaks the SMPP
protocol.\n\nUse it to process SMS replies from customers, such as a STOP or a
YES, or to follow whether the SMS sent with `smpp-sink` reached the
phone.\n\nOutput: the body is the text of the SMS. The `CamelSmppSourceAddr`
header is the phone number of the sender, `CamelSmppDestAddr` the number it was
sent to, and `CamelSmppMessageTyp [...]
+ "description" : "Receives each SMS sent to your numbers, and the delivery
receipts of the SMS you sent, from an SMS center (SMSC) that speaks the SMPP
protocol.\n\nUse it to process SMS replies from customers, such as a STOP or a
YES, or to follow whether the SMS sent with `smpp-sink` reached the
phone.\n\nOutput: the body is the text of the SMS. The `CamelSmppSourceAddr`
header is the phone number of the sender, `CamelSmppDestAddr` the number it was
sent to, and `CamelSmppMessageTyp [...]
"group" : "SMPP",
"namespace" : "Messaging",
"provider" : "Apache Software Foundation"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/smpp-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/smpp-sink.kamelet.yaml
index 3efc5e451..ab355f2a7 100644
--- a/library/camel-kamelets/src/main/resources/kamelets/smpp-sink.kamelet.yaml
+++ b/library/camel-kamelets/src/main/resources/kamelets/smpp-sink.kamelet.yaml
@@ -35,11 +35,11 @@ spec:
Use it to send alerts, one-time codes or notifications by SMS, through
an SMS provider or operator that offers SMPP access. Use `smpp-source` to
receive SMS replies and delivery receipts.
- Input: the body is the text of the SMS. The phone number to send it to
comes from the `CamelSmppDestAddr` header when it is set, and from `destAddr`
otherwise. A text longer than one SMS (140 bytes) is split, cut or refused, as
`splittingPolicy` says.
+ Input: the body is the text of the SMS. The phone number to send it to
comes from the `CamelSmppDestAddr` header when it is set, and from `destAddr`
otherwise. A text longer than one SMS (160 characters, or 70 with `alphabet`
`8`) is split, cut or refused, as `splittingPolicy` says.
Output: the message is unchanged, with the IDs that the SMSC gave the
SMS in the `CamelSmppId` header (a List), and how many SMS were sent in
`CamelSmppSentMessageCount`.
- Good to know: the defaults of `sourceAddr` (1616) and `destAddr` (1717)
are test numbers: set them, or set `CamelSmppDestAddr` on each message. It logs
in to the SMSC when the integration starts, and the integration fails to start
when the SMSC cannot be reached. It connects with no TLS unless `usingSSL` is
true.
+ Good to know: the defaults of `sourceAddr` (1616) and `destAddr` (1717)
are test numbers: set them, or set `CamelSmppDestAddr` on each message. It asks
the SMSC for a delivery receipt of each SMS, which `smpp-source` receives: set
`registeredDelivery` to `0` to not ask for them. The text is encoded with
`encoding`, so characters it cannot hold, such as Cyrillic or emoji in
ISO-8859-1, are sent as `?`: for text in any language, set `alphabet` and
`dataCoding` to `8`. It logs in to t [...]
required:
- host
type: object
@@ -92,7 +92,7 @@ spec:
default: "ISO-8859-1"
splittingPolicy:
title: "Splitting Policy"
- description: "What to do with a text longer than one SMS (140 bytes):
`ALLOW` splits it into several SMS, `TRUNCATE` cuts it at 140 bytes, and
`REJECT` fails the message."
+ description: "What to do with a text longer than one SMS (160
characters, or 70 with `alphabet` `8`): `ALLOW` splits it into several SMS,
`TRUNCATE` cuts it to fit in one SMS, and `REJECT` fails the message."
type: string
default: ALLOW
enum: ["ALLOW", "TRUNCATE", "REJECT"]
@@ -101,6 +101,55 @@ spec:
description: "Whether to secure the connection to the SMSC with TLS
(the smpps protocol). The SMSC must support it, usually on another port."
type: boolean
default: false
+ registeredDelivery:
+ title: "Delivery Receipt"
+ description: "Which delivery receipts to ask the SMSC for: `1` for a
receipt whether the SMS reached the phone or not, `2` only when it failed, and
`0` for none. When it is not set, it is `1`. The SMSC sends the receipts to a
receiver logged in to it, such as `smpp-source`: this Kamelet does not get
them."
+ type: integer
+ enum: [0, 1, 2]
+ example: 0
+ sourceAddrTon:
+ title: "Sender Type Of Number"
+ description: "The type of number (TON) of `sourceAddr`: `0` unknown,
`1` international, `2` national, `3` network specific, `4` subscriber number,
`5` alphanumeric (a name instead of a number), `6` abbreviated. When it is not
set, it is `0`. Use `5` to send from a name, such as `MyShop`, and `1`, with
`1` in `sourceAddrNpi`, for a number with its country code."
+ type: integer
+ enum: [0, 1, 2, 3, 4, 5, 6]
+ example: 5
+ sourceAddrNpi:
+ title: "Sender Numbering Plan"
+ description: "The numbering plan indicator (NPI) of `sourceAddr`: `0`
unknown, `1` ISDN (E.164, the plan of phone numbers), `3` data (X.121), `4`
telex, `6` land mobile (E.212), `8` national, `9` private, `10` ERMES, `14`
internet (IP), `18` WAP client ID. When it is not set, it is `0`."
+ type: integer
+ enum: [0, 1, 3, 4, 6, 8, 9, 10, 14, 18]
+ example: 1
+ destAddrTon:
+ title: "Recipient Type Of Number"
+ description: "The type of number (TON) of the recipient address, from
`destAddr` or `CamelSmppDestAddr`: `0` unknown, `1` international, `2`
national, `3` network specific, `4` subscriber number, `5` alphanumeric, `6`
abbreviated. When it is not set, it is `0`. Use `1`, with `1` in `destAddrNpi`,
for a phone number with its country code, such as `4598765432`."
+ type: integer
+ enum: [0, 1, 2, 3, 4, 5, 6]
+ example: 1
+ destAddrNpi:
+ title: "Recipient Numbering Plan"
+ description: "The numbering plan indicator (NPI) of the recipient
address: `0` unknown, `1` ISDN (E.164, the plan of phone numbers), `3` data
(X.121), `4` telex, `6` land mobile (E.212), `8` national, `9` private, `10`
ERMES, `14` internet (IP), `18` WAP client ID. When it is not set, it is `0`."
+ type: integer
+ enum: [0, 1, 3, 4, 6, 8, 9, 10, 14, 18]
+ example: 1
+ dataCoding:
+ title: "Data Coding"
+ description: "The data coding the SMS is marked with, from 0 to 127,
which tells the phone how to read its bytes, as in section 5.2.19 of the SMPP
3.4 specification: `0` the default alphabet of the SMSC, `3` Latin-1, `4` 8-bit
binary, `8` UCS-2 (Unicode). When it is not set, it is `0`. It does not change
how the text is encoded into bytes, which `alphabet` and `encoding` do: for
text in any language, such as Cyrillic or emoji, set both `alphabet` and
`dataCoding` to `8`."
+ type: integer
+ minimum: 0
+ maximum: 127
+ example: 8
+ alphabet:
+ title: "Alphabet"
+ description: "How to turn the body into the bytes of the SMS: `0`
encodes the text with `encoding`, `4` sends a body of bytes as it is (8-bit
binary data) and encodes text with `encoding`, and `8` encodes the text as
UCS-2 (UTF-16), which can hold text in any language. When it is not set, it is
`0`, and characters that `encoding` cannot hold, such as Cyrillic in
ISO-8859-1, are sent as `?`. It does not change the data coding the SMS is
marked with: set `dataCoding` to the same value."
+ type: integer
+ enum: [0, 4, 8]
+ example: 8
+ enquireLinkTimer:
+ title: "Enquire Link Interval"
+ description: "How often to check that the connection to the SMSC is
alive with an enquire_link, in milliseconds. When it is not set, it is 60000,
which is one minute. A lower value finds a lost connection sooner."
+ type: integer
+ minimum: 1
+ example: 30000
dataTypes:
in:
headers:
@@ -128,3 +177,11 @@ spec:
systemId: "RAW({{systemId}})"
systemType: "{{?systemType}}"
usingSSL: "{{usingSSL}}"
+ registeredDelivery: "{{?registeredDelivery}}"
+ sourceAddrTon: "{{?sourceAddrTon}}"
+ sourceAddrNpi: "{{?sourceAddrNpi}}"
+ destAddrTon: "{{?destAddrTon}}"
+ destAddrNpi: "{{?destAddrNpi}}"
+ dataCoding: "{{?dataCoding}}"
+ alphabet: "{{?alphabet}}"
+ enquireLinkTimer: "{{?enquireLinkTimer}}"
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/smpp-source.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/smpp-source.kamelet.yaml
index d1ff779eb..ba4279191 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/smpp-source.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/smpp-source.kamelet.yaml
@@ -37,7 +37,7 @@ spec:
Output: the body is the text of the SMS. The `CamelSmppSourceAddr`
header is the phone number of the sender, `CamelSmppDestAddr` the number it was
sent to, and `CamelSmppMessageType` is `DeliverSm` for an SMS and
`DeliveryReceipt` for a delivery receipt, whose body is the text of the receipt
and whose fields are in other `CamelSmpp` headers.
- Good to know: it logs in to the SMSC as a receiver when the integration
starts, and the integration fails to start when the SMSC cannot be reached. The
SMSC decides which messages it gets, from `systemId` and `addressRange`. It
connects with no TLS unless `usingSSL` is true.
+ Good to know: it logs in to the SMSC as a receiver when the integration
starts, and the integration fails to start when the SMSC cannot be reached. The
SMSC sends a delivery receipt for each SMS that `smpp-sink` sent with
`registeredDelivery` `1` (its default), or `2` when the SMS failed: the
`CamelSmppId` header of the receipt is the ID that `smpp-sink` got for the SMS,
and `CamelSmppStatus` its final state, such as `DELIVRD`. The SMSC decides
which messages it gets, from `systemI [...]
required:
- host
type: object
@@ -86,6 +86,12 @@ spec:
description: "Whether to secure the connection to the SMSC with TLS
(the smpps protocol). The SMSC must support it, usually on another port."
type: boolean
default: false
+ enquireLinkTimer:
+ title: "Enquire Link Interval"
+ description: "How often to check that the connection to the SMSC is
alive with an enquire_link, in milliseconds. When it is not set, it is 60000,
which is one minute. A lower value finds a lost connection sooner."
+ type: integer
+ minimum: 1
+ example: 30000
dataTypes:
out:
headers:
@@ -116,6 +122,7 @@ spec:
systemId: "RAW({{systemId}})"
systemType: "{{?systemType}}"
usingSSL: "{{usingSSL}}"
+ enquireLinkTimer: "{{?enquireLinkTimer}}"
steps:
- to:
uri: kamelet:sink