diff --git a/en/micro-integrator/docs/references/connectors/smpp-connector/smpp-connector-config.md b/en/micro-integrator/docs/references/connectors/smpp-connector/smpp-connector-config.md index 5ebfe0bff..0a3fa100e 100644 --- a/en/micro-integrator/docs/references/connectors/smpp-connector/smpp-connector-config.md +++ b/en/micro-integrator/docs/references/connectors/smpp-connector/smpp-connector-config.md @@ -95,7 +95,7 @@ To use the SMPP connector, add the `` element in your configuration b ## Send SMS Message ??? note "sendSMS" - Use to send SMS Message to the SMSC (Short Message Service Center), + Use to send SMS Message to the SMSC (Short Message Service Center). @@ -165,7 +165,7 @@ To use the SMPP connector, add the `` element in your configuration b - + - + ` @@ -412,8 +412,8 @@ To use the SMPP connector, add the `` element in your configuration b 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.
Parameter NameOptional
distinationAddressdestinationAddress Destination address of the SMS message. Source address TON, Destination address TON @@ -173,7 +173,7 @@ To use the SMPP connector, add the `` element in your configuration b
TON VALUE
Unknown 0
- - + + @@ -501,7 +501,7 @@ To use the SMPP connector, add the `` element in your configuration b
ValueDescriptionValueDescription
0Optional
- + **Sample configuration** @@ -562,6 +562,7 @@ To use the SMPP connector, add the `` element in your configuration b "transactionTimer": "100" } ``` + ### Sample configuration in a scenario The following is a sample proxy service that illustrates how to connect to the SMPP connector and use the sendSMS operation to send a SMS message to the SMSC (Short Message Service Center). You can use this sample as a template for using other operations in this category. @@ -641,4 +642,402 @@ The following is a sample proxy service that illustrates how to connect to the S ``` -**Note**: For more information on how this works in an actual scenario, see [SMPP Connector Example](smpp-connector-example.md). \ No newline at end of file +**Note**: For more information on how this works in an actual scenario, see [SMPP Connector Example](smpp-connector-example.md). + +## Send bulk SMS message + +??? note "sendBulkSMS" + Use to send SMS Message to multiple destinations. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
serviceType + Indicates SMS application service. The following generic service_types are defined: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
"" (NULL) Default
"CMT"Cellular Messaging
"CPT" Cellular Paging
"VMN"Voice Mail Notification
"VMA"Voice Mail Alerting
"WAP"Wireless Application Protocol
"USSD"Unstructured Supplementary Services Data
+ 		Optional
sourceAddressTonType of number for source address.Optional
sourceAddressNpiNumbering plan indicator for source address.Optional
sourceAddressSource address of the SMS message.Yes
destinationAddresses + Destination addresses can be defined in the following 3 formats. +
    +
  1. Default Values: Default numbering plan and type will be added for all numbers
    2. + + {"mobileNumbers": ["+94715XXXXXX", "+1434XXXXXX"]} + +
  2. Custom numbering plan and type for all numbers. The specified plan and type will be set to all numbers.
    3. + 
    +      {
+        "type": "NATIONAL",
+        "numberingPlan":"NATIONAL",
+        "mobileNumbers": [
+            "+94713089759",
+            "+189718674"
+        ]
+      }
+
    +
  3. Each number assigned different properties. Numbers without the properties will be assigned default values (You can set a custom type and numbering plan as default, as mentioned in the previous format). Properties can be set to numbers individually.
    4. + 
    +      {
+      "mobileNumbers": 
+      ["+9471XXXXXX", "+189718674",{ "type": "INTERNATIONAL", "numberingPlan": "NATIONAL", "mobileNumber": "222333" }]
+      }
+
    +
+ 		Yes
messageContent of the SMS message.Yes
esmClass + The esmClass parameter is used to indicate special message attributes associated with the short Message(message mode and type). + + + + + + + + + + + + + + + + + +
Bits 7 6 5 4 3 2 1Meanning
+ x x x x x x 0 0
+ x x x x x x 0 1
+ x x x x x x 1 0
+ x x x x x x 1 1
+ 		Messaging Mode (bits 1-0)
+ Default SMSC Mode (e.g. Store and Forward)
+ Datagram mode
+ Forward (i.e. Transaction) mode
+ Store and Forward mode
+ (use to select Store and Forward mode if Default SMSC Mode is non Store and Forward)
+
x x 0 0 0 0 x x
+ x x 0 0 1 0 x x
+ x x 0 1 0 0 x x
+ 		Message Type (bits 5-2)
+ Default message Type (i.e. normal message)
+ Short Message contains ESME Delivery Acknowledgement
+ Short Message contains ESME Manual/User Acknowledgement
+
0 0 x x x x x x
+ 0 1 x x x x x x
+ 1 0 x x x x x x
+ 1 1 x x x x x x
+ 		GSM Network Specific Features (bits 7-6)
+ No specific features selected
+ UDHI Indicator (only relevant for MT short messages)
+ Set Reply Path (only relevant for GSM network)
+ Set UDHI and Reply Path (only relevant for GSM network)
+
+ 		Optional
protocolIdprotocol identifier (network specific).
+ GSM - Set according to GSM 03.40 [ GSM 03.40]
+ ANSI-136 (TDMA)
+ For mobile terminated messages, this field is not used and is therefore ignored by the SMSC.
+ For ANSI-136 mobile originated messages, the SMSC should set this value to NULL.
+ IS-95 (CDMA)
+ For mobile terminated messages, this field is not used and is therefore ignored by the SMSC.
+ For IS-95 mobile originated messages, the SMSC should set this value to NULL.
+ 		Optional
priorityFlag + sets the priority of the message. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + All other values reserved + +
Priority LevelGSMANSI-136IS-95
0Non-priorityBulkNormal
1PriorityNormalInteractive
2PriorityUrgentUrgent
3PriorityVery UrgentEmergency
+ Priority
+ There are two types of priority. +
    +
  1. Delivery priority - Message delivery is attempted even if the mobile is temporarily absent. + E.g., Temporarily out of reach or another short message is being delivered at the same time. +
    2. +
  2. Content priority - No free message memory capacity. + E.g., The user does not delete any received message and maximum storage space has been reached. +
    3. +
+ Non-priority
+ It will attempt delivery if the mobile has not been identified as temporarily absent. + 		Optional
hostIP address of the SMSC.Yes
scheduleDeliveryTimeThis parameter specifies the scheduled time at which the message delivery should be first attempted. Set to NULL for immediate delivery.Optional
validityPeriodThe 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.Optional
registeredDeliveryIndicator to signify if an SMSC delivery receipt or acknowledgment is required - Value other than 0 represents delivery report request.Optional
validityPeriodThe 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.Optional
replaceIfPresentFlag + 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
0Don't replace (default)
1Replace
2-255reserved
Optional
alphabet + Alphabet is used in the data encoding of SMS message. Following alphabets are supported. +
    +
  1. ALPHA_DEFAULT
    2. +
  2. ALPHA_8_BIT
    3. +
  3. ALPHA_UCS2
    4. +
  4. ALPHA_RESERVED
    5. +
+ 		Optional
isCompressedIt allows SMS message compression.Optional
messageClass + + + + + + + + + + + + + + + + + + + + + +
ValueMessage Class
CLASS0Flash messages. Display only not store into the phone
CLASS1ME specific - the SMS is stored in the mobile phone memory
CLASS2SIM specific - the SMS is stored on the SIM
CLASS3TE specific - this means the SMS is sent to a computer attached to the receiving mobile phone
+ Data encoding - defines the encoding scheme of the SMS message. You can find general data coding scheme from [here](https://en.wikipedia.org/wiki/Data_Coding_Scheme) for different combination of alphabet, message class, isCompressed values. + 		Optional
submitDefaultMsgId + Indicates short message to send from a predefined list of messages stored on SMSC.
+ + + + + + + + + + + + + + + + + +
ValueDescription
0reserved
1 - 254Allowed values
255reserved
+ 		Optional
+
+ + **Sample configuration** + + ```xml + + {$ctx:serviceType} + {$ctx:sourceAddressTon} + {$ctx:sourceAddressNpi} + {$ctx:sourceAddress} + {$ctx:destinationAddresses} + {$ctx:alphabet} + {$ctx:message} + {$ctx:smscDeliveryReceipt} + {$ctx:messageClass} + {$ctx:isCompressed} + {$ctx:esmclass} + {$ctx:protocolid} + {$ctx:priorityflag} + {$ctx:replaceIfPresentFlag} + {$ctx:submitDefaultMsgId} + {$ctx:validityPeriod} + + ``` + + **Sample request** + + Following is a sample REST/JSON request that can be handled by the sendbulkSMS operation. + ```json + { + "host": "127.0.0.1", + "port": 2775, + "systemId": "DAMIEN", + "password": "neimad", + "systemType": "UNKNOWN", + "addressTon": "UNKNOWN", + "addressNpi": "UNKNOWN", + "serviceType": "CMT", + "sourceAddressTon": "NETWORK_SPECIFIC", + "sourceAddressNpi": "INTERNET", + "sourceAddress": "16116", + "destinationAddresses": { + "type": "ALPHANUMERIC", + "numberingPlan": "LAND_MOBILE", + "mobileNumbers": ["+zad", "+189718674"] + }, + "messageClass":"CLASS1", + "alphabet": "ALPHA_DEFAULT", + "isCompressed":"true", + "esmclass": "0", + "protocolid": "0", + "priorityflag":"1", + "replaceIfPresentFlag": "0", + "submitDefaultMsgId": "1", + "validityPeriod": “020610233429000R”, + "message": "hi hru", + "smscDeliveryReceipt": "SUCCESS_FAILURE", + "enquireLinkTimer": "50000", + "transactionTimer": "100" + } + ```