SendMessageCollection

The SendMessageCollection method allows you to send single or multiple messages to one or more international phones numbers. With it you can send: * a single message to a single phone number * the same message to multiple phone numbers * different messages to multiple phone numbers [block:callout] { "type": "info", "title": "We recommended a maximum of 250 messages are submitted in a single call to this method." } [/block] [block:callout] { "type": "danger", "title": "Any non GSM character will cause your SMS to be sent as a Unicode message", "body": "If your message contains **any** characters that are not included in the [GSM](https://comapi.zendesk.com/hc/en-us/articles/206917189-GSM-Alphabet-Character-Set-) or [Extended GSM](https://comapi.zendesk.com/hc/en-us/articles/206917189-GSM-Alphabet-Character-Set-) character sets then the message will be encoded entirely as Unicode (UTF-16) and therefore each character will take 16 bits instead of 7 bits more than **halving the amount of characters per SMS and potentially doubling your costs!**\n\nFind out more about [SMS Message Encoding](doc:message-encoding)\nFind out more about [SMS Message Segmentation](doc:message-segmentation)" } [/block] <div class="alert alert-success"><div class="label label-success">SOAP Action</div>   **http://<span></span>www.services.dynmark.com/SendMessageCollection**</div> **Note**: Parameter and property names shown in bold are required [block:parameters] { "data": { "0-0": "<code>name</code><span class=\"c-danger\">*</span>", "1-0": "<code>password</code><span class=\"c-danger\">*</span>", "2-0": "<code>message</code><span class=\"c-danger\">*</span>", "2-1": "An array of one or more [Message](#section-message-object) objects", "1-1": "Registered Dynmark password", "0-1": "Registered Dynmark username", "h-0": "Parameter", "h-1": "Description" }, "cols": 2, "rows": 3 } [/block] ##Message Object Note: Field names shown in bold are required whereas non-bold are optional [block:parameters] { "data": { "0-0": "<code>recipients</code><span class=\"c-danger\">*</span>", "1-0": "<code>text</code><span class=\"c-danger\">*</span>", "2-0": "<code>originator</code>", "0-1": "An array of strings, each string containing a single international format phone number, e.g. 447123123456", "1-1": "The message text", "2-1": "A string containing the originator (from) value.\nThis can be either:\n* Numeric: between 2-15 characters, permitted characters 0-9 \n* Alphanumeric: between 2-11 characters 0-9, a-z, A-Z, hyphen, underscore, full-stop and space e.g. MAYFLOWER.\nIf no originator is set this will automatically assign a default number so that the recipient may reply to the message. If you have purchased a dedicated number this can be used as the originator.", "3-0": "<code>validUntil</code>", "4-0": "<code>deliverAfter</code>", "5-0": "<code>clientRef</code>", "6-0": "<code>deliveryStatusUrl</code>", "9-0": "<code>filterSetName</code>", "10-0": "<code>impersonateUserName</code>", "11-0": "<code>messageGuid</code>", "11-1": "An optional unique identifier for this submission. If the supplied value matches a previous submitted value, the associated messages are assumed to be a duplicate submission and are ignored. The value can be any string up to 36 characters long although we recommend the use of a GUID to ensure uniqueness. If a value is not specified, the service generates a new GUID.", "10-1": "If you are a reseller and have requested the send as client feature, you can specify the username of one of your clients to send messages using that client’s account.", "9-1": "If you have enabled Intelligent Filtering on your account, in the user portal, you can specify which filter set is applied to this message.", "6-1": "A callback URL that will have the delivery status for the SMS sent to it. See [Receipt Forwarding](receipt-handler) for more details.", "5-1": "An string value (with a maximum length of 64 characters) that will be returned with the delivery status to allow you to pass integration information. See [Tracking Conversations](doc:tracking-converstations) for more details.", "4-1": "A date time in XML date format, specifying when we should try to deliver the message.", "3-1": "A date time in XML date format, specifying how long we should try to deliver the message for.", "h-0": "Property", "h-1": "Description", "12-0": "<code>additionalOptions</code>", "12-1": "A list of SMPP options expressed as key value pairs that are forwarded to the carrier.", "7-0": "<code>forwardSubmissionDeliveryStatus</code>", "8-0": "<code>includeMessageTextInDeliveryStatus</code>", "7-1": "When set to true, a “message sent” delivery status will be sent to *deliveryStatusUrl* in addition to final statuses for each message. Defaults to false.", "8-1": "When set to true, the information forwarded to *deliveryStatusUrl* will also include a *messagetext* field. Defaults to false." }, "cols": 2, "rows": 13 } [/block] ##Returns A SendMessageCollectionResult object an array of containing one or more [MessageResult](#section-messageresult-object) objects, each corresponding to each of the submitted Message objects. ##MessageResult Object [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "<code>transactionID</code><span class=\"c-danger\">*</span>", "1-0": "<code>recipients</code><span class=\"c-danger\">*</span>", "2-0": "<code>returnCode</code>", "3-0": "<code>returnDescription</code>", "4-0": "<code>returnDetail</code>", "4-1": "If the return code was a failure, this field contains a verbose description of the failure if one is available.", "3-1": "If the return code was a failure, this field contains a brief description of the failure.", "2-1": "If there was a failure during message processing, this contains the failure code.", "1-1": "An array of strings containing the recipients that this transaction was sent to.", "0-1": "An integer containing the transaction ID of the send." }, "cols": 2, "rows": 5 } [/block] ##Request Examples [block:code] { "codes": [ { "code": "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\">\n <soapenv:Header/>\n <soapenv:Body>\n <SendMessageCollection xmlns=\"http://www.services.dynmark.com/\">\n <name>@Username@</name>\n <password>@Password@</password>\n <message>\n <Message>\n <originator>Example</originator>\n <recipients>\n <string>447700900000</string>\n </recipients>\n <text>Hello, this is a test message</text>\n <clientRef>Your reference</clientRef>\n </Message>\n </message>\n </SendMessageCollection>\n </soapenv:Body>\n</soapenv:Envelope>", "language": "xml", "name": "Simple Send" }, { "code": "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\">\n <soapenv:Header/>\n <soapenv:Body>\n \t \t<SendMessageCollection xmlns=\"http://www.services.dynmark.com/\">\n <name>@Username@</name>\n <password>@Password@</password>\n <message>\n <Message>\n <originator>Example</originator>\n <recipients>\n <string>447700900000</string>\n </recipients>\n <text>Hello, this is a test message</text>\n <clientRef>Your reference</clientRef>\n <deliveryStatusURL>https://inbound.example.com/SmsReceipts</deliveryStatusURL>\n </Message>\n </message>\n </SendMessageCollection>\n </soapenv:Body>\n</soapenv:Envelope>", "language": "xml", "name": "Send with Receipts" }, { "code": "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\">\n <soapenv:Header/>\n <soapenv:Body>\n \t \t<SendMessageCollection xmlns=\"http://www.services.dynmark.com/\">\n <name>@Username@</name>\n <password>@Password@</password>\n <message>\n <Message>\n <originator>Example</originator>\n <recipients>\n <string>447700900000</string>\n </recipients>\n <text>Hello, this is a test message</text>\n <clientRef>Your reference</clientRef>\n </Message>\n <Message>\n <originator>Example</originator>\n <recipients>\n <string>447700900111</string>\n </recipients>\n <text>Hello, this is another test message</text>\n <clientRef>Your second reference</clientRef>\n </Message>\n </message>\n </SendMessageCollection>\n </soapenv:Body>\n</soapenv:Envelope>", "language": "xml", "name": "Batch Sends" } ] } [/block]

Dynmark

Dynmark Docs

C# Quickstarts

Node.js Quickstarts

Java Quickstarts

PHP Quickstarts

REST API

HTTP API

SOAP API

Forwarding

Email to SMS

Reference

3rd Party Integration

SendMessageCollection