{"_id":"580527255703391b003dd137","parentDoc":null,"user":"56f99ab84d2b4f3400edb636","__v":5,"project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":20,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"5804d12d16161c0f0077df9b","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-17T13:25:01.088Z","from_sync":false,"order":25,"slug":"account-sms","title":"Account SMS"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-17T19:31:49.511Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => \"https://api.phone.com/v4/accounts/345765/sms\",\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => \"\",\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 30,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => \"POST\",\n    CURLOPT_POSTFIELDS => '{ \"from\": \"+12015880100\", \"to\": [\"+17328810138\", \"+17324840911\"], \"text\": \"Hello from Phone.com\" }',\n    CURLOPT_HTTPHEADER => array(\n        \"authorization: Bearer 5CoImLE8cSNrJNDqT1gNgREVFK6nDGYS9FbBakHl\",\n        \"cache-control: no-cache\",\n        \"content-type: application/json\",\n  ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n    echo \"cURL Error #:\" . $err;\n} else {\n    echo $response;\n}","language":"php"}]},"method":"post","results":{"codes":[{"code":"{\n    \"from\": \"+12015880100\",\n    \"to\": [\n        {\n            \"number\": \"+17328810138\",\n            \"status\": \"sent\",\n            \"id\": \"07beccb9b60eeb9dec91a0ac76844cc0066c31b4\"\n        },\n        {\n            \"number\": \"+17324840911\",\n            \"status\": \"delivered\",\n            \"id\": \"4224659aaf2c1a3ba2ede8d5c4c244b67c8464b5\",\n            \"sent_at\": 1506974539,\n            \"delivered_at\": 1506974539\n        }\n    ], \n    \"direction\": \"out\",\n    \"created_epoch\": 1506974539,\n    \"created_at\": \"2017-10-02T20:02:19+00:00\",\n    \"is_new\": true,\n    \"text\": \"Hello from Phone.com\",\n    \"extension\": {\n        \"id\": 709038,\n        \"voip_id\": 345765,\n        \"name\": \"Home 1\",\n        \"extension\": 18\n    }\n}","language":"json","status":201,"name":""}]},"auth":"required","params":[{"_id":"56fac74b6c4e0e1900b1d820","ref":"","in":"path","required":false,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"56fac74b6c4e0e1900b1d81e","ref":"","in":"body","required":true,"desc":"Phone number of sender","default":"","type":"string","name":"from"},{"_id":"56faca7ee982ce220059bad3","ref":"","in":"body","required":true,"desc":"Outgoing destination numbers","default":"","type":"string","name":"to"},{"_id":"56faca7ee982ce220059bad2","ref":"","in":"body","required":true,"desc":"Text body of the outgoing SMS message.","default":"","type":"string","name":"text"},{"_id":"588b448970e57b2f0031b624","ref":"","in":"body","required":false,"desc":"ID of Extension where the sms is saved","default":"","type":"int","name":"extension_id"}],"url":"/accounts/:account_id/sms"},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Assign extension to store outbound messages\",\n  \"body\": \"If extension_id is not set in the post body, a default extension must be set for the \\\"from\\\" phone number in order to save the outbound messages into the Phone.com system.  On the Create Phone Number and Replace Phone Number API's, there is a sms_forwarding field which may be used to set the default extension.\\n\\n* [Create Phone Number](doc:create-account-phone-number)\\n* [Replace Phone Number](doc:replace-account-phone-number)\"\n}\n[/block]","excerpt":"Send a SMS to one or a group of recipients.  For details on the input fields, see [Intro to SMS](doc:account-sms).\n\nNote: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Create SMS API with the following definition:\n\nPOST https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms","slug":"create-account-sms","type":"endpoint","title":"Create SMS"}

postCreate SMS

Send a SMS to one or a group of recipients. For details on the input fields, see [Intro to SMS](doc:account-sms). Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Create SMS API with the following definition: POST https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/sms

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID

Body Params

from:
required
string
Phone number of sender
to:
required
string
Outgoing destination numbers
text:
required
string
Text body of the outgoing SMS message.
extension_id:
integer
ID of Extension where the sms is saved

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "Assign extension to store outbound messages", "body": "If extension_id is not set in the post body, a default extension must be set for the \"from\" phone number in order to save the outbound messages into the Phone.com system. On the Create Phone Number and Replace Phone Number API's, there is a sms_forwarding field which may be used to set the default extension.\n\n* [Create Phone Number](doc:create-account-phone-number)\n* [Replace Phone Number](doc:replace-account-phone-number)" } [/block]

User Information

Try It Out

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