# Auto Provisioning
Manage your phone auto provisioning.
## List firmware templates
> List IP phones template files
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/templates/phones":{"get":{"tags":["Auto Provisioning"],"operationId":"listFirmwareTemplates","summary":"List firmware templates","description":"List IP phones template files\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"is_custom":{"type":"boolean","description":"Whether it's a customize template.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Create a new firmware template
> Create a new firmware template into system.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/templates/phones":{"post":{"tags":["Auto Provisioning"],"operationId":"createFirmwareTemplate","summary":"Create a new firmware template","description":"Create a new firmware template into system.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"content":{"type":"string","description":"The file content of the template.\n"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","description":"Template XML file name for phone provisioning.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve details of firmware template
> Retrieve details of template file by it's filename.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/templates/phones/{filename}":{"get":{"tags":["Auto Provisioning"],"operationId":"showFirmwareTemplate","summary":"Retrieve details of firmware template","description":"Retrieve details of template file by it's filename.\n","parameters":[{"name":"filename","in":"path","required":true,"schema":{"type":"string","description":"Template XML file name for phone provisioning.\n"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"content":{"type":"string","description":"The file content of the template.\n"},"is_custom":{"type":"boolean","description":"Whether it's a customize template.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update firmware template
> Update phone template.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/templates/phones/{filename}":{"post":{"tags":["Auto Provisioning"],"operationId":"updateFirmwareTemplate","summary":"Update firmware template","description":"Update phone template.\n","parameters":[{"name":"filename","in":"path","required":true,"schema":{"type":"string","description":"Template XML file name for phone provisioning.\n"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","description":"The file content of the template.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Remove an firmware template
> Remove custom template by it's filename.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/templates/phones/{filename}/destroy":{"post":{"tags":["Auto Provisioning"],"operationId":"deleteFirmwareTemplate","summary":"Remove an firmware template","description":"Remove custom template by it's filename.\n","parameters":[{"name":"filename","in":"path","required":true,"schema":{"type":"string","description":"Template XML file name for phone provisioning.\n"}}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## List phone models
> List IP phones models.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/phone_models":{"get":{"tags":["Auto Provisioning"],"operationId":"listPhoneModels","summary":"List phone models","description":"List IP phones models.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"display_name":{"type":"string","description":"The display name of the phone model.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve profile of firmware template
> Retrieve phone template profile by it's filename.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/phone_models/{filename}":{"get":{"tags":["Auto Provisioning"],"operationId":"showFirmwareTemplateProfile","summary":"Retrieve profile of firmware template","description":"Retrieve phone template profile by it's filename.\n","parameters":[{"name":"filename","in":"path","required":true,"schema":{"type":"string","description":"Template XML file name for phone provisioning.\n"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"languages":{"type":"array","items":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"Language for strings displayed on Phone Display LCD.\nSupported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN,\nGREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.\n"},"description":"A collection of language tags.\n"},"ringtones":{"type":"array","items":{"type":"string","description":"The ringtone of phone.\n"},"description":"A collection of ringtones.\n"},"queue_ringtones":{"type":"array","items":{"type":"string","description":"The queue ringtone of phone for queue calls or ring group calls.\n"},"description":"A collection of queue ringtones.\n"},"external_ringtone":{"type":"array","items":{"type":"string","description":"The ringtone of phone for external calls.\n"},"description":"A collection of external ringtones.\n"},"date_formats":{"type":"array","items":{"type":"string","description":"The date format of phone.\n"},"description":"A collection of date formats.\n"},"time_formats":{"type":"array","items":{"type":"string","description":"The time format of phone.\n"},"description":"A collection of time formats.\n"},"powerleds":{"type":"array","items":{"type":"string","description":"The power led of phone.\n"},"description":"A collection of time power leds.\n"},"backlights":{"type":"array","items":{"type":"string","description":"The backlight of phone.\n"},"description":"A collection of time backlights.\n"},"screensavers":{"type":"array","items":{"type":"string","description":"The screensaver of phone.\n"},"description":"A collection of screensavers.\n"},"time_zones":{"type":"array","items":{"type":"string","description":"The timezone of phone.\n"},"description":"A collection of time zones.\n"},"codecs":{"type":"array","items":{"type":"string"},"description":"Settings for the priority of the codecs in this phone.\nThis indicates the first preferred codec.\n"},"enable_lldp":{"type":"boolean","default":false,"description":"Enable or disable Link Layer Discovery Protocol."},"enable_vlan_wan_port":{"type":"boolean","default":false,"description":"Enable or disable VLAN for WAN Port.\n"},"wan_port_id":{"type":"integer","minimum":1,"maximum":4094,"description":"VLAN ID for WAN PORT.\n"},"wan_port_priority":{"type":"integer","minimum":0,"maximum":7,"description":"VLAN priority for WAN Port.\n"},"enable_vlan_pc_port":{"type":"boolean","default":false,"description":"Enable or disable VLAN for PC Port.\n"},"pc_port_id":{"type":"integer","minimum":1,"maximum":4094,"description":"VLAN ID for PC PORT.\n"},"pc_port_priority":{"type":"integer","minimum":0,"maximum":7,"description":"VLAN priority for PC Port.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## List IP phones
> List IP phones
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/phones":{"get":{"tags":["Auto Provisioning"],"operationId":"listPhones","summary":"List IP phones","description":"List IP phones\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"vendor":{"type":"string","description":"The phone vendor of IP phone.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"fwver":{"type":"string","description":"The firmware version of IP phone.\n"},"name":{"type":"string","maxLength":1024,"description":"The display name of user.\n"},"password":{"type":"string","description":"Password for accessing the Web interface of phone.\nThe username remains default because most phone manufacturers do not\nallow modification of the user name. This is supported for some phone model, such as \"Snom 300\".\n"},"vm_pin":{"type":"string","description":"The voicemail PIN of the phone.\n"},"ip":{"type":"string","description":"IP address.\n"},"mac":{"allOf":[{"type":"string","description":"MAC address.\n"}],"description":"MAC address of this IP phone.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Reprovision all phones
> Re-provision all phones.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/phones/reprovision":{"post":{"tags":["Auto Provisioning"],"operationId":"reprovisionAllPhones","summary":"Reprovision all phones","description":"Re-provision all phones.\n","responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Retrieve Phone's detailed information.
> Retrieve phone's detailed information.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/phones/{mac}":{"get":{"tags":["Auto Provisioning"],"operationId":"getPhoneDetails","summary":"Retrieve Phone's detailed information.","description":"Retrieve phone's detailed information.\n","parameters":[{"name":"mac","in":"path","required":true,"schema":{"type":"string","description":"MAC address.\n"},"description":"The MAC address of the IP phone."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"vendor":{"type":"string","description":"The phone vendor of IP phone.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"fwver":{"type":"string","description":"The firmware version of IP phone.\n"},"name":{"type":"string","maxLength":1024,"description":"The display name of user.\n"},"password":{"type":"string","description":"Password for accessing the Web interface of phone.\nThe username remains default because most phone manufacturers do not\nallow modification of the user name. This is supported for some phone model, such as \"Snom 300\".\n"},"vm_pin":{"type":"string","description":"The voicemail PIN of the phone.\n"},"ip":{"type":"string","description":"IP address.\n"},"mac":{"allOf":[{"type":"string","description":"MAC address.\n"}],"description":"MAC address of this IP phone.\n"}}}}}},"404":{"description":"Not Found"}}}}}}
```
## Check phone's assignee
> Check phone's assignee by MAC.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/phones/{mac}/assignee":{"get":{"tags":["Auto Provisioning"],"operationId":"getPhoneAssignee","summary":"Check phone's assignee","description":"Check phone's assignee by MAC.\n","parameters":[{"name":"mac","in":"path","required":true,"schema":{"type":"string","description":"MAC address.\n"},"description":"The MAC address of the IP phone."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mac":{"allOf":[{"type":"string","description":"MAC address.\n"}],"description":"MAC address of this IP phone.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"vendor":{"type":"string","description":"The phone vendor of IP phone.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"}}}}}},"404":{"description":"Not Found"}}}}}}
```
## Reprovision a phone
> Re-provision a phone by it's MAC address.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/phones/{mac}/reprovision":{"post":{"tags":["Auto Provisioning"],"operationId":"reprovisionPhone","summary":"Reprovision a phone","description":"Re-provision a phone by it's MAC address.\n","parameters":[{"name":"mac","in":"path","required":true,"schema":{"type":"string","description":"MAC address.\n"},"description":"The MAC address of the IP phone."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Reboot Phone
> Reboot Phone
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/phones/{mac}/reboot":{"post":{"tags":["Auto Provisioning"],"operationId":"rebootPhone","summary":"Reboot Phone","description":"Reboot Phone\n","parameters":[{"name":"mac","in":"path","required":true,"schema":{"type":"string","description":"MAC address.\n"},"description":"The MAC address of the IP phone."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Reject a phone
> Reject a phone from auto provisioning.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/phones/{mac}/reject":{"post":{"tags":["Auto Provisioning"],"operationId":"rejectPhone","summary":"Reject a phone","description":"Reject a phone from auto provisioning.\n","parameters":[{"name":"mac","in":"path","required":true,"schema":{"type":"string","description":"MAC address.\n"},"description":"The MAC address of the IP phone."}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid mac address."}}}}}}
```
## List DECT phone models
> List DECT phone models.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phone_models":{"get":{"tags":["Auto Provisioning"],"operationId":"listDectPhoneModels","summary":"List DECT phone models","description":"List DECT phone models.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"lines":{"type":"integer","readOnly":true,"description":"The max lines of DECT phone.\n"},"display_name":{"type":"string","description":"The display name of the phone model.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve details of DECT phone model
> Retrieve details of DECT phone model.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phone_models/{name}":{"get":{"tags":["Auto Provisioning"],"operationId":"retrieveDectPhoneModel","summary":"Retrieve details of DECT phone model","description":"Retrieve details of DECT phone model.\n","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Template XML file name for phone provisioning.\n"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"template":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"languages":{"type":"array","items":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"Language for strings displayed on Phone Display LCD.\nSupported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN,\nGREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.\n"},"description":"A collection of language tags.\n"},"tones":{"type":"array","items":{"type":"string","description":"The ringtone of phone.\n"},"description":"A collection of ringtones.\n"},"time_zones":{"type":"array","items":{"type":"string","description":"The timezone of phone.\n"},"description":"A collection of time zones.\n"},"codecs":{"type":"array","items":{"type":"string"},"description":"Settings for the priority of the codecs in this phone.\nThis indicates the first preferred codec.\n"},"lines":{"type":"integer","readOnly":true,"description":"The max lines of DECT phone.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## List DECT phones
> List DECT phones
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phones":{"get":{"tags":["Auto Provisioning"],"operationId":"listDectPhones","summary":"List DECT phones","description":"List DECT phones\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of DECT phone.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of DECT phone.\n"},"mac":{"allOf":[{"type":"string","description":"MAC address.\n"}],"description":"MAC address of this IP phone.\n"},"template":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"vendor":{"type":"string","description":"The phone vendor of IP phone.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"password":{"type":"string","description":"Password for accessing the Web interface of phone.\nThe username remains default because most phone manufacturers do not\nallow modification of the user name. This is supported for some phone model, such as \"Snom 300\".\n"},"user_password":{"type":"string","description":"The user password.\n"},"engineer_password":{"type":"string","description":"The engineer password.\n"},"timezone":{"type":"string","description":"The timezone of phone.\n"},"region":{"type":"string","description":"The country or region name of phone.\n"},"language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"Language for strings displayed on Phone Display LCD.\nSupported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN,\nGREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.\n"},"handset_language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"The handset language.\n"},"tone":{"type":"string","description":"The tone set of DECT phone.\n"},"rps":{"type":"boolean","description":"Send to RPS or not.\n"},"https":{"type":"boolean","description":"Whether to use https\n"},"codecs":{"type":"array","items":{"type":"string"},"description":"Settings for the priority of the codecs in this phone.\nThis indicates the first preferred codec.\n"},"lines":{"type":"integer","readOnly":true,"description":"The max lines of DECT phone.\n"},"interface":{"type":"string","enum":["WEB_DOMAIN","PUBLIC_IPV4","PUBLIC_IPV6","PRIVATE_IPV4","PRIVATE_IPV6","SBC_DOMAIN"],"description":"The interface type for QR code or auto provisioning. \nCan be neither: \n- `WEB_DOMAIN`:\n- `PUBLIC_IPV4`:\n- `PUBLIC_IPV6`:\n- `PRIVATE_IPV4`:\n- `PRIVATE_IPV6`:\n- `SBC_DOMAIN`:\n"},"preferred_transport":{"type":"string","enum":["UDP","TCP","TLS"],"description":"The transport protocol: \nCan be either: \n- `UDP`:\n- `TCP`:\n- `TLS`:\n"},"url":{"type":"string","description":"Auto provision server URL.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Create a DECT phone
> Create a DECT phone.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phones":{"post":{"tags":["Auto Provisioning"],"operationId":"createDectPhone","summary":"Create a DECT phone","description":"Create a DECT phone.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of DECT phone.\n"},"mac":{"allOf":[{"type":"string","description":"MAC address.\n"}],"description":"MAC address of this IP phone.\n"},"template":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"vendor":{"type":"string","description":"The phone vendor of IP phone.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"password":{"type":"string","description":"Password for accessing the Web interface of phone.\nThe username remains default because most phone manufacturers do not\nallow modification of the user name. This is supported for some phone model, such as \"Snom 300\".\n"},"user_password":{"type":"string","description":"The user password.\n"},"engineer_password":{"type":"string","description":"The engineer password.\n"},"timezone":{"type":"string","description":"The timezone of phone.\n"},"region":{"type":"string","description":"The country or region name of phone.\n"},"language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"Language for strings displayed on Phone Display LCD.\nSupported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN,\nGREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.\n"},"handset_language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"The handset language.\n"},"tone":{"type":"string","description":"The tone set of DECT phone.\n"},"rps":{"type":"boolean","description":"Send to RPS or not.\n"},"https":{"type":"boolean","description":"Whether to use https\n"},"codecs":{"type":"array","items":{"type":"string"},"description":"Settings for the priority of the codecs in this phone.\nThis indicates the first preferred codec.\n"},"interface":{"type":"string","enum":["WEB_DOMAIN","PUBLIC_IPV4","PUBLIC_IPV6","PRIVATE_IPV4","PRIVATE_IPV6","SBC_DOMAIN"],"description":"The interface type for QR code or auto provisioning. \nCan be neither: \n- `WEB_DOMAIN`:\n- `PUBLIC_IPV4`:\n- `PUBLIC_IPV6`:\n- `PRIVATE_IPV4`:\n- `PRIVATE_IPV6`:\n- `SBC_DOMAIN`:\n"},"preferred_transport":{"type":"string","enum":["UDP","TCP","TLS"],"description":"The transport protocol: \nCan be either: \n- `UDP`:\n- `TCP`:\n- `TLS`:\n"}},"required":["name","mac","template","vendor","model","password","timezone","language","tone","codecs","interface","preferred_transport"]}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of DECT phone.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve DECT Phone's detailed information.
> Retrieve DECT phone's detailed information.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phones/{id}":{"get":{"tags":["Auto Provisioning"],"operationId":"getDectPhoneDetails","summary":"Retrieve DECT Phone's detailed information.","description":"Retrieve DECT phone's detailed information.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of DECT phone.\n"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of DECT phone.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of DECT phone.\n"},"mac":{"allOf":[{"type":"string","description":"MAC address.\n"}],"description":"MAC address of this IP phone.\n"},"template":{"type":"string","description":"Template XML file name for phone provisioning.\n"},"vendor":{"type":"string","description":"The phone vendor of IP phone.\n"},"model":{"type":"string","description":"The name of IP phone model.\n"},"password":{"type":"string","description":"Password for accessing the Web interface of phone.\nThe username remains default because most phone manufacturers do not\nallow modification of the user name. This is supported for some phone model, such as \"Snom 300\".\n"},"user_password":{"type":"string","description":"The user password.\n"},"engineer_password":{"type":"string","description":"The engineer password.\n"},"timezone":{"type":"string","description":"The timezone of phone.\n"},"region":{"type":"string","description":"The country or region name of phone.\n"},"language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"Language for strings displayed on Phone Display LCD.\nSupported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN,\nGREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.\n"},"handset_language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"The handset language.\n"},"tone":{"type":"string","description":"The tone set of DECT phone.\n"},"rps":{"type":"boolean","description":"Send to RPS or not.\n"},"https":{"type":"boolean","description":"Whether to use https\n"},"codecs":{"type":"array","items":{"type":"string"},"description":"Settings for the priority of the codecs in this phone.\nThis indicates the first preferred codec.\n"},"lines":{"type":"integer","readOnly":true,"description":"The max lines of DECT phone.\n"},"interface":{"type":"string","enum":["WEB_DOMAIN","PUBLIC_IPV4","PUBLIC_IPV6","PRIVATE_IPV4","PRIVATE_IPV6","SBC_DOMAIN"],"description":"The interface type for QR code or auto provisioning. \nCan be neither: \n- `WEB_DOMAIN`:\n- `PUBLIC_IPV4`:\n- `PUBLIC_IPV6`:\n- `PRIVATE_IPV4`:\n- `PRIVATE_IPV6`:\n- `SBC_DOMAIN`:\n"},"preferred_transport":{"type":"string","enum":["UDP","TCP","TLS"],"description":"The transport protocol: \nCan be either: \n- `UDP`:\n- `TCP`:\n- `TLS`:\n"},"url":{"type":"string","description":"Auto provision server URL.\n"}}}}}},"404":{"description":"Not Found"}}}}}}
```
## Update DECT phone
> Update a DECT phone.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phones/{id}":{"post":{"tags":["Auto Provisioning"],"operationId":"updateDectPhone","summary":"Update DECT phone","description":"Update a DECT phone.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of DECT phone.\n"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of DECT phone.\n"},"password":{"type":"string","description":"Password for accessing the Web interface of phone.\nThe username remains default because most phone manufacturers do not\nallow modification of the user name. This is supported for some phone model, such as \"Snom 300\".\n"},"user_password":{"type":"string","description":"The user password.\n"},"engineer_password":{"type":"string","description":"The engineer password.\n"},"timezone":{"type":"string","description":"The timezone of phone.\n"},"region":{"type":"string","description":"The country or region name of phone.\n"},"language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"Language for strings displayed on Phone Display LCD.\nSupported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN,\nGREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.\n"},"handset_language":{"type":"string","enum":["ENGLISH","CHINESE","DUTCH","FRENCH","GERMAN","GREEK","ITALIAN","JAPANESE","POLISH","RUSSIAN","SPANISH","SWEDISH","UKRAINIAN","BULGARIAN"],"description":"The handset language.\n"},"tone":{"type":"string","description":"The tone set of DECT phone.\n"},"rps":{"type":"boolean","description":"Send to RPS or not.\n"},"https":{"type":"boolean","description":"Whether to use https\n"},"codecs":{"type":"array","items":{"type":"string"},"description":"Settings for the priority of the codecs in this phone.\nThis indicates the first preferred codec.\n"},"interface":{"type":"string","enum":["WEB_DOMAIN","PUBLIC_IPV4","PUBLIC_IPV6","PRIVATE_IPV4","PRIVATE_IPV6","SBC_DOMAIN"],"description":"The interface type for QR code or auto provisioning. \nCan be neither: \n- `WEB_DOMAIN`:\n- `PUBLIC_IPV4`:\n- `PUBLIC_IPV6`:\n- `PRIVATE_IPV4`:\n- `PRIVATE_IPV6`:\n- `SBC_DOMAIN`:\n"},"preferred_transport":{"type":"string","enum":["UDP","TCP","TLS"],"description":"The transport protocol: \nCan be either: \n- `UDP`:\n- `TCP`:\n- `TLS`:\n"}}}}},"required":true},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Delete a DECT phone
> Delete a DECT phone by it's ID.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phones/{id}/destroy":{"post":{"tags":["Auto Provisioning"],"operationId":"DeleteDectPhone","summary":"Delete a DECT phone","description":"Delete a DECT phone by it's ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of DECT phone.\n"}}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## List DECT phone members
> Retrieve a collection of DECT phone members.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phones/{id}/members":{"get":{"tags":["Auto Provisioning"],"operationId":"listDectPhoneMembers","summary":"List DECT phone members","description":"Retrieve a collection of DECT phone members.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of DECT phone.\n"},"description":"The unique ID of the DECT phone."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"readOnly":true,"description":"The unique ID of extension.\n"},"extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of extension.\n"},"display_name":{"allOf":[{"type":"string","maxLength":1024,"description":"The display name of user.\n"}],"readOnly":true,"description":"The display name of extension.\n"},"ipui":{"type":"string","description":"The International Portable User Identity.\n"},"handset_index":{"type":"string","description":"The handset index.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update DECT phone member list
> Update DECT phone member list.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phones/{id}/members":{"post":{"tags":["Auto Provisioning"],"operationId":"updateDectPhoneMemberList","summary":"Update DECT phone member list","description":"Update DECT phone member list.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of DECT phone.\n"},"description":"The unique ID of DECT phone."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"readOnly":true,"description":"The unique ID of extension.\n"},"extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of extension.\n"},"display_name":{"allOf":[{"type":"string","maxLength":1024,"description":"The display name of user.\n"}],"readOnly":true,"description":"The display name of extension.\n"},"ipui":{"type":"string","description":"The International Portable User Identity.\n"},"handset_index":{"type":"string","description":"The handset index.\n"}}},"description":"Collection of extension members.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Check DECT phone member
> Check if extension is in DECT phone member list.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Auto Provisioning","description":"Manage your phone auto provisioning.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/dect_phones/{id}/members/{extension_number}":{"get":{"tags":["Auto Provisioning"],"operationId":"getDectPhoneMember","summary":"Check DECT phone member","description":"Check if extension is in DECT phone member list.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of DECT phone.\n"},"description":"The unique ID of the DECT phone.\n"},{"name":"extension_number","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"description":"The extension number of the member.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"readOnly":true,"description":"The unique ID of extension.\n"},"extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of extension.\n"},"display_name":{"allOf":[{"type":"string","maxLength":1024,"description":"The display name of user.\n"}],"readOnly":true,"description":"The display name of extension.\n"},"ipui":{"type":"string","description":"The International Portable User Identity.\n"},"handset_index":{"type":"string","description":"The handset index.\n"}}}}}},"404":{"description":"Not Found"}}}}}}
```