{"_id":"57624356653c2d2200fec7e0","user":"55c8cf9471d7580d0063a5e4","__v":11,"parentDoc":null,"githubsync":"","version":{"_id":"57624356653c2d2200fec79c","__v":22,"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","5b0c16f2be9fcb0003e28222","5ba8fd1a4c8c220003a08f0f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"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":22,"slug":"account-numbers","title":"Account Phone Numbers"},"project":"55c8cff571d7580d0063a5e5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-29T20:33:01.716Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"Your Phone.com account has one or more phone numbers registered to it.\n\n## Supported Services\n* [List Phone Numbers](doc:list-account-phone-numbers) \n* [Create Phone Number](doc:create-account-phone-number) \n* [Get Phone Number](doc:get-account-phone-number) \n* [Replace Phone Number](doc:replace-account-phone-number) \n\n## Summary Object\nThe Phone Number Summary Object is used to briefly represent a phone number that is registered to your Phone.com account. Here are the properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer Phone number ID. This is the internal Phone.com ID for this number, *not* the phone number itself. Read-only.\",\n    \"0-2\": \"\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"Name\",\n    \"1-2\": \"\",\n    \"2-0\": \"`phone_number`\",\n    \"2-1\": \"Phone number, in E.164 format\",\n    \"2-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 230475,\\n    \\\"name\\\": \\\"Geordi's Communicator\\\",\\n    \\\"phone_number\\\": \\\"+19999999999\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Phone Number Object has all of the properties of the [Phone Number Summary Object](#section-summary-object), along with several more, as shown below:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`block_incoming`\",\n    \"1-0\": \"`block_anonymous`\",\n    \"2-0\": \"`route`\",\n    \"3-0\": \"`caller_id`\",\n    \"4-0\": \"`sms_forwarding`\",\n    \"5-0\": \"`call_notifications`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"Whether to block incoming calls. Boolean.\",\n    \"1-1\": \"Whether to block anonymous calls. Boolean.\",\n    \"2-1\": \"The [Route](doc:account-routes) assigned to handle incoming calls for this number, if any. Output is a [Route Summary Object](doc:account-routes#section-summary-object), or `NULL` if not set. Input can be a [Route Lookup Object](doc:account-routes#section-lookup-object) or `NULL` to unset.\",\n    \"3-1\": \"[Caller ID Object](#section-caller-id-object), or `NULL`\",\n    \"4-1\": \"[SMS Forwarding Object](#section-sms-forwarding-object), or `NULL`\",\n    \"5-1\": \"[Call Notifications Object](#section-call-notifications-object) or `NULL`\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 2083676,\\n    \\\"name\\\": \\\"My Work Desk\\\",\\n    \\\"phone_number\\\": \\\"+12015152680\\\",\\n    \\\"block_incoming\\\": false,\\n    \\\"block_anonymous\\\": true,\\n    \\\"route\\\": {\\n        \\\"id\\\": 3469453,\\n        \\\"name\\\": \\\"My default route\\\",\\n    },\\n    \\\"caller_id\\\": {\\n        \\\"name\\\": \\\"Megan Krpalek\\\",\\n        \\\"type\\\": \\\"business\\\"\\n    },\\n    \\\"sms_forwarding\\\": {\\n        \\\"type\\\": \\\"extension\\\",\\n        \\\"extension\\\": {\\n            \\\"id\\\": 35352,\\n            \\\"name\\\": \\\"Megan\\\",\\n            \\\"extension\\\": 51\\n        }\\n    },\\n    \\\"call_notifications\\\": {\\n        \\\"emails\\\": [\\n            \\\"megank:::at:::example.com\\\"\\n        ],\\n        \\\"sms\\\": \\\"+18313334444\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Caller ID Object\nThe Caller ID object configures how this number will appear in the National Caller ID Name database.  To opt-out of this database, set the `caller_id` property to `NULL`.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`name`\",\n    \"0-1\": \"Name that this number will be associated with. Must be no longer than 15 characters, and can only contain English letters, numbers, spaces, and commas.\",\n    \"1-0\": \"`type`\",\n    \"1-1\": \"Can be `\\\"business\\\"` or `\\\"personal\\\"`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n## SMS Forwarding Object\nThe SMS Forwarding object configures how incoming SMS messages will be handled.  To opt out of receiving SMS for this number, set the `sms_forwarding` property to `NULL`.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`type`\",\n    \"0-1\": \"Can be `\\\"extension\\\"` or `\\\"application\\\"`\",\n    \"1-0\": \"`extension`\",\n    \"2-0\": \"`application`\",\n    \"1-1\": \"Required if `type = \\\"extension\\\"`. [Extension](doc:account-extensions) that messages should be directed to. Output is an [Extension Summary Object](doc:account-extensions#section-summary-object). Input must be an [Extension Lookup Object](doc:account-extensions#section-lookup-object).\",\n    \"2-1\": \"Required if `type = \\\"application\\\"`. [Application](doc:account-applications) that messages should be directed to. Output is an [Application Summary Object](doc:account-applications#section-summary-object). Input must be an [Application Lookup Object](doc:account-applications#section-lookup-object).\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## Call Notifications Object\nThe Call Notifications object configures notifications for incoming calls to this number. To omit notifications, set the `call_notifications` property to `NULL`.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`emails`\",\n    \"0-1\": \"Array of email addresses\",\n    \"1-0\": \"`sms`\",\n    \"1-1\": \"A phone number capable of receiving SMS messages\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","excerpt":"","slug":"account-phone-numbers","type":"basic","title":"Phone Numbers"}
Your Phone.com account has one or more phone numbers registered to it. ## Supported Services * [List Phone Numbers](doc:list-account-phone-numbers) * [Create Phone Number](doc:create-account-phone-number) * [Get Phone Number](doc:get-account-phone-number) * [Replace Phone Number](doc:replace-account-phone-number) ## Summary Object The Phone Number Summary Object is used to briefly represent a phone number that is registered to your Phone.com account. Here are the properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "h-2": "", "0-0": "`id`", "0-1": "Integer Phone number ID. This is the internal Phone.com ID for this number, *not* the phone number itself. Read-only.", "0-2": "", "1-0": "`name`", "1-1": "Name", "1-2": "", "2-0": "`phone_number`", "2-1": "Phone number, in E.164 format", "2-2": "" }, "cols": 2, "rows": 3 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 230475,\n \"name\": \"Geordi's Communicator\",\n \"phone_number\": \"+19999999999\"\n}", "language": "json" } ] } [/block] ## Full Object The Full Phone Number Object has all of the properties of the [Phone Number Summary Object](#section-summary-object), along with several more, as shown below: [block:parameters] { "data": { "0-0": "`block_incoming`", "1-0": "`block_anonymous`", "2-0": "`route`", "3-0": "`caller_id`", "4-0": "`sms_forwarding`", "5-0": "`call_notifications`", "h-0": "Property", "h-1": "Description", "0-1": "Whether to block incoming calls. Boolean.", "1-1": "Whether to block anonymous calls. Boolean.", "2-1": "The [Route](doc:account-routes) assigned to handle incoming calls for this number, if any. Output is a [Route Summary Object](doc:account-routes#section-summary-object), or `NULL` if not set. Input can be a [Route Lookup Object](doc:account-routes#section-lookup-object) or `NULL` to unset.", "3-1": "[Caller ID Object](#section-caller-id-object), or `NULL`", "4-1": "[SMS Forwarding Object](#section-sms-forwarding-object), or `NULL`", "5-1": "[Call Notifications Object](#section-call-notifications-object) or `NULL`" }, "cols": 2, "rows": 6 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 2083676,\n \"name\": \"My Work Desk\",\n \"phone_number\": \"+12015152680\",\n \"block_incoming\": false,\n \"block_anonymous\": true,\n \"route\": {\n \"id\": 3469453,\n \"name\": \"My default route\",\n },\n \"caller_id\": {\n \"name\": \"Megan Krpalek\",\n \"type\": \"business\"\n },\n \"sms_forwarding\": {\n \"type\": \"extension\",\n \"extension\": {\n \"id\": 35352,\n \"name\": \"Megan\",\n \"extension\": 51\n }\n },\n \"call_notifications\": {\n \"emails\": [\n \"megank@example.com\"\n ],\n \"sms\": \"+18313334444\"\n }\n}", "language": "json" } ] } [/block] ## Caller ID Object The Caller ID object configures how this number will appear in the National Caller ID Name database. To opt-out of this database, set the `caller_id` property to `NULL`. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`name`", "0-1": "Name that this number will be associated with. Must be no longer than 15 characters, and can only contain English letters, numbers, spaces, and commas.", "1-0": "`type`", "1-1": "Can be `\"business\"` or `\"personal\"`" }, "cols": 2, "rows": 2 } [/block] ## SMS Forwarding Object The SMS Forwarding object configures how incoming SMS messages will be handled. To opt out of receiving SMS for this number, set the `sms_forwarding` property to `NULL`. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`type`", "0-1": "Can be `\"extension\"` or `\"application\"`", "1-0": "`extension`", "2-0": "`application`", "1-1": "Required if `type = \"extension\"`. [Extension](doc:account-extensions) that messages should be directed to. Output is an [Extension Summary Object](doc:account-extensions#section-summary-object). Input must be an [Extension Lookup Object](doc:account-extensions#section-lookup-object).", "2-1": "Required if `type = \"application\"`. [Application](doc:account-applications) that messages should be directed to. Output is an [Application Summary Object](doc:account-applications#section-summary-object). Input must be an [Application Lookup Object](doc:account-applications#section-lookup-object)." }, "cols": 2, "rows": 3 } [/block] ## Call Notifications Object The Call Notifications object configures notifications for incoming calls to this number. To omit notifications, set the `call_notifications` property to `NULL`. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`emails`", "0-1": "Array of email addresses", "1-0": "`sms`", "1-1": "A phone number capable of receiving SMS messages" }, "cols": 2, "rows": 2 } [/block]