Send Single Message
These two methods allows a customer's system to send Messages to a Recipient our Message Service. The message delivery is addressed by the destination phone number and will be delivered sent via SMS.
Method Name SendSingle2
EndPoint https://sms.smartmessagingservices.net/api/SendSingle2
End point supports POST verb with JSON content, and returns and JSON response.
Content type: application/json - (this method also accepts x-www-form-urlencoded content - use the same properties as with JSON)
Authentication username and password included in the body.
Message Text Encoding. GSM or UFT-16 character encoding for the message is automatically selected based on the characters used in your message NOTE nbsp spaces and Tabs are converted to standard spaces to maintain the Encoding type of GSM. There are also two common characters for apostrophe which we also convert to the GSM character for you.
Parameters
Parameter Name | Requirements | Notes |
username | username as per the Sender APIUsername value | |
password | password as per the Sender APIPassword value. | |
recipient | mobile number international format without the leading + sign | 61401328000 |
sender | mobile number international format without the leading + sign. This must be the customers allocated virtual number Assigned by Intelli and that is the Id field of the Sender Record | 61416907101 |
| text | Content of the text message. Message with only GSM characters will be sent as standard messages - messages with other characters will be sent in UTF-16, in the case each message can only contain 70 Characters instead of 160. Character set conversion is automatic. Note that "<br>'" will be replace with a line return. | |
| validity | Time period that the message will continue to retry if recipient is not immediately available to receive the message | for "dd:HH:mm", max value is 03:00:00, 24 hour format for hours or "00:18:00" . either exclude parameter value or set to "00:00:00" for default gateway default validity. |
| scheduled | Time and Date message is to be delivered | specified in format "yyyy-MM-ddTHH:mm:sszzz" or "yyyy-MM-ddTHH:mm:ss" "dd/MM/yyyy HH:mm:ss zzz " "eg "2018-03-01T15:24:16+10:00" or "2018-03-01T15:24:16" or "01/03/2018 15:24:16 +10:00"Hours in 24 hour format time zone in hour:mins format with = or - sign. exclude parameter to send message immediately, or set the currently date time value. if time zone is not specified it will be assumed to be UTC time. |
| countryCode | The country where the recipient MSISDN is issued is 2 letter code or the standard country name | eg Australia = "AU". New Zealand = "NZ". This is used to help validate the recipient mobile number - if specified the recipient number can be provide in local format. Can also be "Australia" or "New Zealand" |
Method SendSingle2/BasicAuth.
Used in Zapier Method, "Send an MT SMS Message Action"
End Point api/SendSingle2/BasicAuth
End point supports POST verb with JSON content, and returns and JSON response.
Content type: application/json. - (this method also accepts x-www-form-urlencoded content - use the same properties as with JSON)
Authentication Use Basic auth "username:password" converted to Base64
Message Text Encoding. GSM or UFT-16 character encoding for the message is automatically selected based on the characters used in your message NOTE nbsp spaces and Tabs are converted to standard spaces to maintain the Encoding type of GSM. There are also two common characters for apostrophe which we also convert to the GSM character for you.
Parameters
Parameter Name | Requirements | Notes |
recipient | mobile number international format without the leading + sign | eg 61401328000. If recipientCountry is defined then the mobile number can be in local format eg 0401328000 |
sender | mobile number international format without the leading + sign. This must be the customers allocated virtual number Assigned by Intelli and that is the Id field of the Sender Record | eg 61416907101, can also be a name up to 11 characters long. |
| text | Content of the text message. Message with only GSM characters will be sent as standard messages - messages with other characters will be sent in UTF-16, in the case each message can only contain 70 Characters instead of 160. Character set conversion is automatic | |
| validity | Time period that the message will continue to retry if recipient is not immediately available to receive the message | for "dd:HH:mm", max value is 03:00:00, 24 hour format for hours or "00:18:00" . either exclude parameter value or set to "00:00:00" for default gateway default validity. |
| scheduled | Time and Date message is to be delivered | specified in format "yyyy-MM-ddTHH:mm:sszzz" or "yyyy-MM-ddTHH:mm:ss" "dd/MM/yyyy HH:mm:ss zzz " "eg "2018-03-01T15:24:16+10:00" or "2018-03-01T15:24:16" or "01/03/2018 15:24:16 +10:00"Hours in 24 hour format time zone in hour:mins format with = or - sign. exclude parameter to send message immediately, or set the currently date time value. if time zone is not specified it will be assumed to be UTC time. |
recipientCountry | The country where the recipient MSISDN is issued is 2 letter code or the standard country name | eg Australia = "AU". New Zealand = "NZ". This is used to help validate the recipient mobile number - if specified the recipient number can be provide in local format. Can also be "Australia" or "New Zealand" |
These method parameters have been explained for use with the push message service assuming that Intelli Messaging has set the message source address against the user record with our messaging system.
Method SendSingle2/Circle
EndPoint https://sms.smartmessagingservices.net/api/SendSingle2/Circle
End point supports POST verb with JSON content, and returns and JSON response.
Content type: application/json
Authentication username and password included in the body.
Message Body Construct
{
"from":"FBAU",
"to":"61401328025",
"text":"Test",
"providerParameters":{
"username":"xxxxxxxxx",
"password":"xxxxxxxx"
}
}
Circle does add a context property but this is ignored
Response Message for the Above Methods
Message Response JSON String
{ "documentId":"508fb3bfe4b0a193c539f559", "recipient":"33333333", "messageStatus": 11, "statusCode": 11, "messageId":"508fb3bfe4b0a193c539f670", "SizeFactor":1 }
| parameter | meaning |
|---|---|
| documentId | id for the send request. Although this method only receives one destination other methods received multiple destinations in the one request. |
| recipient | Recipient address of the message - If recipient is validated this return the validated address in international format eg 61401000100 |
| messageStatus | Status of the send request - either 11 or an error code eg -200 |
| statusCode | Final status of the send to the recipient |
| messageId | Id for the single message. |
| SizeFactor | this is the number of message parts for the message. 0 if error, otherwise it is the number of message parts based on the message text. |
Message Status that can be returned and their meaning.
Message Response Codes and Meaning