{"_id":"5d3eeb861307ff0066ccbda8","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":45,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e","5b7c1e210dc2e20003871521"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"55f0371df6101b1900c70700","pages":[],"version":"55dd9f4dab0e4d210045aae9","__v":0,"project":"55dd9f2e0efd5821000d54d9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:41:49.850Z","from_sync":false,"order":16,"slug":"sms","title":"SMS"},"user":"5c3740967267aa42020e5cce","__v":5,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-29T12:50:14.272Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 1,\n  \"name\": \"SMS Test Campaign\",\n  \"message\": \"Test SMS campaign message content\",\n  \"sendingIdentityId\": \"123\",\n  \"sendingIdentity\": \"dotdigital\",\n  \"status\": \"Sent\",\n  \"toggleShortLinks\": \"false\"\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"var url = \"/v2/sms/campaigns/{campaignId}\";\n\nusing (var httpClient = new HttpClient())\n{\n    httpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n    var credentials = Encoding.ASCII.GetBytes(\"username:password\");\n    httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n    var result = httpClient.GetAsync(url).Result;\n}","language":"csharp"}]},"method":"get","auth":"required","params":[{"_id":"5d3ef6c52d175000205935e3","ref":"","in":"path","required":true,"desc":"This is the ID of the campaign you wish to return","default":"","type":"string","name":"campaignId"}],"url":"/v:version/sms/campaigns/{campaignId}"},"isReference":false,"order":2,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"API call in beta\",\n  \"body\": \"Please note that this API call is in beta and is subject to change.\"\n}\n[/block]\nThis operation is used to return an existing SMS campaign that's in your account. The ‘id’ of the campaign should be passed through in the URL.\n\nCampaigns that are deleted will not be returned. If you attempt to return an SMS campaign with this status, you will receive an appropriate validation error message.","excerpt":"Returns an existing SMS campaign","slug":"get-an-sms-campaign","type":"endpoint","title":"Get SMS campaign (beta)"}

getGet SMS campaign (beta)

Returns an existing SMS campaign

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

campaignId:
required
string
This is the ID of the campaign you wish to return

Examples


Result Format


Documentation

[block:callout] { "type": "danger", "title": "API call in beta", "body": "Please note that this API call is in beta and is subject to change." } [/block] This operation is used to return an existing SMS campaign that's in your account. The ‘id’ of the campaign should be passed through in the URL. Campaigns that are deleted will not be returned. If you attempt to return an SMS campaign with this status, you will receive an appropriate validation error message.