CM SMS Gateway Component
Available as of Camel version 2.18
Camel-Cm-Sms is an Apache Camel component for the [CM SMS Gateway](https://www.cmtelecom.com).
It allows to integrate CM SMS APIin an application as a camel component.
You must have a valid account. More information is available at CM Telecom.
cm-sms://sgw01.cm.nl/gateway.ashx?defaultFrom=DefaultSender&defaultMaxNumberOfParts=8&productToken=xxxxx
Maven users will need to add the following dependency to their pom.xml for this component:
---
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-cm-sms</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
---
Options
The CM SMS Gateway component supports 2 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
resolveProperty Placeholders (advanced) |
Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |
true |
boolean |
basicPropertyBinding (advanced) |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
The CM SMS Gateway endpoint is configured using URI syntax:
cm-sms:host
with the following path and query parameters:
Path Parameters (1 parameters):
Name | Description | Default | Type |
---|---|---|---|
host |
Required SMS Provider HOST with scheme |
String |
Query Parameters (6 parameters):
Name | Description | Default | Type |
---|---|---|---|
defaultFrom (producer) |
This is the sender name. The maximum length is 11 characters. |
String) |
|
defaultMaxNumberOfParts (producer) |
If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters, if so, the message will be cut into multiple 153 characters parts limited by these parameters. |
8 |
Max(8L)::Int) |
productToken (producer) |
Required The unique token to use |
String) |
|
testConnectionOnStartup (producer) |
Whether to test the connection to the SMS Gateway on startup |
false |
boolean |
basicPropertyBinding (advanced) |
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
synchronous (advanced) |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
Spring Boot Auto-Configuration
When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-cm-sms-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
The component supports 3 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
camel.component.cm-sms.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.cm-sms.enabled |
Enable cm-sms component |
true |
Boolean |
camel.component.cm-sms.resolve-property-placeholders |
Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |
true |
Boolean |
Sample
You can try this project to see how camel-cm-sms can be integrated in a camel route.