Send Multiple Messages
method SendMultiple
url https://sms.smartmessagingservices.net/api/SendMultiple
Verb POST
Content Type application/json
Use the method to send to a list of recipients in a single POST request. Can be used for a Push Message Account or and SMS account.
Parameters
name | meaning | requirements example |
---|---|---|
username | AppSender or PushSender API Username | must be same username as used in the messaging gateway system |
password | AppSender or PushSender API Password | must be same password as used in the messaging gateway system |
text | Content of Message. Not that you can also provide message content for each destination address - text value is used of messageContent is empty | You must put a value in here even if message content is defined in the recipient list. otherwise method will return with error code. |
sender | The source address of the message | For a Push message this must be the dedicated number leased the PushSender Account) otherwise can be any mobile number or upto 11 Characters Alpha |
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 "dd/MM/yyyy HH:mm:ss zzz" eg "28/10/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. |
recipients | list of destinationAddress and messageContent. | If messageContent is null, content from the "text" field will be used as the message content. destinationAddress is international mobile number. 61401328000. Note that in any one call the list of destinations should be made up of unique destination address. |
id | id for the message from the customers system. | string format |
Json Structure
{ "username" : "peter", "password" : "thing", "text" : "new message to all", "sender" : "61401002002", "validity" : "00:02:00", "scheduled" : "today", "recipients" : [ { "destinationAddress" : "61401328025", "messageContent":"","id":"12345"}, { "destinationAddress" : "61401328026", "messageContent":"","id":"12346"}, { "destinationAddress" : "61401328027", "messageContent":"","id":"12347"}, { "destinationAddress" : "61401328028", "messageContent":"","id":"12348"} ] }
C# Model Structure
public class MultipleSMS { public string username { get; set; } public string password { get; set; } public string text { get; set; } public string sender { get; set; } public List<recipient> recipients { get; set; } public string validity { get; set; } public string scheduled { get; set; } } public class recipient { public string destinationAddress { get; set; } public string messageContent { get; set; } public string id { get; set; } }
The Method Returns Json String with an array of recipients contained in the message send request giving the individual messageIds by destination address for mapping final delivery status.
{ "messageStatus": 11, "documentId": "14b777bc-f786-4238-a200-d8a418841cef", "recipients": [ { "destinationAddress": "61401328025", "messageId": "60e9c8c1-ecca-405c-838f-e8c28f8a1dd0", "id":"123456" } ] }
Note that recipient will also be empty string. documentId refers to Id that relates to all the destination address in the send request
Send Multiple with Basic Authentication
method SendMultiple
url https://sms.smartmessagingservices.net/api/SendMultiple/BasicAuth
Verb POST
Content Type application/json
User and password in included in the http header in basic auth format.
Use the method to send to a list of recipients in a single POST request. Can be used for a Push Message Account or and SMS account.
Parameters
name | meaning | requirements example |
---|---|---|
text | Content of Message. Not that you can also provide message content for each destination address - text value is used of messageContent is empty | You must put a value in here even if message content is defined in the recipient list. otherwise method will return with error code. |
sender | The source address of the message | For a Push message this must be the dedicated number leased the PushSender Account) otherwise can be any mobile number or upto 11 Characters Alpha |
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 "dd/MM/yyyy HH:mm:ss zzz" eg "28/10/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. |
recipients | list of destinationAddress and messageContent. | If messageContent is null, content from the "text" field will be used as the message content. destinationAddress is international mobile number. 61401328000. Note that in any one call the list of destinations should be made up of unique destination address. |
id | id for the message from the customers system. | string format |
Json Structure
{ "text" : "new message to all", "sender" : "61401002002", "validity" : "00:02:00", "scheduled" : "today", "recipients" : [ { "destinationAddress" : "61401328025", "messageContent":"","id":"12345"}, { "destinationAddress" : "61401328026", "messageContent":"","id":"12346"}, { "destinationAddress" : "61401328027", "messageContent":"","id":"12347"}, { "destinationAddress" : "61401328028", "messageContent":"","id":"12348"} ] }
C# Model Structure
public class MultipleSMS { public string text { get; set; } public string sender { get; set; } public List<recipient> recipients { get; set; } public string validity { get; set; } public string scheduled { get; set; } } public class recipient { public string destinationAddress { get; set; } public string messageContent { get; set; } public string id { get; set; } }
The Method Returns Json String with an array of recipients contained in the message send request giving the individual messageIds by destination address for mapping final delivery status.
{ "messageStatus": 11, "documentId": "14b777bc-f786-4238-a200-d8a418841cef", "recipients": [ { "destinationAddress": "61401328025", "messageId": "60e9c8c1-ecca-405c-838f-e8c28f8a1dd0", "id":"123456" } ] }