{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Get Message","type":"basic","slug":"sms-get-message","excerpt":"API to retrieve a single SMS message","body":"[block:api-header]\n{\n  \"title\": \"Use the SMS Get Message API to retrieve a single SMS message\"\n}\n[/block]\nThe SMS Get Message API is used to retrieve a single SMS message sent to/from a DialogTech SMS enabled tracking number when the message ID is known.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for SMS Get Message\",\n  \"body\": \"https://secure.dialogtech.com/ibp_api.php\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Parameter List\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Accepts\",\n    \"h-3\": \"Max Length\",\n    \"h-4\": \"Notes\",\n    \"h-5\": \"Usage\",\n    \"0-0\": \"action\",\n    \"0-1\": \"Yes\",\n    \"0-2\": \"String: **sms.get_message**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **sms.get_message** to retrieve an SMS Message\",\n    \"0-5\": \"Defines the API Call as \\\"SMS Get Message\\\" type\",\n    \"1-0\": \"access_key\",\n    \"1-1\": \"Yes\",\n    \"1-2\": \"String\",\n    \"1-3\": \"n/a\",\n    \"2-0\": \"secret_access_key\",\n    \"2-1\": \"Yes\",\n    \"2-2\": \"String\",\n    \"2-3\": \"n/a\",\n    \"1-4\": \"Access Key from the Key Manager within a DialogTech account\",\n    \"1-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-4\": \"Secret Access Key from the Key Manager within a DialogTech account\",\n    \"3-0\": \"msg_id\",\n    \"3-1\": \"Yes\",\n    \"3-2\": \"Message ID\",\n    \"3-3\": \"n/a\",\n    \"3-4\": \"Message ID of a previously sent/received SMS message\",\n    \"3-5\": \"Filters the response to only include SMS records where the message ID matches the `msg_id` provided\"\n  },\n  \"cols\": 6,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\nThese code examples are meant to show a basic method of accessing DialogTech's IVR Report API.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n  /*\\n    SMS Get Message EX:\\n    This example will retrieve a\\n    single SMS message with ID\\n    133185904.\\n  */\\n\\n  // Create cURL resource\\n  $ch = curl_init(); \\n  $baseuri = \\\"https://secure.dialogtech.com/ibp_api.php?\\\";\\n\\n  // API Specific Static Parameters\\n  $action = \\\"sms.get_message\\\";\\n\\n  // Required User Parameters To Request the API\\n  $access_key = \\\"foo\\\";\\n  $secret_access_key = \\\"bar\\\";\\n  $msg_id = \\\"133185904\\\";\\n\\n  // Construct the full URL\\n  $full_url = $baseuri . \\\"&action=\\\" . $action .\\n    \\\"&access_key=\\\" . $access_key .\\n    \\\"&secret_access_key=\\\" . $secret_access_key .\\n    \\\"&msg_id=\\\" . $msg_id;\\n\\n\\n  // Set the URL\\n  curl_setopt($ch, CURLOPT_URL, $full_url);\\n\\n  // Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure\\n  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\\n\\n  // Sets the $output variable to the result of the curl\\n  $output = curl_exec($ch);\\n\\n  // Close curl resource to free up system resources\\n  curl_close($ch);\\n\\n  // Echo the XML response to the page\\n  echo $output;\\n?>\",\n      \"language\": \"php\",\n      \"name\": \"PHP Example\"\n    }\n  ]\n}\n[/block]\n**Example Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<!DOCTYPE response [\\n<!ELEMENT response (result,result_description,data)>\\n<!ELEMENT result (#PCDATA)>\\n<!ELEMENT result_description (#PCDATA)>\\n<!ELEMENT data (message+)>\\n<!ELEMENT message (msg_id, to, from, message, date)>\\n<!ELEMENT msg_id (#PCDATA)>\\n<!ELEMENT to (#PCDATA)>\\n<!ELEMENT from (#PCDATA)>\\n<!ELEMENT message (#PCDATA)>\\n<!ELEMENT date (#PCDATA)>\\n]>\\n<response>\\n    <result>success</result>\\n    <result_description>[1] Message(s) Returned</result_description>\\n    <data>\\n        <message>\\n        <msg_id>133185904</msg_id>\\n        <to>5554443210</to>\\n        <from>5554443210</from>\\n        <message><![CDATA[Thanks again for taking my call. As we discussed, the product you're interested in is number 012345. Happy New Year!]]></message>\\n        <date>2017-01-01 10:07:31</date>\\n        </message>\\n    </data>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"58fdfbb166396d23003a0563","__v":0,"createdAt":"2017-04-24T13:20:49.577Z","parentDoc":null,"project":"558d9c32beb7c719007f6319","user":"58cadf93d223510f005d27db","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"_id":"558d9c33beb7c719007f631c","createdAt":"2015-06-26T18:38:43.154Z","project":"558d9c32beb7c719007f6319","releaseDate":"2015-06-26T18:38:43.153Z","__v":19},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"SMS APIs","slug":"sms-apis","order":3,"from_sync":false,"reference":false,"_id":"58fdfb438fbd2819000db9eb","createdAt":"2017-04-24T13:18:59.649Z","__v":0,"version":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319"},"githubsync":""}