{"_id":"5a3033cfddbce10028b68f13","project":"55843604fd8d910d007b9502","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":67,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136","599c6da8f180820025f14909","59b054613c3e1b0019cf27d9","59b1ceca2d6231003ad73e5f","59b1cf1857911600382e0dc4","59b1cf2730f3d60010c30ef7","59b1cf385d4b89003035441a","59b1cf5857911600382e0dc6","59bc2c4e26ac9b0010a8b753","59bc2ce20b3eb30010657b70","59f0c793ba3bc90030f413ab","59f0cd62f5ecda00325294b9","59fb55a8e8d0f600101aedc3","59fcb05c067f8d0028613f86","5a2af4a1bc5fba00283909c1","5a83673b0e56010012138c12","5a972f2e77b85a0070e4ebe2","5aa300224ed4b40012c53e1d","5acd20095efd8d000359bb3c","5ad50889c05179000306021e","5af0927a8779670003daff34","5b55a46b282b25000319669e"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"55d3c6befe37111900e536fa","pages":["56c25610c866aa1700109ad7"],"version":"558444ceafccfd0d00fcb2bb","__v":1,"project":"55843604fd8d910d007b9502","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-18T23:58:54.366Z","from_sync":false,"order":21,"slug":"distributions","title":"Distributions"},"user":"558435c2fb52ee0d0015d190","githubsync":"","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-12T19:53:51.849Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"curl -H 'X-API-TOKEN: yourtokenhere'\n'yourdatacenterid.qualtrics.com/API/v3/distributions/sms?surveyId=SV_012345678901234'","language":"curl"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"result\": {\n    \"elements\": [\n      {\n        \"id\": \"SMSD_012345678901234\",\n \t\t\t\t\"name\": \"mySMSDistribution\",\n        \"ownerId\": \"UR_012345678901234\",\n        \"organizationId\": \"exampleorganization1\",\n        \"requestStatus\": \"Done\",\n        \"requestType\": \"Interactive\",\n        \"sendDate\": \"2015-11-17T00:36:42Z\",\n \t\t\t\t\"surveyId\": \"SV_012345678901234\",\n        \"recipients\": {\n          \"mailingListId\": \"CG_012345678901234\",\n          \"contactId\": \"CID_012345678901234\",\n          \"libraryId\": \"UR_012345678901234\"\n        },\n        \"message\": {\n          \"libraryId\": \"UR_012345678901234\",\n          \"messageId\": \"MS_012345678901234\",\n          \"messageText\": null\n        },\n        \"stats\": {\n          \"sent\": 5,\n          \"started\": 5,\n          \"finished\": 5,\n          \"failed\": 0,\n          \"credits\": 5,\n          \"segments\": 5,\n        }\n      },\n      {\n        \"id\": \"SMSD_012345678901234\",\n \t\t\t\t\"name\": \"mySMSDistribution\",\n        \"ownerId\": \"UR_012345678901234\",\n        \"organizationId\": \"exampleorganization1\",\n        \"requestStatus\": \"Scheduled\",\n        \"requestType\": \"Interactive\",\n        \"sendDate\": \"2020-11-17T00:36:42Z\",\n \t\t\t\t\"surveyId\": \"SV_012345678901234\",\n        \"recipients\": {\n          \"mailingListId\": \"CG_012345678901234\",\n          \"contactId\": null,\n          \"libraryId\": \"UR_012345678901234\"\n        },\n        \"message\": {\n          \"libraryId\": \"UR_012345678901234\",\n          \"messageId\": \"MS_012345678901234\",\n          \"messageText\": null\n        },\n        \"stats\": {\n          \"sent\": 0,\n          \"started\": 0,\n          \"finished\": 0,\n          \"failed\": 0,\n          \"credits\": 0,\n          \"segments\": 0,\n        }\n      }\n     ],\n    \"nextPage\": \"https://s.qualtrics.com/API/v3/distributions/sms?surveyId=SV_012345678901234&offset=100\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","name":""}]},"auth":"required","params":[{"_id":"5627c287e2ce610d004e3f39","ref":"","in":"query","required":true,"desc":"The survey ID associated with the sms distributions","default":"","type":"string","name":"surveyId"},{"_id":"595fb4ce729792002d8b3e14","ref":"","in":"query","required":false,"desc":"The starting offset for the pagination. The default offset is 0. If there are additional pages, the offset value for the next page will be appended to the value of the nextPage parameter in the response.","default":"","type":"int","name":"offset"}],"url":"/v:version/distributions/sms"},"isReference":false,"order":13,"body":"","excerpt":"Get all sms distributions for a survey","slug":"list-sms-distributions","type":"endpoint","title":"List SMS Distributions"}

getList SMS Distributions

Get all sms distributions for a survey

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

surveyId:
required
string
The survey ID associated with the sms distributions
offset:
integer
The starting offset for the pagination. The default offset is 0. If there are additional pages, the offset value for the next page will be appended to the value of the nextPage parameter in the response.

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}