{"_id":"568ff60b4719c119002ce630","project":"568fce2a04440a1700e4cb47","category":{"_id":"5693b82173f48f0d0075c90d","version":"568fce2b04440a1700e4cb4a","pages":["56ab8a0f678b58170031ebab","56ab93620b9e0b0d00616245","56af63088be2ea0d00b4886e","56d02fc81991690b003b2a8e"],"project":"568fce2a04440a1700e4cb47","__v":4,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-11T14:11:45.170Z","from_sync":false,"order":8,"slug":"inbound-message-forwarding","title":"Forwarding"},"version":{"_id":"568fce2b04440a1700e4cb4a","project":"568fce2a04440a1700e4cb47","__v":20,"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"},"parentDoc":null,"user":"55116f88e2990b0d00fb0552","__v":17,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-08T17:46:51.509Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"If you need to check the status of messages you've sent using one of our Messaging APIs, you can request that delivery receipts are forwarded to a URL of your choosing. Simply specify the URL when you send your message in the deliveryStatusUrl parameter.\n\n##Security\nAlthough you can specify an HTTP URL, we recommend that you specify HTTPS to ensure data security. We use only TLS 2048 bit encryption. We do not support SSL 2.0 or 3.0. Note that we cannot accommodate self signed certificates.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Receipt Handler\"\n}\n[/block]\nOutbound message receipts can be forwarded to a URL of your choosing via HTTP GET. This URL must be publicly accessible, e.g. http:<span></span>//forwarding.example.com/ReceiptHandler\nIn order to receive Receipts via HTTP, messages need to be submitted through the [Send Messages](doc:rest-messaging-send-messages) REST API method or the [SendMessageCollection](doc:soap-messaging-sendmessagecollection) SOAP API method.\n\nYour URL handler must be publicly accessible and be capable of processing the received message within 10 seconds. Once you have processed you should return an HTTP 200 OK response. If we don’t receive a 200 OK response within 10 seconds the submission will be considered failed and be retried later. See [Forwarding Retries](doc:forwarding-retries)  for more details.\n\nAn example of the full URL a handler would expect to receive is:\n\n**http:<span></span>//forwarding.example.com/ReceiptHandler?tranid=11111111&messageguid=9e81a3d4-5e24-4739-8abc-2264abc54cde&statusid=1&recipient=447798654321&statusdescription=Messages+delivered+to+handset&datetime=2010-01-01T13:39:00.500&clientref=001**\n\n## Query String Data\nThe Query String parameters and their values are:\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"<code>tranid</code>\",\n    \"0-1\": \"The integer transaction id of the message. This identifies the original submission so will cover the whole batch.\",\n    \"1-0\": \"<code>messageguid</code>\",\n    \"2-0\": \"<code>recipient</code>\",\n    \"3-0\": \"<code>statusid</code>\",\n    \"4-0\": \"<code>statusdescription</code>\",\n    \"5-0\": \"<code>datetime</code>\",\n    \"6-0\": \"<code>clientref</code>\",\n    \"7-0\": \"<code>submissiontime</code>\",\n    \"8-0\": \"<code>messagetext</code>\",\n    \"1-1\": \"A global unique identifier value for the message that was submitted. If not supplied by the user then we create one\",\n    \"2-1\": \"The phone number the message was sent to\",\n    \"3-1\": \"The integer ID of the [Message Status](doc:message-statuses)\",\n    \"4-1\": \"he description of the status of the message (see [Message Statuses](doc:message-statuses))\",\n    \"5-1\": \"The date and time the receipt was received in the form “yyyy-mm-ddThh:mm:ss:mmm” with T as a separator - ISO8601 standard. Note: this may not correlate with the time the handset received the message due to receipting delays.\",\n    \"6-1\": \"The clientref 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 receipt\",\n    \"7-1\": \"The time the message was sent to the handset in the form “yyyy-mm-ddThh:mm:ss:mmm” with T as a separator - ISO8601 standard\",\n    \"8-1\": \"The message text that was sent. **Note:** This field is only forwarded when using the SOAP Messaging API's [SendMessageCollection](doc:soap-messaging-sendmessagecollection) method and setting the includeMessageTextInDeliveryStatus flag.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]","excerpt":"","slug":"receipt-forwarding","type":"basic","title":"Receipt Forwarding"}

Receipt Forwarding


If you need to check the status of messages you've sent using one of our Messaging APIs, you can request that delivery receipts are forwarded to a URL of your choosing. Simply specify the URL when you send your message in the deliveryStatusUrl parameter. ##Security Although you can specify an HTTP URL, we recommend that you specify HTTPS to ensure data security. We use only TLS 2048 bit encryption. We do not support SSL 2.0 or 3.0. Note that we cannot accommodate self signed certificates. [block:api-header] { "type": "basic", "title": "Receipt Handler" } [/block] Outbound message receipts can be forwarded to a URL of your choosing via HTTP GET. This URL must be publicly accessible, e.g. http:<span></span>//forwarding.example.com/ReceiptHandler In order to receive Receipts via HTTP, messages need to be submitted through the [Send Messages](doc:rest-messaging-send-messages) REST API method or the [SendMessageCollection](doc:soap-messaging-sendmessagecollection) SOAP API method. Your URL handler must be publicly accessible and be capable of processing the received message within 10 seconds. Once you have processed you should return an HTTP 200 OK response. If we don’t receive a 200 OK response within 10 seconds the submission will be considered failed and be retried later. See [Forwarding Retries](doc:forwarding-retries) for more details. An example of the full URL a handler would expect to receive is: **http:<span></span>//forwarding.example.com/ReceiptHandler?tranid=11111111&messageguid=9e81a3d4-5e24-4739-8abc-2264abc54cde&statusid=1&recipient=447798654321&statusdescription=Messages+delivered+to+handset&datetime=2010-01-01T13:39:00.500&clientref=001** ## Query String Data The Query String parameters and their values are: [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Value", "0-0": "<code>tranid</code>", "0-1": "The integer transaction id of the message. This identifies the original submission so will cover the whole batch.", "1-0": "<code>messageguid</code>", "2-0": "<code>recipient</code>", "3-0": "<code>statusid</code>", "4-0": "<code>statusdescription</code>", "5-0": "<code>datetime</code>", "6-0": "<code>clientref</code>", "7-0": "<code>submissiontime</code>", "8-0": "<code>messagetext</code>", "1-1": "A global unique identifier value for the message that was submitted. If not supplied by the user then we create one", "2-1": "The phone number the message was sent to", "3-1": "The integer ID of the [Message Status](doc:message-statuses)", "4-1": "he description of the status of the message (see [Message Statuses](doc:message-statuses))", "5-1": "The date and time the receipt was received in the form “yyyy-mm-ddThh:mm:ss:mmm” with T as a separator - ISO8601 standard. Note: this may not correlate with the time the handset received the message due to receipting delays.", "6-1": "The clientref 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 receipt", "7-1": "The time the message was sent to the handset in the form “yyyy-mm-ddThh:mm:ss:mmm” with T as a separator - ISO8601 standard", "8-1": "The message text that was sent. **Note:** This field is only forwarded when using the SOAP Messaging API's [SendMessageCollection](doc:soap-messaging-sendmessagecollection) method and setting the includeMessageTextInDeliveryStatus flag." }, "cols": 2, "rows": 9 } [/block]