{"__v":1,"_id":"5446bf6dae0040140035fa42","category":{"__v":3,"_id":"5446952b82bd7e08002768a0","pages":["544695e23168910800744da6","54480ac80319802200fc0761","5446bf6dae0040140035fa42"],"project":"542dbe0ecb19820800c1f4d7","version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-21T17:17:31.699Z","from_sync":false,"order":4,"slug":"sms","title":"SMS"},"editedParams":true,"editedParams2":true,"is_link":false,"parentDoc":null,"project":"542dbe0ecb19820800c1f4d7","user":"542dc547cb19820800c1f4f1","version":{"__v":29,"_id":"542ecc0a6b0eb6080066ca77","forked_from":"542dbe0fcb19820800c1f4da","project":"542dbe0ecb19820800c1f4d7","createdAt":"2014-10-03T16:17:14.165Z","releaseDate":"2014-10-03T16:17:14.165Z","categories":["542ecc0a6b0eb6080066ca78","542ef44f6b0eb6080066cb24","543bf3e22a30961a00b66eb3","5446952b82bd7e08002768a0","544821ae8d7af31a00dd41ce","544a7885f1aefa08006efc69","544c758e11845f0e001ed8de","544e5565b80812080035be55","544e558dbd51b9080037f8ca","5450b045a66f020800dba73d","5450eb6aa66f020800dba945","5450f39ea66f020800dba989","5450f877a66f020800dba9cf","54510356a66f020800dbaa17","5451274514af501a00b50c99","54513345a66f020800dbab24","54513cc014af501a00b50d24","54515eec14af501a00b50db9","54519b1d14af501a00b50ea9","54519b2aa66f020800dbacb4","54524f9704160008005b1d27","54538d2308d1800800473d95","54538d420c09721000a06a03","54538e5608d1800800473d9a","5453ea9547c30114004fb375","5453eb12b077c31c00067bcb","5453eb27b077c31c00067bcd","5453ed5db077c31c00067bde","548075cbe291c51a00e7e096"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-21T20:17:49.801Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":true,"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"Success","code":"{\n    \"page\": 0, \n    \"num_pages\": 8 ,\n    \"page_size\": 50,\n    \"total\": 433,\n    \"start\": 0,\n    \"end\": 49, \n    \"uri\": \"/v2/Accounts/{AccountSid}/SMS/Messages.json\",\n    \"first_page_uri\": \"/v2/Accounts/{AccountSid}/SMS/Messages.json?Page=0&PageSize=50\",\n    \"previous_page_uri\": null,\n    \"next_page_uri\": \"/v2/Accounts/{AccountSid}/SMS/Messages.json?Page=1&PageSize=50\",\n    \"last_page_uri\": \"/v2/Accounts/{AccountSid}/SMS/Messages.json?Page=7&PageSize=50\",\n    \"sms_messages\": [\n\n    {\n    \"api_version\": \"v2\",\n    \"sid\": \"{SmsSid}\",\n    \"account_sid\": \"{AccountSid}\",\n    \"date_created\": \"Fri, 27 Jul 2012 13:32:42 +0000\",\n    \"date_updated\": \"Fri, 27 Jul 2012 13:32:42 +0000\",\n    \"date_sent\": \"Fri, 27 Jul 2012 13:32:42 +0000\",\n    \"to\": \"+17325551234\",\n    \"from\": \"+14245551234\",\n    \"body\": \"Hi, this is an SMS\",\n    \"status\": \"sent\",\n    \"direction\": \"outbound-api\",\n    \"price\": \"0.070000\",\n    \"uri\": \"/v2/Accounts/{AccountSid}/SMS/Messages/{SmsSid}.json\"\n    }\n\n\n    , \n    {\n    \"api_version\": \"v2\",\n    \"sid\": \"{SmsSid}\",\n    \"account_sid\": \"{AccountSid}\",\n    \"date_created\": \"Fri, 27 Jul 2012 13:31:43 +0000\",\n    \"date_updated\": \"Fri, 27 Jul 2012 13:31:45 +0000\",\n    \"date_sent\": \"Fri, 27 Jul 2012 13:31:44 +0000\",\n    \"to\": \"+17325551234\",\n    \"from\": \"+14245551234\",\n    \"body\": \"test message\",\n    \"status\": \"sent\",\n    \"direction\": \"outbound-api\",\n    \"price\": \"0.070000\",\n    \"uri\": \"/v2/Accounts/{AccountSid}/SMS/Messages/{SmsSid}.json\"\n    }\n\n    ...\n\n    ]\n}       ","language":"json"},{"name":"Failure","code":"{\n    \"status\": 404,\n    \"message\": \"The requested resource was not found: /v2/Accounts/bad/bad_response.json\"\n}","language":"json","status":404}]},"settings":"","try":true,"auth":"required","params":[{"_id":"5446bf6dae0040140035fa48","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"5446bf6dae0040140035fa47","ref":"","in":"query","required":false,"desc":"List all SMS sent to this number. The value does not have to be in any specific format.","default":"","type":"string","name":"To"},{"_id":"5446bf6dae0040140035fa46","ref":"","in":"query","required":false,"desc":"List all SMS sent from this number. The value does not have to be in any specific format.","default":"","type":"string","name":"From"},{"_id":"5446bf6dae0040140035fa45","ref":"","in":"query","required":false,"desc":"Lists all SMS messages sent beginning on or from a certain date. Date ranges can also be used, such as \"DateSent>=YYYY-MM-DD\".","default":"","type":"string","name":"DateSent"},{"_id":"5446bf6dae0040140035fa44","ref":"","in":"query","required":false,"desc":"Used to return a particular page within the list.","default":"","type":"string","name":"Page"},{"_id":"5446bf6dae0040140035fa43","ref":"","in":"query","required":false,"desc":"Used to specify the amount of list items to return per page.","default":"","type":"string","name":"PageSize"}],"url":"/v2/Accounts/:AccountSid/SMS/Messages.json"},"isReference":false,"order":2,"body":"Request this endpoint with no parameters to see all SMS associated with your account.\n\n# **Response Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"first_page_uri\",\n    \"1-0\": \"end\",\n    \"2-0\": \"total\",\n    \"3-0\": \"previous_page_uri\",\n    \"4-0\": \"num_pages\",\n    \"5-0\": \"uri\",\n    \"6-0\": \"page_size\",\n    \"7-0\": \"start\",\n    \"8-0\": \"next_page_uri\",\n    \"9-0\": \"last_page_uri\",\n    \"10-0\": \"page\",\n    \"0-1\": \"URI for the first page of results.\",\n    \"1-1\": \"Last result index.\",\n    \"2-1\": \"Number of items.\",\n    \"3-1\": \"URI for the previous page of results.\",\n    \"4-1\": \"Number of pages.\",\n    \"5-1\": \"The Uniform Resource Identifier to this resource.\",\n    \"6-1\": \"Number of items on a single page.\",\n    \"7-1\": \"Index of the first item on the current page.\",\n    \"8-1\": \"URI for the next page of the results.\",\n    \"9-1\": \"URI for the last page of the results.\",\n    \"10-1\": \"Current page number.\",\n    \"11-0\": \"sms_messages\",\n    \"11-1\": \"Array containing SMS messages.\"\n  },\n  \"cols\": 2,\n  \"rows\": 12\n}\n[/block]\nResponse parameters for SMS messages are equal to those on [\"View SMS\" API call](/v2/docs/view-sms).\n\n# **Example cURL**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET 'https://api.zang.io/v2/Accounts/{AccountSid}/SMS/Messages.json' -u '{AccountSid}:{AuthToken}'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"shows info on all SMS messages associated with some account","slug":"list-sms","type":"endpoint","title":"List SMS"}

getList SMS

shows info on all SMS messages associated with some account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Account SID.

Query Params

To:
string
List all SMS sent to this number. The value does not have to be in any specific format.
From:
string
List all SMS sent from this number. The value does not have to be in any specific format.
DateSent:
string
Lists all SMS messages sent beginning on or from a certain date. Date ranges can also be used, such as "DateSent>=YYYY-MM-DD".
Page:
string
Used to return a particular page within the list.
PageSize:
string
Used to specify the amount of list items to return per page.

Result Format


Documentation

Request this endpoint with no parameters to see all SMS associated with your account. # **Response Parameters** [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "first_page_uri", "1-0": "end", "2-0": "total", "3-0": "previous_page_uri", "4-0": "num_pages", "5-0": "uri", "6-0": "page_size", "7-0": "start", "8-0": "next_page_uri", "9-0": "last_page_uri", "10-0": "page", "0-1": "URI for the first page of results.", "1-1": "Last result index.", "2-1": "Number of items.", "3-1": "URI for the previous page of results.", "4-1": "Number of pages.", "5-1": "The Uniform Resource Identifier to this resource.", "6-1": "Number of items on a single page.", "7-1": "Index of the first item on the current page.", "8-1": "URI for the next page of the results.", "9-1": "URI for the last page of the results.", "10-1": "Current page number.", "11-0": "sms_messages", "11-1": "Array containing SMS messages." }, "cols": 2, "rows": 12 } [/block] Response parameters for SMS messages are equal to those on ["View SMS" API call](/v2/docs/view-sms). # **Example cURL** [block:code] { "codes": [ { "code": "curl -X GET 'https://api.zang.io/v2/Accounts/{AccountSid}/SMS/Messages.json' -u '{AccountSid}:{AuthToken}'", "language": "shell" } ] } [/block]