{"_id":"57624356653c2d2200fec7b4","version":{"_id":"57624356653c2d2200fec79c","__v":21,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"parentDoc":null,"project":"55c8cff571d7580d0063a5e5","user":"55c8cf9471d7580d0063a5e4","__v":14,"category":{"_id":"57624356653c2d2200fec7a0","__v":0,"version":"57624356653c2d2200fec79c","project":"55c8cff571d7580d0063a5e5","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-28T23:43:07.914Z","from_sync":false,"order":12,"slug":"extensions","title":"Account Extensions"},"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-29T19:49:23.574Z","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 will have one or more extensions.\n\n## Supported Services\n* [List Extensions](doc:list-account-extensions) \n* [Create Extension](doc:create-account-extension) \n* [Get Extension](doc:get-account-extension) \n* [Replace Extension](doc:replace-account-extension) \n* [Patch Extension](doc:patch-account-extension) \n* [Delete Extension](doc:delete-account-extension) \n\n## Summary Object\nThe Extension Summary Object is used to briefly represent an extension. It can be seen in several places throughout this API. Here are the properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"ID of the extension. This is the internal Phone.com ID, *not* the extension number callers may dial.\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"User-supplied name for the extension. On POST, leaving this empty will result in an auto-generated value.  On PUT, this field is required.\",\n    \"2-0\": \"`extension`\",\n    \"2-1\": \"Integer\",\n    \"2-2\": \"Extension number that callers may dial. On POST, leaving this empty will result in an auto-generated value.  On PUT, this field is required.\",\n    \"3-0\": \"`voip_id`\",\n    \"3-1\": \"Integer\",\n    \"3-2\": \"API Account ID.  Optional, object may return the voip_id.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 2345,\\n    \\\"name\\\": \\\"Matilda\\\",\\n    \\\"extension\\\": 500\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Extension Object has the same properties as the Extension Summary Object, along with the following:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`full_name`\",\n    \"0-1\": \"Full name of the individual or department to which this extension is assigned\",\n    \"1-0\": \"`usage_type`\",\n    \"1-1\": \"Can be `\\\"limited\\\"` or `\\\"unlimited\\\"`. In most cases, changing this will affect your monthly bill. Please see our Control Panel or contact Customer Service for pricing.\",\n    \"2-0\": \"`device_membership`\",\n    \"2-1\": \"[Device Membership Object](#section-device-membership-object), or `NULL`. Read-only. See below for details.\",\n    \"3-0\": \"`timezone`\",\n    \"3-1\": \"Time zone. Can be in any commonly recognized format, such as \\\"America/Los_Angeles\\\".\",\n    \"4-0\": \"`name_greeting`\",\n    \"4-1\": \"[Greeting](doc:account-media) that communicates the extension's name. Output is a [Greeting Summary Object](doc:account-media#section-summary-object). Input must be a [Greeting Lookup Object](doc:account-media#section-lookup-object).\",\n    \"5-0\": \"`include_in_directory`\",\n    \"5-1\": \"Whether this extension should be included in the dial-by-name directory for this account. Boolean.\",\n    \"6-0\": \"`caller_id`\",\n    \"6-1\": \"Phone number to use as Caller ID for outgoing calls. Must be a phone number belonging to this account, or one of any additional authorized phone numbers.  You can use our [List Caller Ids](doc:list-account-extension-caller-ids) service to see a current list.  To unassign, you may set this to `\\\"private\\\"`, `NULL`, or an empty string.\",\n    \"7-0\": \"`local_area_code`\",\n    \"7-1\": \"For outbound calls, this is the North American area code that this extension is calling from.\",\n    \"10-0\": \"`voicemail`\",\n    \"10-1\": \"[Voicemail Object](#section-voicemail-object). See below for details.\",\n    \"11-0\": \"`call_notifications`\",\n    \"11-1\": \"[Call Notifications Object](#section-call-notifications-object). See below for details.\",\n    \"8-0\": \"`enable_call_waiting`\",\n    \"8-1\": \"Whether Call Waiting is enabled. Boolean. Default is `TRUE`.\",\n    \"9-0\": \"`enable_outbound_calls`\",\n    \"9-1\": \"Whether outgoing calls are enabled. Boolean. Default is `TRUE`.\",\n    \"12-0\": \"`route`\",\n    \"12-1\": \"[Route](doc:account-routes) which will handle incoming voice and fax calls. Only valid on PUT requests, not POST.  Output is a [Route Summary Object](doc:account-routes#section-summary-object) if the route is named, otherwise the [Full Route Object](doc:account-routes#section-full-object) will be shown. Input must be a [Route Lookup Object](doc:account-route#section-lookup-object) pointing to a named route.  Route must belong to this extension already.\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 456,\\n    \\\"usage_type\\\": \\\"limited\\\",\\n    \\\"extension\\\": 123,\\n    \\\"name\\\": \\\"Fred\\\",\\n    \\\"full_name\\\": \\\"Fred Smith\\\",\\n    \\\"timezone\\\": \\\"America/Los_Angeles\\\",\\n    \\\"name_greeting\\\": null,\\n    \\\"include_in_directory\\\": true,\\n    \\\"caller_id\\\": \\\"private\\\",\\n    \\\"local_area_code\\\": null,\\n    \\\"enable_call_waiting\\\": true,\\n    \\\"enable_outbound_calls\\\": true,\\n    \\\"voicemail\\\": {\\n        \\\"enabled\\\": true,\\n        \\\"password\\\": \\\"12345\\\",\\n        \\\"greeting\\\": {\\n            \\\"type\\\": \\\"name\\\",\\n            \\\"alternate\\\": null,\\n            \\\"standard\\\": null,\\n            \\\"enable_leave_message_prompt\\\": true\\n        },\\n        \\\"attachments\\\": \\\"wav\\\",\\n        \\\"notifications\\\": {\\n            \\\"emails\\\": [\\n                \\\"freddie:::at:::example.com\\\"\\n            ],\\n            \\\"sms\\\": \\\"+19099999999\\\"\\n        },\\n        \\\"transcription\\\": \\\"human\\\"\\n    },\\n    \\\"call_notifications\\\": null,\\n    \\\"route\\\": {\\n        \\\"id\\\": 77211,\\n        \\\"name\\\": \\\"My custom route for extension 123\\\"\\n    },\\n    \\\"device_membership\\\": {\\n        \\\"line\\\": 1,\\n        \\\"device\\\": {\\n            \\\"id\\\": 142\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Device Membership Object\nThe Device Membership object indicates which VoIP device this extension belongs to, and the line number it is assigned.  The properties in this object are **read-only** from this service. To modify them, use the [Devices](doc:account-devices) services.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`line`\",\n    \"0-1\": \"Line number to which this extension is assigned. Integer.\",\n    \"1-0\": \"`device`\",\n    \"1-1\": \"[Device](doc:account-devices) that this extension belongs to. Output is an [Device Summary Object](doc:account-extensions#section-summary-object).\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n## Voicemail Object\nThe Voicemail object configures voicemail handling for this extension.  Can be set to `NULL` to reset all voicemail settings.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`enabled`\",\n    \"1-0\": \"`password`\",\n    \"2-0\": \"`greeting`\",\n    \"3-0\": \"`attachments`\",\n    \"4-0\": \"`notifications`\",\n    \"5-0\": \"`transcription`\",\n    \"0-1\": \"Whether voicemail is enabled. Boolean.\",\n    \"1-1\": \"Password for accessing voicemail box. Must be digits only.\",\n    \"2-1\": \"[Voicemail Greeting Object](#section-voicemail-greeting-object). See below for details. Can be set to `NULL` to reset greeting options.\",\n    \"3-1\": \"If notification emails are being used, this defines the format of the audio attachments. Can be `\\\"wav\\\"` for WAV format, `\\\"mp3\\\"` for MP3 format, or `NULL` to disable attachments.\",\n    \"4-1\": \"[Voicemail Notifications Object](#section-voicemail-notifications-object). See below for details.  Can be set to `NULL` to disable notifications.\",\n    \"5-1\": \"Type of voicemail transcription to use. Can be `\\\"human\\\"` for high-quality manual transcriptions by human operators, `\\\"automated\\\"` for machine-generated transcriptions, or `NULL` to omit trancriptions.  Changing this option will affect your monthly bill.  Please see our Control Panel or contact Customer Service for details.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n## Voicemail Greeting Object\nThe Voicemail Greeting object configures the greeting that is played when an incoming call is directed to voicemail.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`type`\",\n    \"0-1\": \"The greeting to play.  Can be `\\\"name\\\"` for the `name_greeting` as described above, `\\\"standard\\\"` for the standard greeting, or `\\\"alternate\\\"` for an alternate greeting. See below for details.\",\n    \"1-0\": \"`standard`\",\n    \"1-1\": \"[Greeting](doc:account-media) to be played when `type=\\\"standard\\\"`. Output is a [Greeting Summary Object](doc:account-media#section-summary-object). Input must be a [Greeting Lookup Object](doc:account-media#section-lookup-object).\",\n    \"2-1\": \"[Greeting](doc:account-media) to be played when `type=\\\"alternate\\\"`. Output is a [Greeting Summary Object](doc:account-media#section-summary-object). Input must be a [Greeting Lookup Object](doc:account-media#section-lookup-object).\",\n    \"2-0\": \"`alternate`\",\n    \"3-0\": \"`enable_leave_message_prompt`\",\n    \"3-1\": \"Whether to prompt the caller with the following words after the voicemail greeting has been played: *\\\"Please leave your message after the tone. When finished, hang up or press the pound key.\\\"*  Boolean.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## Voicemail Notifications Object\nThe Voicemail Notifications object configures the recipients(s) of notifications when voicemail messages are received.\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\": \"Phone number capable of receiving SMS messages\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n## Call Notifications Object\nThe Call Notifications object configures the recipient(s) of notifications when calls are received to this extension.\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\": \"Phone number capable of receiving SMS messages\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n## Lookup Object\nThe Extension Lookup Object is used to link to an extension from another object. This is used, for example, when defining actions for [routes](doc:account-routes).  Only *one* of the following properties need to be included. If multiple are specified, then *all* properties must match one of your extensions.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"ID\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"Name\",\n    \"2-0\": \"`extension`\",\n    \"2-1\": \"Extension number\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\nHere are some examples:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"extension: {\\n    \\\"id\\\": 75223\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"extension: {\\n    \\\"name\\\": \\\"Martha's Office\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"extension: {\\n    \\\"extension\\\": 500\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nInstead of inputting an object, you can also use a scalar value.  An extension will be found if the input matches any one of the above fields.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"extension: \\\"Martha's Office\\\"\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"account-extensions","type":"basic","title":"Extensions"}
Your Phone.com account will have one or more extensions. ## Supported Services * [List Extensions](doc:list-account-extensions) * [Create Extension](doc:create-account-extension) * [Get Extension](doc:get-account-extension) * [Replace Extension](doc:replace-account-extension) * [Patch Extension](doc:patch-account-extension) * [Delete Extension](doc:delete-account-extension) ## Summary Object The Extension Summary Object is used to briefly represent an extension. It can be seen in several places throughout this API. Here are the properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "Integer", "0-2": "ID of the extension. This is the internal Phone.com ID, *not* the extension number callers may dial.", "1-0": "`name`", "1-1": "String", "1-2": "User-supplied name for the extension. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required.", "2-0": "`extension`", "2-1": "Integer", "2-2": "Extension number that callers may dial. On POST, leaving this empty will result in an auto-generated value. On PUT, this field is required.", "3-0": "`voip_id`", "3-1": "Integer", "3-2": "API Account ID. Optional, object may return the voip_id." }, "cols": 3, "rows": 4 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 2345,\n \"name\": \"Matilda\",\n \"extension\": 500\n}", "language": "json" } ] } [/block] ## Full Object The Full Extension Object has the same properties as the Extension Summary Object, along with the following: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`full_name`", "0-1": "Full name of the individual or department to which this extension is assigned", "1-0": "`usage_type`", "1-1": "Can be `\"limited\"` or `\"unlimited\"`. In most cases, changing this will affect your monthly bill. Please see our Control Panel or contact Customer Service for pricing.", "2-0": "`device_membership`", "2-1": "[Device Membership Object](#section-device-membership-object), or `NULL`. Read-only. See below for details.", "3-0": "`timezone`", "3-1": "Time zone. Can be in any commonly recognized format, such as \"America/Los_Angeles\".", "4-0": "`name_greeting`", "4-1": "[Greeting](doc:account-media) that communicates the extension's name. Output is a [Greeting Summary Object](doc:account-media#section-summary-object). Input must be a [Greeting Lookup Object](doc:account-media#section-lookup-object).", "5-0": "`include_in_directory`", "5-1": "Whether this extension should be included in the dial-by-name directory for this account. Boolean.", "6-0": "`caller_id`", "6-1": "Phone number to use as Caller ID for outgoing calls. Must be a phone number belonging to this account, or one of any additional authorized phone numbers. You can use our [List Caller Ids](doc:list-account-extension-caller-ids) service to see a current list. To unassign, you may set this to `\"private\"`, `NULL`, or an empty string.", "7-0": "`local_area_code`", "7-1": "For outbound calls, this is the North American area code that this extension is calling from.", "10-0": "`voicemail`", "10-1": "[Voicemail Object](#section-voicemail-object). See below for details.", "11-0": "`call_notifications`", "11-1": "[Call Notifications Object](#section-call-notifications-object). See below for details.", "8-0": "`enable_call_waiting`", "8-1": "Whether Call Waiting is enabled. Boolean. Default is `TRUE`.", "9-0": "`enable_outbound_calls`", "9-1": "Whether outgoing calls are enabled. Boolean. Default is `TRUE`.", "12-0": "`route`", "12-1": "[Route](doc:account-routes) which will handle incoming voice and fax calls. Only valid on PUT requests, not POST. Output is a [Route Summary Object](doc:account-routes#section-summary-object) if the route is named, otherwise the [Full Route Object](doc:account-routes#section-full-object) will be shown. Input must be a [Route Lookup Object](doc:account-route#section-lookup-object) pointing to a named route. Route must belong to this extension already." }, "cols": 2, "rows": 13 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 456,\n \"usage_type\": \"limited\",\n \"extension\": 123,\n \"name\": \"Fred\",\n \"full_name\": \"Fred Smith\",\n \"timezone\": \"America/Los_Angeles\",\n \"name_greeting\": null,\n \"include_in_directory\": true,\n \"caller_id\": \"private\",\n \"local_area_code\": null,\n \"enable_call_waiting\": true,\n \"enable_outbound_calls\": true,\n \"voicemail\": {\n \"enabled\": true,\n \"password\": \"12345\",\n \"greeting\": {\n \"type\": \"name\",\n \"alternate\": null,\n \"standard\": null,\n \"enable_leave_message_prompt\": true\n },\n \"attachments\": \"wav\",\n \"notifications\": {\n \"emails\": [\n \"freddie@example.com\"\n ],\n \"sms\": \"+19099999999\"\n },\n \"transcription\": \"human\"\n },\n \"call_notifications\": null,\n \"route\": {\n \"id\": 77211,\n \"name\": \"My custom route for extension 123\"\n },\n \"device_membership\": {\n \"line\": 1,\n \"device\": {\n \"id\": 142\n }\n }\n}", "language": "json" } ] } [/block] ## Device Membership Object The Device Membership object indicates which VoIP device this extension belongs to, and the line number it is assigned. The properties in this object are **read-only** from this service. To modify them, use the [Devices](doc:account-devices) services. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`line`", "0-1": "Line number to which this extension is assigned. Integer.", "1-0": "`device`", "1-1": "[Device](doc:account-devices) that this extension belongs to. Output is an [Device Summary Object](doc:account-extensions#section-summary-object)." }, "cols": 2, "rows": 2 } [/block] ## Voicemail Object The Voicemail object configures voicemail handling for this extension. Can be set to `NULL` to reset all voicemail settings. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`enabled`", "1-0": "`password`", "2-0": "`greeting`", "3-0": "`attachments`", "4-0": "`notifications`", "5-0": "`transcription`", "0-1": "Whether voicemail is enabled. Boolean.", "1-1": "Password for accessing voicemail box. Must be digits only.", "2-1": "[Voicemail Greeting Object](#section-voicemail-greeting-object). See below for details. Can be set to `NULL` to reset greeting options.", "3-1": "If notification emails are being used, this defines the format of the audio attachments. Can be `\"wav\"` for WAV format, `\"mp3\"` for MP3 format, or `NULL` to disable attachments.", "4-1": "[Voicemail Notifications Object](#section-voicemail-notifications-object). See below for details. Can be set to `NULL` to disable notifications.", "5-1": "Type of voicemail transcription to use. Can be `\"human\"` for high-quality manual transcriptions by human operators, `\"automated\"` for machine-generated transcriptions, or `NULL` to omit trancriptions. Changing this option will affect your monthly bill. Please see our Control Panel or contact Customer Service for details." }, "cols": 2, "rows": 6 } [/block] ## Voicemail Greeting Object The Voicemail Greeting object configures the greeting that is played when an incoming call is directed to voicemail. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`type`", "0-1": "The greeting to play. Can be `\"name\"` for the `name_greeting` as described above, `\"standard\"` for the standard greeting, or `\"alternate\"` for an alternate greeting. See below for details.", "1-0": "`standard`", "1-1": "[Greeting](doc:account-media) to be played when `type=\"standard\"`. Output is a [Greeting Summary Object](doc:account-media#section-summary-object). Input must be a [Greeting Lookup Object](doc:account-media#section-lookup-object).", "2-1": "[Greeting](doc:account-media) to be played when `type=\"alternate\"`. Output is a [Greeting Summary Object](doc:account-media#section-summary-object). Input must be a [Greeting Lookup Object](doc:account-media#section-lookup-object).", "2-0": "`alternate`", "3-0": "`enable_leave_message_prompt`", "3-1": "Whether to prompt the caller with the following words after the voicemail greeting has been played: *\"Please leave your message after the tone. When finished, hang up or press the pound key.\"* Boolean." }, "cols": 2, "rows": 4 } [/block] ## Voicemail Notifications Object The Voicemail Notifications object configures the recipients(s) of notifications when voicemail messages are received. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`emails`", "0-1": "Array of email addresses", "1-0": "`sms`", "1-1": "Phone number capable of receiving SMS messages" }, "cols": 2, "rows": 2 } [/block] ## Call Notifications Object The Call Notifications object configures the recipient(s) of notifications when calls are received to this extension. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`emails`", "0-1": "Array of email addresses", "1-0": "`sms`", "1-1": "Phone number capable of receiving SMS messages" }, "cols": 2, "rows": 2 } [/block] ## Lookup Object The Extension Lookup Object is used to link to an extension from another object. This is used, for example, when defining actions for [routes](doc:account-routes). Only *one* of the following properties need to be included. If multiple are specified, then *all* properties must match one of your extensions. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`id`", "0-1": "ID", "1-0": "`name`", "1-1": "Name", "2-0": "`extension`", "2-1": "Extension number" }, "cols": 2, "rows": 3 } [/block] Here are some examples: [block:code] { "codes": [ { "code": "extension: {\n \"id\": 75223\n}", "language": "json" } ] } [/block] [block:code] { "codes": [ { "code": "extension: {\n \"name\": \"Martha's Office\"\n}", "language": "json" } ] } [/block] [block:code] { "codes": [ { "code": "extension: {\n \"extension\": 500\n}", "language": "json" } ] } [/block] Instead of inputting an object, you can also use a scalar value. An extension will be found if the input matches any one of the above fields. [block:code] { "codes": [ { "code": "extension: \"Martha's Office\"", "language": "json" } ] } [/block]