| {"component":{"kind":"component","name":"smpp","title":"SMPP","description":"Send and receive SMS messages using a SMSC (Short Message Service Center).","deprecated":false,"firstVersion":"2.2.0","label":"mobile","javaType":"org.apache.camel.component.smpp.SmppComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-smpp","version":"3.18.1","scheme":"smpp","extendsScheme":"","alternativeSchemes":"smpp,smpps","syntax":"smpp:host:port","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":true},"headers":{"CamelSmppAlphabet":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ALPHABET"},"CamelSmppCommand":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The command","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND"},"CamelSmppCommandId":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm The command id field identifies the particular SMPP PDU. For the complete list of defined values see chapter 5.1.2.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_ID"},"CamelSmppCommandStatus":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for DataSm The Command status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#COMMAND_STATUS"},"CamelSmppDataCoding":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"For SubmitSm, SubmitMulti and ReplaceSm The data coding according to the SMPP 3.4 specification, section 5.2.19. Use the URI option alphabet settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_CODING"},"CamelSmppSplitter":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.smpp.SmppSplitter","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The splitter","constantName":"org.apache.camel.component.smpp.SmppConstants#DATA_SPLITTER"},"CamelSmppDelivered":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages delivered. This is only relevant where the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#DELIVERED"},"CamelSmppDestAddr":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"List or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the destination SME address(es). For mobile terminated messages, this is the directory number of the recipient MS. It must be a List for SubmitMulti and a String otherwise. Consumer: only for DeliverSm and DataSm: Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR"},"CamelSmppDestAddrNpi":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the numeric plan indicator (NPI) to be used in the SME destination address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for DataSm Defines the numeric plan indicator (NPI) in the destination address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_NPI"},"CamelSmppDestAddrTon":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti, CancelSm and DataSm Defines the type of number (TON) to be used in the SME destination address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for DataSm Defines the type of number (TON) in the destination address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#DEST_ADDR_TON"},"CamelSmppDoneDate":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message reached it's final state. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#DONE_DATE"},"CamelSmppEncoding":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the encoding (character set name) of the bytes in the message body. If the message body is a string then this is not relevant because Java Strings are always Unicode. If the body is a byte array then this header can be used to indicate that it is ISO-8859-1 or some other value. Default value is specified by the endpoint configuration parameter _encoding_","constantName":"org.apache.camel.component.smpp.SmppConstants#ENCODING"},"CamelSmppError":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Map<String, List<Map<String, Object>>>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitMultiSm The errors which occurred by sending the short message(s) the form Map (messageID : (destAddr : address, error : errorCode)). Consumer: only for smsc DeliveryReceipt Where appropriate this may hold a Network specific error code or an SMSC error code for the attempted delivery of the message. These errors are Network or SMSC specific and are not included here.","constantName":"org.apache.camel.component.smpp.SmppConstants#ERROR"},"CamelSmppClass":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.jsmpp.bean.ESMClass","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the ASM class","constantName":"org.apache.camel.component.smpp.SmppConstants#ESM_CLASS"},"CamelSmppEsmeAddr":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the destination ESME address. For mobile terminated messages, this is the directory number of the recipient MS.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR"},"CamelSmppEsmeAddrNpi":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the numeric plan indicator (NPI) to be used in the ESME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_NPI"},"CamelSmppEsmeAddrTon":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification Defines the type of number (TON) to be used in the ESME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#ESME_ADDR_TON"},"CamelSmppFinalDate":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.util.Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The final date","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_DATE"},"CamelSmppStatus":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.jsmpp.util.DeliveryReceiptState","enum":["ENROUTE","DELIVRD","EXPIRED","DELETED","UNDELIV","ACCEPTD","UNKNOWN","REJECTD"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt: The final status of the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#FINAL_STATUS"},"CamelSmppId":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or List<String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The id to identify the submitted short message(s) for later use. In case of a ReplaceSm, QuerySm, CancelSm and DataSm this header value is a String. In case of a SubmitSm or SubmitMultiSm this header value is a List. Consumer: only for smsc DeliveryReceipt and DataSm The message ID allocated to the message by the SMSC when originally submitted.","constantName":"org.apache.camel.component.smpp.SmppConstants#ID"},"CamelSmppMessageState":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message date","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_STATE"},"CamelSmppMessageType":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifies the type of an incoming message: AlertNotification: an SMSC alert notification, DataSm: an SMSC data short message, DeliveryReceipt: an SMSC delivery receipt, DeliverSm: an SMSC deliver short message","constantName":"org.apache.camel.component.smpp.SmppConstants#MESSAGE_TYPE"},"CamelSmppPriorityFlag":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti Allows the originating SME to assign a priority level to the short message. Use the URI option priorityFlag settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#PRIORITY_FLAG"},"CamelSmppProtocolId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol id","constantName":"org.apache.camel.component.smpp.SmppConstants#PROTOCOL_ID"},"CamelSmppRegisteredDelivery":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, ReplaceSm, SubmitMulti and DataSm Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. Use the URI option registeredDelivery settings above. Consumer: only for DataSm Is used to request an delivery receipt and/or SME originated acknowledgements. Same values as in Producer header list above.","constantName":"org.apache.camel.component.smpp.SmppConstants#REGISTERED_DELIVERY"},"CamelSmppSingleDLR":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti Is used to request the SMSC delivery receipt only on the last segment of multi-segment (long) messages. Use the URI option singleDLR settings above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SINGLE_DLR"},"CamelSmppReplaceIfPresentFlag":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMulti The replace if present flag parameter is used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following values are defined: 0, Don't replace and 1, Replace","constantName":"org.apache.camel.component.smpp.SmppConstants#REPLACE_IF_PRESENT_FLAG"},"CamelSmppScheduleDeliveryTime":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in chapter 7.1.1. in the smpp specification v3.4. Consumer: only for DeliverSm: This parameter specifies the scheduled time at which the message delivery should be first attempted. It defines either the absolute date and time or relative time from the current SMSC time at which delivery of this message will be attempted by the SMSC. It can be specified in either absolute time format or relative time format. The encoding of a time format is specified in Section 7.1.1. in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#SCHEDULE_DELIVERY_TIME"},"CamelSmppSentMessageCount":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm and SubmitMultiSm The total number of messages which has been sent.","constantName":"org.apache.camel.component.smpp.SmppConstants#SENT_MESSAGE_COUNT"},"CamelSmppSequenceNumber":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for AlertNotification, DeliverSm and DataSm A sequence number allows a response PDU to be correlated with a request PDU. The associated SMPP response PDU must preserve this field.","constantName":"org.apache.camel.component.smpp.SmppConstants#SEQUENCE_NUMBER"},"CamelSmppServiceType":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: The service type parameter can be used to indicate the SMS Application service associated with the message. Use the URI option serviceType settings above. Consumer: only for DeliverSm and DataSm The service type parameter indicates the SMS Application service associated with the message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SERVICE_TYPE"},"CamelSmppSourceAddr":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the address of SME (Short Message Entity) which originated this message. Consumer: Only for AlertNotification, DeliverSm and DataSm Defines the address of SME (Short Message Entity) which originated this message.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR"},"CamelSmppSourceAddrNpi":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above. Consumer: only for AlertNotification and DataSm Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. Use the URI option sourceAddrNpi values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_NPI"},"CamelSmppSourceAddrTon":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Byte","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above. Consumer: only for AlertNotification and DataSm Defines the type of number (TON) to be used in the SME originator address parameters. Use the sourceAddrTon URI option values defined above.","constantName":"org.apache.camel.component.smpp.SmppConstants#SOURCE_ADDR_TON"},"CamelSmppSubmitted":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt Number of short messages originally submitted. This is only relevant when the original message was submitted to a distribution list.The value is padded with leading zeros if necessary.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMITTED"},"CamelSmppSubmitDate":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for smsc DeliveryReceipt The time and date at which the short message was submitted. In the case of a message which has been replaced, this is the date that the original message was replaced. The format is as follows: YYMMDDhhmm.","constantName":"org.apache.camel.component.smpp.SmppConstants#SUBMIT_DATE"},"CamelSmppSystemId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The system id.","constantName":"org.apache.camel.component.smpp.SmppConstants#SYSTEM_ID"},"CamelSmppPassword":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The password.","constantName":"org.apache.camel.component.smpp.SmppConstants#PASSWORD"},"CamelSmppValidityPeriod":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String or Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and ReplaceSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. If it's provided as Date, it's interpreted as absolute time or relative time format if you provide it as String as specified in chapter 7.1.1 in the smpp specification v3.4. Consumer: only for DeliverSm The validity period parameter indicates the SMSC expiration time, after which the message should be discarded if not delivered to the destination. It can be defined in absolute time format or relative time format. The encoding of absolute and relative time format is specified in Section 7.1.1 in the smpp specification v3.4.","constantName":"org.apache.camel.component.smpp.SmppConstants#VALIDITY_PERIOD"},"CamelSmppOptionalParameters":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map<String, Object>","deprecated":false,"deprecationNote":"Use CamelSmppOptionalParameter instead","autowired":false,"secret":false,"description":"The optional parameters by name. Deprecation note: Use CamelSmppOptionalParameter instead","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETERS"},"CamelSmppOptionalParameter":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Map<Short, Object>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Producer: only for SubmitSm, SubmitMulti and DataSm The optional parameter which are send to the SMSC. The value is converted in the following way: String - org.jsmpp.bean.OptionalParameter.COctetString, byte - org.jsmpp.bean.OptionalParameter.OctetString, Byte - org.jsmpp.bean.OptionalParameter.Byte, Integer - org.jsmpp.bean.OptionalParameter.Int, Short - org.jsmpp.bean.OptionalParameter.Short, null - org.jsmpp.bean.OptionalParameter.Null Consumer: only for DeliverSm The optional parameters send back by the SMSC. The key is the Short code for the optional parameter. The value is converted in the following way: org.jsmpp.bean.OptionalParameter.COctetString - String, org.jsmpp.bean.OptionalParameter.OctetString - byte, org.jsmpp.bean.OptionalParameter.Byte - Byte, org.jsmpp.bean.OptionalParameter.Int - Integer, org.jsmpp.bean.OptionalParameter.Short - Short, org.jsmpp.bean.OptionalParameter.Null - null","constantName":"org.apache.camel.component.smpp.SmppConstants#OPTIONAL_PARAMETER"},"CamelSmppSplittingPolicy":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"only for SubmitSm, SubmitMulti and DataSm. Specifies the policy for message splitting for this exchange. Possible values are described in the endpoint configuration parameter _splittingPolicy_","constantName":"org.apache.camel.component.smpp.SmppConstants#SPLITTING_POLICY"}},"properties":{"host":{"kind":"path","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"localhost","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Hostname for the SMSC server to use."},"port":{"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"2775","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Port number for the SMSC server to use."},"initialReconnectDelay":{"kind":"parameter","displayName":"Initial Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost."},"maxReconnect":{"kind":"parameter","displayName":"Max Reconnect","group":"common","label":"common","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":2147483647,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response"},"reconnectDelay":{"kind":"parameter","displayName":"Reconnect Delay","group":"common","label":"common","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":5000,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed."},"splittingPolicy":{"kind":"parameter","displayName":"Splitting Policy","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.smpp.SmppSplittingPolicy","enum":["ALLOW","REJECT","TRUNCATE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ALLOW","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long."},"systemType":{"kind":"parameter","displayName":"System Type","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters)."},"addressRange":{"kind":"parameter","displayName":"Address Range","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range."},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"destAddr":{"kind":"parameter","displayName":"Dest Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1717","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. Only for SubmitSm, SubmitMulti, CancelSm and DataSm."},"destAddrNpi":{"kind":"parameter","displayName":"Dest Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"destAddrTon":{"kind":"parameter","displayName":"Dest Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazySessionCreation":{"kind":"parameter","displayName":"Lazy Session Creation","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC."},"numberingPlanIndicator":{"kind":"parameter","displayName":"Numbering Plan Indicator","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"priorityFlag":{"kind":"parameter","displayName":"Priority Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority"},"protocolId":{"kind":"parameter","displayName":"Protocol Id","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The protocol id"},"registeredDelivery":{"kind":"parameter","displayName":"Registered Delivery","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure."},"replaceIfPresentFlag":{"kind":"parameter","displayName":"Replace If Present Flag","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace"},"serviceType":{"kind":"parameter","displayName":"Service Type","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","enum":["CMT","CPT","VMN","VMA","WAP","USSD"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data"},"sourceAddr":{"kind":"parameter","displayName":"Source Addr","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1616","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the address of SME (Short Message Entity) which originated this message."},"sourceAddrNpi":{"kind":"parameter","displayName":"Source Addr Npi","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","6","8","9","10","13","18"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)"},"sourceAddrTon":{"kind":"parameter","displayName":"Source Addr Ton","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"typeOfNumber":{"kind":"parameter","displayName":"Type Of Number","group":"producer","label":"producer","required":false,"type":"integer","javaType":"byte","enum":["0","1","2","3","4","5","6"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated"},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"enquireLinkTimer":{"kind":"parameter","displayName":"Enquire Link Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"60000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC."},"pduProcessorDegree":{"kind":"parameter","displayName":"Pdu Processor Degree","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the number of threads which can read PDU and process them in parallel."},"pduProcessorQueueCapacity":{"kind":"parameter","displayName":"Pdu Processor Queue Capacity","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"100","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Sets the capacity of the working queue for PDU processing."},"sessionStateListener":{"kind":"parameter","displayName":"Session State Listener","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.jsmpp.session.SessionStateListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed."},"singleDLR":{"kind":"parameter","displayName":"Single DLR","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"When true, the SMSC delivery receipt would be requested only for the last segment of a multi-segment (long) message. For short messages, with only 1 segment the behaviour is unchanged."},"transactionTimer":{"kind":"parameter","displayName":"Transaction Timer","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"10000","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME)."},"alphabet":{"kind":"parameter","displayName":"Alphabet","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","enum":["0","4","8"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet"},"dataCoding":{"kind":"parameter","displayName":"Data Coding","group":"codec","label":"codec","required":false,"type":"integer","javaType":"byte","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990)"},"encoding":{"kind":"parameter","displayName":"Encoding","group":"codec","label":"codec","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ISO-8859-1","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti."},"httpProxyHost":{"kind":"parameter","displayName":"Http Proxy Host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy."},"httpProxyPassword":{"kind":"parameter","displayName":"Http Proxy Password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy."},"httpProxyPort":{"kind":"parameter","displayName":"Http Proxy Port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"defaultValue":"3128","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy."},"httpProxyUsername":{"kind":"parameter","displayName":"Http Proxy Username","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy."},"proxyHeaders":{"kind":"parameter","displayName":"Proxy Headers","group":"proxy","label":"proxy","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.String>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"These headers will be passed to the proxy server while establishing the connection."},"password":{"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The password for connecting to SMSC server."},"systemId":{"kind":"parameter","displayName":"System Id","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"defaultValue":"smppclient","configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"The system id (username) for connecting to SMSC server."},"usingSSL":{"kind":"parameter","displayName":"Using SSL","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.smpp.SmppConfiguration","configurationField":"configuration","description":"Whether using SSL with the smpps protocol"}}} |