{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/accounts/:account_id/calls","auth":"required","examples":{"codes":[{"name":"PHP Example 1","language":"php","code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => \"https://api.phone.com/v4/accounts/nnnnn/calls\",\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 => '{\n        \"caller_phone_number\" : \"+12014840200\",\n        \"caller_caller_id\"    : \"+17329910138\",\n        \"callee_phone_number\" : \"+17329910138\",\n        \"callee_caller_id\"    : \"+12014840200\",\n        \"caller_extension\"    : 1672438\n    }',\n    CURLOPT_HTTPHEADER => array(\n        \"authorization: Bearer ThisIsYourAPIToken\",\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}"},{"name":"PHP Example 2","language":"php","code":"<?php\n$client = new \\GuzzleHttp\\Client([\n    'base_uri' => 'https://api.phone.com/v4/',\n    'headers' => ['Authorization' => \"Bearer $token\"]\n]);\n$response = $client->post('accounts/123/calls', ['json' => [\n    \"caller_phone_number\" : \"+17324568888\",\n    \"caller_caller_id\"    : \"+17329980138\",\n    \"callee_phone_number\" : \"+17329980138\",\n    \"callee_caller_id\"    : \"+17324568888\",\n    \"caller_extension\"    : 1749841\n]]);"}]},"method":"post","params":[{"name":"account_id","type":"int","default":"","desc":"Account ID","required":true,"in":"path","ref":"","_id":"56f9c415338fbb2000ec3711"},{"name":"caller_phone_number","type":"string","default":"","desc":"Caller phone number in E.164 format","required":false,"in":"body","ref":"","_id":"577fd3b940bede0e00b538ec"},{"name":"caller_extension","type":"int","default":"","desc":"Caller Extension ID (not the extension number)","required":false,"in":"body","ref":"","_id":"588b69e46aca6f2500d11593"},{"name":"caller_caller_id","type":"string","default":"","desc":"Caller ID shown on caller's phone when a call comes (E.164 format)","required":false,"in":"body","ref":"","_id":"56f9c415338fbb2000ec3710"},{"name":"caller_private","type":"boolean","default":"","desc":"Flag to set caller ID to private","required":false,"in":"body","ref":"","_id":"588b69e46aca6f2500d11592"},{"name":"callee_phone_number","type":"string","default":"","desc":"Callee phone number in E.164 format","required":false,"in":"body","ref":"","_id":"588b69e46aca6f2500d11591"},{"name":"callee_extension","type":"int","default":"","desc":"Callee Extension ID (not the extension number)","required":false,"in":"body","ref":"","_id":"588b69e46aca6f2500d11590"},{"name":"callee_caller_id","type":"string","default":"","desc":"Caller ID shown on callee's phone when a call comes (E.164 format)","required":false,"in":"body","ref":"","_id":"588b69e46aca6f2500d1158f"},{"name":"callee_private","type":"boolean","default":"","desc":"Flag to set callee ID to private","required":false,"in":"body","ref":"","_id":"588b69e46aca6f2500d1158e"}],"results":{"codes":[{"code":"{\n    \"id\": \"2c9c23b4-e4a6-11e6-aed0-0269e6354e80\"\n}","name":"","status":201,"language":"json"}]},"settings":""},"next":{"description":"","pages":[]},"title":"Create Calls","type":"endpoint","slug":"create-account-calls","excerpt":"Make a phone call.  See [Calls](doc:account-calls) for more details and how to setup caller id's.\n\nNote: This API is for users with Account Owner scope access token.  Users with Extension User scope token should invoke the Calls API with the following definition:\n\nPOST https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/calls","body":"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"588b5f7a2966b2230009cbfd","user":"56f99ab84d2b4f3400edb636","version":{"version":"4","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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","5b0c16f2be9fcb0003e28222","5ba8fd1a4c8c220003a08f0f","5ede526e75bc22005d0adecc"],"_id":"57624356653c2d2200fec79c","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","__v":23,"project":"55c8cff571d7580d0063a5e5"},"project":"55c8cff571d7580d0063a5e5","createdAt":"2017-01-27T14:55:54.570Z","githubsync":"","parentDoc":null,"__v":8,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Account Calls","slug":"account-calls","order":6,"from_sync":false,"reference":false,"_id":"588b5e5f2966b2230009cbf9","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","createdAt":"2017-01-27T14:51:11.181Z","__v":0}}

postCreate Calls

Make a phone call. See [Calls](doc:account-calls) for more details and how to setup caller id's. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Calls API with the following definition: POST https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/calls

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
required
integer
Account ID

Body Params

caller_phone_number:
string
Caller phone number in E.164 format
caller_extension:
integer
Caller Extension ID (not the extension number)
caller_caller_id:
string
Caller ID shown on caller's phone when a call comes (E.164 format)
caller_private:
boolean
Flag to set caller ID to private
callee_phone_number:
string
Callee phone number in E.164 format
callee_extension:
integer
Callee Extension ID (not the extension number)
callee_caller_id:
string
Caller ID shown on callee's phone when a call comes (E.164 format)
callee_private:
boolean
Flag to set callee ID to private

Examples


Result Format


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 }}