{"_id":"57624356653c2d2200fec7e5","__v":2,"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"55c8cff571d7580d0063a5e5","user":"571fcfeea0acd42000af95be","category":{"_id":"57624356653c2d2200fec7a6","__v":0,"project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-29T05:00:50.119Z","from_sync":false,"order":21,"slug":"account-numbers","title":"Account Phone Numbers"},"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-26T20:38:59.221Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"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/phone-numbers', ['json' => [\n    'phone_number' => '+15303616862',\n    'name' => 'Robert',\n    'route' => ['id' => 1],  # or ['name' => 'Route 56']\n    'block_incoming' => false,\n    'block_anonymous' => true,\n    'caller_id' => [\n        'name' => 'Robert M',\n        'type' => 'business'\n    ],\n    'sms_forwarding' => [\n        'type' => 'extension',\n        'extension' => 123\n    ],\n    'call_notifications' => [\n        'emails' => ['robert:::at:::example.com'],\n        'sms' => '+18587740222'\n    ]\n]]);"}]},"method":"post","results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\": 6,\n    \"name\": \"Robert\",\n    \"number\": \"+15303616862\",\n    \"block_incoming\": false,\n    \"block_anonymous\": true,\n    \"route\": {\n        \"id\": 1,\n        \"name\": \"Route 56\"\n    },\n    \"caller_id\": {\n        \"name\": \"Robert M\",\n        \"type\": \"business\"\n    },\n    \"sms_forwarding\": {\n        \"enabled\": true,\n        \"type\": \"extension\",\n        \"extension\": {\n            \"id\": 34,\n            \"name\": \"Fred\",\n            \"extension\": 123\n        }\n    },\n    \"call_notifications\": {\n        \"emails\": [\"robert@example.com\"],\n        \"sms\": \"+18587740222\"\n    }\n}","name":""}]},"auth":"required","params":[{"_id":"56fae7e0283ee90e004acaef","ref":"","in":"path","required":false,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"57225f233926280e00c92458","ref":"","in":"body","required":false,"desc":"Phone number","default":"","type":"object","name":"phone_number"},{"_id":"572247cdecdfb819006bdaea","ref":"","in":"body","required":false,"desc":"Route lookup object","default":"","type":"object","name":"route"},{"_id":"57224b4becdfb819006bdaf5","ref":"","in":"body","required":false,"desc":"Phone Name","default":"","type":"string","name":"name"},{"_id":"57224b4becdfb819006bdaf4","ref":"","in":"body","required":false,"desc":"Block incoming calls","default":"","type":"boolean","name":"block_incoming"},{"_id":"57224b4becdfb819006bdaf3","ref":"","in":"body","required":false,"desc":"Block anonymous calls","default":"","type":"boolean","name":"block_anonymous"},{"_id":"57224d08dcfa860e005bf086","ref":"","in":"body","required":false,"desc":"Caller ID name","default":"","type":"string","name":"caller_id[name]"},{"_id":"57224d08dcfa860e005bf085","ref":"","in":"body","required":false,"desc":"Caller ID type","default":"business","type":"string","name":"caller_id[type]"},{"_id":"5779c85788c9800e00518fd8","ref":"","in":"body","required":false,"desc":"\"application\" or \"extension\"","default":"","type":"string","name":"sms_forwarding[type]"},{"_id":"57224f93dcfa860e005bf093","ref":"","in":"body","required":false,"desc":"Application lookup object","default":"","type":"object","name":"sms_forwarding[application]"},{"_id":"57225e46dcfa860e005bf0b4","ref":"","in":"body","required":false,"desc":"Extension lookup object","default":"","type":"object","name":"sms_forwarding[extension]"},{"_id":"5722916dde10810e00153999","ref":"","in":"body","required":false,"desc":"Call notifications for emails.  Can be a single email or an array of emails","default":"","type":"mixed","name":"call_notifications[emails]"},{"_id":"5722916dde10810e00153998","ref":"","in":"body","required":false,"desc":"Call notification for SMS","default":"","type":"string","name":"call_notifications[sms]"}],"url":"/accounts/:account_id/phone-numbers"},"isReference":true,"order":3,"body":"See [Intro to Account Phone Numbers](doc:account-phone-numbers) for more info on the properties to use.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Available Numbers\",\n  \"body\": \"To discover which phone numbers are available, use our  [List Available Phone Numbers](doc:list-available-phone-numbers) service.  You may only use our API to request numbers whose initial acquisition and setup price is free (USD $0.)  Additional monthly fees may apply.\\n\\nTo purchase non-free phone numbers, please use our Control Panel or contact Customer Support.\"\n}\n[/block]","excerpt":"Add a phone number to an account. See [Account Phone Numbers](doc:account-phone-numbers) for more info on the properties.","slug":"create-account-phone-number","type":"endpoint","title":"Create Phone Number"}

postCreate Phone Number

Add a phone number to an account. See [Account Phone Numbers](doc:account-phone-numbers) for more info on the properties.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID

Body Params

phone_number:
object
Phone number
route:
object
Route lookup object
name:
string
Phone Name
block_incoming:
boolean
Block incoming calls
block_anonymous:
boolean
Block anonymous calls
caller_id[name]:
string
Caller ID name
caller_id[type]:
stringbusiness
Caller ID type
sms_forwarding[type]:
string
"application" or "extension"
sms_forwarding[application]:
object
Application lookup object
sms_forwarding[extension]:
object
Extension lookup object
call_notifications[emails]:
mixed
Call notifications for emails. Can be a single email or an array of emails
call_notifications[sms]:
string
Call notification for SMS

Examples


Result Format


Documentation

See [Intro to Account Phone Numbers](doc:account-phone-numbers) for more info on the properties to use. [block:callout] { "type": "info", "title": "Available Numbers", "body": "To discover which phone numbers are available, use our [List Available Phone Numbers](doc:list-available-phone-numbers) service. You may only use our API to request numbers whose initial acquisition and setup price is free (USD $0.) Additional monthly fees may apply.\n\nTo purchase non-free phone numbers, please use our Control Panel or contact Customer Support." } [/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 }}