components/camel-cm-sms/src/main/docs/cm-sms-component.adoc

== CM SMS Gateway Component

*Available as of Camel version 2.18*

*Camel-Cm-Sms* is an http://camel.apache.org/[Apache Camel] component 
for the [CM SMS Gateway](https://www.cmtelecom.com). 

It allows to integrate https://dashboard.onlinesmsgateway.com/docs[CM SMS API]in an application as a camel component. 

You must have a valid account.  More information are available at https://www.cmtelecom.com/support[CM Telecom].

[source,java]
-------------------------------
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:

[source,xml]
---------------------------------------------------------
<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


// component options: START
The CM SMS Gateway component has no options.
// component options: END



// endpoint options: START
The CM SMS Gateway endpoint is configured using URI syntax:

----
cm-sms:host
----

with the following path and query parameters:

==== Path Parameters (1 parameters):

[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *host* | *Required* SMS Provider HOST with scheme |  | String
|===

==== Query Parameters (5 parameters):

[width="100%",cols="2,5,^1,2",options="header"]
|===
| 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 | 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
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|===
// endpoint options: END


### Sample

You can try https://github.com/oalles/camel-cm-sample[this project] to see how camel-cm-sms can be integrated in a camel route.