{"__v":18,"_id":"56ab8e4e4e4b730d009eb0a9","category":{"__v":3,"_id":"568fd23804440a1700e4cb5b","pages":["569fb6a8b4f2d31900898ced","56ab2dc70b9e0b0d006161c4","56efbfcb20419a0e00113caa"],"project":"568fce2a04440a1700e4cb47","version":"568fce2b04440a1700e4cb4a","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-08T15:14:00.072Z","from_sync":false,"order":7,"slug":"soap-web-services","title":"SOAP API"},"parentDoc":null,"project":"568fce2a04440a1700e4cb47","user":"55116f88e2990b0d00fb0552","version":{"__v":20,"_id":"568fce2b04440a1700e4cb4a","project":"568fce2a04440a1700e4cb47","createdAt":"2016-01-08T14:56:43.101Z","releaseDate":"2016-01-08T14:56:43.101Z","categories":["568fce2b04440a1700e4cb4b","568fd1b8b700ce0d002f4b1c","568fd23804440a1700e4cb5b","568fd2444719c119002ce5d8","568ff21204440a1700e4cbc1","5693732c8aa8040d009f2c28","5693738393445b0d00abdad0","5693740093445b0d00abdad1","56937445974aaa0d001ca699","5693b82173f48f0d0075c90d","5694c4cd1005590d0062cb25","569f854466a5640d00efa54c","56a264cdd15dd70d008d825b","56aa56bf318e6c1700a19ddb","56b0e6347ae4550d000627bd","56b200c0f48f270d00e0de6f","56b200c6f48f270d00e0de70","56b22a9665ddf50d0076ba40","56e92ef71996862200fd7f42","574d6577fb835c0e00ca316a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-29T16:07:42.616Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"This method is restricted to authorised users only as of preferred method of sending data to customer is the [forwarding system](doc:inbound-message-forwarding), rather than polling for efficiency reasons. If you are interested in using this method please contact us to arrange access.\",\n  \"title\": \"Restricted Access\"\n}\n[/block]\nInbound messages received on a Dynmark long number or shortcode can be polled via a call to PollInboundMessages. Each call to this method will return a batch of inbound messages and a unique identifier for the start of the batch that can be used for replay in the event of an error within your own system.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Polling can be used to retrieve inbound messages up to 7 days old. Messages that are older than 7 days will not be returned.\"\n}\n[/block]\n##Request\n\n**For Soap 1.0 & 1.1 the service endpoint is**\n<div class=\"alert alert-success\"><div class=\"label label-success\">SOAP</div> &nbsp; **https://services.dynmark.com/WebServices/MessagingServicesWS.asmx**\n\n<div class=\"label label-success\">WSDL</div> &nbsp; **https://services.dynmark.com/WebServices/MessagingServicesWS.asmx?wsdl**</div>\n[block:parameters]\n{\n  \"data\": {\n    \"2-0\": \"<code>batchSize</code><span class=\\\"c-danger\\\">*</span>\",\n    \"4-0\": \"<code>impersonateUsername</code>\",\n    \"3-0\": \"<code>resetKey</code>\",\n    \"2-1\": \"The maximum number of inbound messages to return. This must be in the range 50-50,000, you should supply a batch size tuned to your system\",\n    \"4-1\": \"If you are a reseller, then passing the username of a child account’s user will fetch inbound messages for that user\",\n    \"3-1\": \"The optional batch key that can be used to rewind the system a specific batch in the event of a client error\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"<code>name</code><span class=\\\"c-danger\\\">*</span>\",\n    \"0-1\": \"Your username\",\n    \"1-0\": \"<code>password</code><span class=\\\"c-danger\\\">*</span>\",\n    \"1-1\": \"Your password\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n##Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"<code>InboundMessages</code><span class=\\\"c-danger\\\">*</span>\",\n    \"1-0\": \"<code>ResetKey</code><span class=\\\"c-danger\\\">*</span>\",\n    \"1-1\": \"A batch key that can be used to replay from the start of this batch in the event of a client error\",\n    \"0-1\": \"An array of [MessageReceipt](#section-inboundmessage-object) objects\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n##InboundMessage Object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The integer message id of the message, this is unique to this message\",\n    \"1-1\": \"The username of the Dynmark user that received the message\",\n    \"3-1\": \"The address the message was sent from. This is usually in the form of a phone number but can also be an alphanumeric if messages have been sent from automated systems such as a voicemail message notification\",\n    \"4-1\": \"The message content\",\n    \"6-1\": \"The client ref value is a value that can be populated by the user when a message is sent through the Dynmark Web Services. The value that was specified in the sent message will be returned on the inbound message if we can match the inbound to a submission\",\n    \"6-0\": \"<code>ClientReference</code><span class=\\\"c-danger\\\">*</span>\",\n    \"4-0\": \"<code>MessageContent</code><span class=\\\"c-danger\\\">*</span>\",\n    \"3-0\": \"<code>Sender</code><span class=\\\"c-danger\\\">*</span>\",\n    \"1-0\": \"<code>ReceivingUsername</code><span class=\\\"c-danger\\\">*</span>\",\n    \"0-0\": \"<code>MessageId</code><span class=\\\"c-danger\\\">*</span>\",\n    \"2-0\": \"<code>Recipient</code><span class=\\\"c-danger\\\">*</span>\",\n    \"2-1\": \"The phone number the message was sent to.\",\n    \"5-0\": \"<code>ReceivedDate</code><span class=\\\"c-danger\\\">*</span>\",\n    \"5-1\": \"The time the message was received on the Dynmark Platform\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"soap-polling-pollinboundmessages","type":"fn","title":"PollInboundMessages"}

fnPollInboundMessages


[block:callout] { "type": "warning", "body": "This method is restricted to authorised users only as of preferred method of sending data to customer is the [forwarding system](doc:inbound-message-forwarding), rather than polling for efficiency reasons. If you are interested in using this method please contact us to arrange access.", "title": "Restricted Access" } [/block] Inbound messages received on a Dynmark long number or shortcode can be polled via a call to PollInboundMessages. Each call to this method will return a batch of inbound messages and a unique identifier for the start of the batch that can be used for replay in the event of an error within your own system. [block:callout] { "type": "info", "body": "Polling can be used to retrieve inbound messages up to 7 days old. Messages that are older than 7 days will not be returned." } [/block] ##Request **For Soap 1.0 & 1.1 the service endpoint is** <div class="alert alert-success"><div class="label label-success">SOAP</div> &nbsp; **https://services.dynmark.com/WebServices/MessagingServicesWS.asmx** <div class="label label-success">WSDL</div> &nbsp; **https://services.dynmark.com/WebServices/MessagingServicesWS.asmx?wsdl**</div> [block:parameters] { "data": { "2-0": "<code>batchSize</code><span class=\"c-danger\">*</span>", "4-0": "<code>impersonateUsername</code>", "3-0": "<code>resetKey</code>", "2-1": "The maximum number of inbound messages to return. This must be in the range 50-50,000, you should supply a batch size tuned to your system", "4-1": "If you are a reseller, then passing the username of a child account’s user will fetch inbound messages for that user", "3-1": "The optional batch key that can be used to rewind the system a specific batch in the event of a client error", "h-0": "Parameter", "h-1": "Description", "0-0": "<code>name</code><span class=\"c-danger\">*</span>", "0-1": "Your username", "1-0": "<code>password</code><span class=\"c-danger\">*</span>", "1-1": "Your password" }, "cols": 2, "rows": 5 } [/block] ##Response [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "<code>InboundMessages</code><span class=\"c-danger\">*</span>", "1-0": "<code>ResetKey</code><span class=\"c-danger\">*</span>", "1-1": "A batch key that can be used to replay from the start of this batch in the event of a client error", "0-1": "An array of [MessageReceipt](#section-inboundmessage-object) objects" }, "cols": 2, "rows": 2 } [/block] ##InboundMessage Object [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-1": "The integer message id of the message, this is unique to this message", "1-1": "The username of the Dynmark user that received the message", "3-1": "The address the message was sent from. This is usually in the form of a phone number but can also be an alphanumeric if messages have been sent from automated systems such as a voicemail message notification", "4-1": "The message content", "6-1": "The client ref value is a value that can be populated by the user when a message is sent through the Dynmark Web Services. The value that was specified in the sent message will be returned on the inbound message if we can match the inbound to a submission", "6-0": "<code>ClientReference</code><span class=\"c-danger\">*</span>", "4-0": "<code>MessageContent</code><span class=\"c-danger\">*</span>", "3-0": "<code>Sender</code><span class=\"c-danger\">*</span>", "1-0": "<code>ReceivingUsername</code><span class=\"c-danger\">*</span>", "0-0": "<code>MessageId</code><span class=\"c-danger\">*</span>", "2-0": "<code>Recipient</code><span class=\"c-danger\">*</span>", "2-1": "The phone number the message was sent to.", "5-0": "<code>ReceivedDate</code><span class=\"c-danger\">*</span>", "5-1": "The time the message was received on the Dynmark Platform" }, "cols": 2, "rows": 7 } [/block]