{"_id":"5601545b3aa0520d00da0ccd","editedParams":true,"githubsync":"","parentDoc":null,"__v":4,"project":"55dd9f2e0efd5821000d54d9","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":17,"slug":"sms","title":"SMS"},"editedParams2":true,"version":{"_id":"55dd9f4dab0e4d210045aae9","__v":47,"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","5da48fa678007c00d3826dfd","5da4905f535c4a002716833a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"user":"55dd9841cafe7221002a4c62","metadata":{"title":"","description":"","image":[]},"updates":["5c2219217d78ff011ea5b612"],"next":{"pages":[],"description":""},"createdAt":"2015-09-22T13:15:07.557Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"name":"","code":"var url = \"/v2/sms-messages/send-to/01818181818\";\nvar content = :::at:::\"{ \"\"message\"\": \"\"Hello. We're pleased to tell you that your order has now been dispatched.\"\" }\";\nusing (var httpClient = new HttpClient())\n{\n\thttpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n\tvar credentials = Encoding.ASCII.GetBytes(\"username:password\");\n\thttpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n\tvar result = httpClient.PostAsync(url, new StringContent(content, Encoding.UTF8, \"application/json\")).Result;\n}","language":"csharp"},{"language":"json","code":"{ \n    \"message\": \"Hello. We're pleased to tell you that your order has now been dispatched.\" \n}"},{"code":"$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/sms-messages/send-to/01818181818\";\n$content['message'] = Hello. We're pleased to tell you that your order has now been dispatched.';\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt(\n    $ch, CURLOPT_HTTPHEADER, array('Accept: application/json',\n                                   'Content-Type: application/json')\n);\ncurl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\ncurl_setopt(\n    $ch, CURLOPT_USERPWD,\n    $apiUsername . ':' . $apiPassword\n);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($content));\n\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"post","results":{"codes":[{"status":204,"language":"json","code":"","name":""}]},"auth":"required","params":[{"_id":"55ffe8251503430d007cc6c6","ref":"","in":"path","required":true,"desc":"The mobile number of the contact, which needs to be included within the URL","default":"","type":"string","name":"TelephoneNumber"},{"_id":"55ffeb090c703d1900952fc5","ref":"","in":"body","required":true,"desc":"The SMS message to be sent to your contact's mobile phone, which needs to be included within the request body","default":"","type":"string","name":"Message"}],"url":"/v:version/sms-messages/send-to/[TelephoneNumber]"},"isReference":false,"order":0,"body":"This method sends a single SMS message to a contact, provided you know their mobile number. You can send an unlimited number of SMS messages through the API, and note that this method doesn't add to your allotted total calls per hour.\n\nThe result returned will be a '204 No Content'.","excerpt":"Sends a single SMS message","slug":"send-sms-message","type":"endpoint","title":"Send SMS message"}

postSend SMS message

Sends a single SMS message

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

TelephoneNumber:
required
string
The mobile number of the contact, which needs to be included within the URL

Body Params

Message:
required
string
The SMS message to be sent to your contact's mobile phone, which needs to be included within the request body

Examples


Documentation

This method sends a single SMS message to a contact, provided you know their mobile number. You can send an unlimited number of SMS messages through the API, and note that this method doesn't add to your allotted total calls per hour. The result returned will be a '204 No Content'.