docs/components/modules/ROOT/pages/cm-sms-component.adoc

[[cm-sms-component]]
= CM SMS Gateway Component
//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
:page-source: components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
:docTitle: CM SMS Gateway
:artifactId: camel-cm-sms
:description: Send SMS messages via CM SMS Gateway.
:since: 2.18
:supportLevel: Stable
:component-header: Only producer is supported

*Since Camel {since}*

*{component-header}*

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

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 is available at https://www.cmtelecom.com/support[CM Telecom].

[source,text]
----
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 supports 2 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
|===
// 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 (7 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *defaultFrom* (producer) | *Required* 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
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *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
|===
// 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. 

include::camel-spring-boot::page$cm-sms-starter.adoc[]