SwitchvoxExtendAPI - New pages [en]

Switchvox.network.hostAddresses.getInfo

Rnavaroli — Tue, 16 Apr 2013 19:15:00 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.network.hostAddresses.getInfo}} ==Description== Retrieve info about a specific network to host address mapping {{XMLAPI_ARGUMENTS_60 |p1_name=host_add...'

{{DISPLAYTITLE:switchvox.network.hostAddresses.getInfo}}
==Description==
Retrieve info about a specific network to host address mapping

{{XMLAPI_ARGUMENTS_60
|p1_name=host_address_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=ID of the host address mapping to update
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.network.hostAddresses.getInfo">
<parameters>
<host_address_id>13</host_address_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.network.hostAddresses.getInfo">
<result>
<host_address id="4" name="New Host" network="128.128.128.255/12" host="example.server.com" reregister="120" retry="25" failover_host="failover_example.server.com" failover_port="5060" failover_transport="udp" failover_reregister="120" failover_retry="25" ntp_server="pool.ntp.org" system="0" vlan_discovery_mode="LLDP" vlan_id="" is_trusted_network="0" rtp_qos="6" sip_qos="3" rtp_dscp="46" sip_dscp="26" />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=29085|p1_desc=The host_address_id is invalid or does not exist.
|p2_code=94574|p2_desc=System network host address mappings cannot be deleted.
}}

Switchvox.digiumPhones.apps.remove

Rnavaroli — Tue, 16 Apr 2013 19:14:30 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.apps.remove}} ==Description== Remove an existing app entirely from the system. This will notify any users of the app to retrieve a new confi...'

{{DISPLAYTITLE:switchvox.digiumPhones.apps.remove}}
==Description==
Remove an existing app entirely from the system. This will notify any users of the app to retrieve a new config, and thus remove it from their phones.

{{XMLAPI_ARGUMENTS
|p1_name=app_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=The id of the app you wish to delete.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.apps.remove">
<parameters>
<app_id>12</app_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.apps.remove">
<success/>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=59025
|p1_desc=Invalid (app_id). Value (X) must be all digits.
|p2_code=20442
|p2_desc=Invalid app_id, (1) does not exist.
}}

Switchvox.digiumPhones.apps.update

Rnavaroli — Tue, 16 Apr 2013 19:14:27 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.apps.update}} ==Description== Update an existing app already uploaded on the system. Change properties of the app, distribution, or replace ...'

{{DISPLAYTITLE:switchvox.digiumPhones.apps.update}}
==Description==
Update an existing app already uploaded on the system. Change properties of the app, distribution, or replace the app all together.

{{XMLAPI_ARGUMENTS
|p1_name=app_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=The id of the app you are updating
|p2_name=filename
|p2_required=optional
|p2_type=(see example)
|p2_default=
|p2_desc=A zip file
|p3_name=note
|p3_required=optional
|p3_type=string
|p3_default=
|p3_desc=Additional descriptive details for the app upload
|p4_name=auto_start
|p4_required=optional
|p4_type=boolean
|p4_default=0
|p4_desc=A boolean value (1 or 0) that represents whether or not you want the app to start automatically when the phone boots up., the first time it is loaded onto a phone, and if it were ever to encounter an error.
|p5_name=include_credentials
|p5_required=optional
|p5_type=boolean
|p5_default=0
|p5_desc=A boolean value (1 or 0) that represents whether or not you want the config file for users who are distributed this app to include the necessary appconfig credentials. These credentials can allow the app to perform API requests to the Switchvox using the users account.

|p6_name=users<div class="sub_name">user<div class="sub_name">id</div></div>
|p6_required=optional
|p6_type=int
|p6_default=
|p6_desc=Id of either an account or extension_group on the system. The type must match what type of id you are trying to use.
|p7_name=users<div class="sub_name">user<div class="sub_name">type</div></div>
|p7_required=optional
|p7_type=string
|p7_default=
|p7_desc= A value of either (extension_group | account) representing what type of id you are submitting.

|p9_name=settings<div class="sub_name">setting<div class="sub_name">key</div></div>
|p9_required=optional
|p9_type=string
|p9_default=
|p9_desc= The name of a setting you want to pass to the app.

|p10_name=settings<div class="sub_name">setting<div class="sub_name">value</div></div>
|p10_required=optional
|p10_type=string
|p10_default=
|p10_desc= The value of the setting you are submitting to the app. This can be a hard coded value for this app or correspond a set of [[Digium Phone Apps Wildcard Variables|wildcard replacement variables]] depending on the user.

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=Adding a new Digium Phone App. Note that the post is in multipart/form-data format to accommodate both the XML request and the binary data. This example was sent using the "curl" utility.}}
<source lang="xml">
POST /xml HTTP/1.1
User-Agent: curl/7.18.2 (i386-redhat-linux-gnu) libcurl/7.18.2 NSS/3.12.2.0
zlib/1.2.3 libidn/0.6.14 libssh2/0.18
Host: pbx.example.com
Accept: */*
Content-Length: 107721
Content-Type: multipart/form-data; boundary=----------------------------61049bb0cd09

------------------------------61049bb0cd09
Content-Disposition: form-data; name="request"
Content-Type: application/xml

<request method="switchvox.digiumPhones.apps.update">
<parameters>
<app_id>12</app_id>
<note>That weather app that Bob shared with me. Seeing if it is better than Toms</note>
<auto_start>1</auto_start>
<include_credentials>1</include_credentials>
<users>
<user>
<id>1203</id>
<type>account</type>
</user>
</users>
<settings>
<setting>
<key>zipcode</key>
<value>11201</value>
</setting>
</settings>
</parameters>
</request>
-----------------------------61049bb0cd09
Content-Disposition: form-data; name="filename"; filename="weather_app.zip"
Content-Type: application/zip

-----------------------------61049bb0cd09--
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=}}
<source lang="xml">
<response method="switchvox.digiumPhones.apps.update">
<success/>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

===Example Not using Form Data===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.apps.update">
<parameters>
<app_id>12</app_id>
<note>That weather app that Bob shared with me. Seeing if it is better than Toms</note>
<auto_start>1</auto_start>
<include_credentials>1</include_credentials>
<users>
<user>
<id>1203</id>
<type>account</type>
</user>
</users>
<settings>
<setting>
<key>zipcode</key>
<value>11201</value>
</setting>
</settings>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.apps.update">
<success/>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=90903
|p1_desc=Parameter "file" must be a file attachment. (Use a multipart/form-data post with "request" as your request and "file" as the file.)
|p2_code=21797
|p2_desc=Invalid note. Must be less than 256 characters and may only contain letters, numbers, spaces, and the following characters:\"&'():-_,.@#+
|p3_code=17769
|p3_desc=Invalid auto_start. Value must be either a 1 or a 0.
|p4_code=17769
|p4_desc=Invalid include_credentials. Value must be either a 1 or a 0.
|p5_code=55713
|p5_desc=A member has been passed in missing the id property. (from users)
|p6_code=10014
|p6_desc=Invalid account_id (1235). Account_ids may only contain digits. (from users)
|p7_code=84711
|p7_desc=That account_id is invalid. (from users)
|p8_code=66249
|p8_desc=Extension group Id can only be digits. (from users)
|p9_code=74243
|p9_desc=Invalid extension_group_id. Extension group ID (1241) does not exist. (from users)
|p10_code=91988
|p10_desc=Invalid setting-key_1 (). Must be at least 1 characters, not more than 32 characters in length and may only contain letters, numbers, underscores, and dashes.
|p11_code=21797
|p11_desc=Invalid setting-value_1. Must be less than 128 characters long.
|p12_code=59025
|p12_desc=Invalid (app_id). Value (X) must be all digits.
|p13_code=20442
|p13_desc=Invalid app_id, (1) does not exist.

|p14_code=37154
|p14_desc=Error writing file: %1
|p15_code=25695
|p15_desc=Error unzipping app package
|p16_code=95643
|p16_desc=Unable to locate app.json file
|p17_code=41594
|p17_desc=Error reading file %1
|p18_code=41594
|p18_desc=Error reading file %1
|p19_code=68687
|p19_desc=Invalid app name (%1). Must be 1 to 64 characters in length and beginning with an alphanumeric character and comprised of the same and/or the following characters '_', '.', and ','.
|p20_code=37871
|p20_desc=Missing required file %1
|p21_code=37154
|p21_desc=Error writing file: %1
|p22_code=24582
|p22_desc=Unable to save app package
}}

Switchvox.digiumPhones.apps.add

Rnavaroli — Tue, 16 Apr 2013 19:14:23 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.apps.add}} ==Description== Upload a valid Digium Phone App in zip format to the system for distribution to users (SIP accounts using Digium ...'

{{DISPLAYTITLE:switchvox.digiumPhones.apps.add}}
==Description==
Upload a valid Digium Phone App in zip format to the system for distribution to users (SIP accounts using Digium phones).

{{XMLAPI_ARGUMENTS
|p1_name=filename
|p1_required=required
|p1_type=(see example)
|p1_default=
|p1_desc=A zip file
|p2_name=note
|p2_required=optional
|p2_type=string
|p2_default=
|p2_desc=Additional descriptive details for the app upload
|p3_name=auto_start
|p3_required=optional
|p3_type=boolean
|p3_default=0
|p3_desc=A boolean value (1 or 0) that represents whether or not you want the app to start automatically when the phone boots up., the first time it is loaded onto a phone, and if it were ever to encounter an error.
|p4_name=include_credentials
|p4_required=optional
|p4_type=boolean
|p4_default=0
|p4_desc=A boolean value (1 or 0) that represents whether or not you want the config file for users who are distributed this app to include the necessary appconfig credentials. These credentials can allow the app to perform API requests to the Switchvox using the users account.
|p5_name=users<div class="sub_name">user<div class="sub_name">id</div></div>
|p5_required=optional
|p5_type=int
|p5_default=
|p5_desc=Id of either an account or extension_group on the system. The type must match what type of id you are trying to use.
|p6_name=users<div class="sub_name">user<div class="sub_name">type</div></div>
|p6_required=optional
|p6_type=string
|p6_default=
|p6_desc= A value of either (extension_group | account) representing what type of id you are submitting.
|p7_name=settings<div class="sub_name">setting<div class="sub_name">key</div></div>
|p7_required=optional
|p7_type=string
|p7_default=
|p7_desc= The name of a setting you want to pass to the app.
|p9_name=settings<div class="sub_name">setting<div class="sub_name">value</div></div>
|p9_required=optional
|p9_type=string
|p9_default=
|p9_desc= The value of the setting you are submitting to the app. This can be a hard coded value for this app or correspond a set of [[Digium Phone Apps Wildcard Variables|wildcard replacement variables]] depending on the user.

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=Adding a new Digium Phone App. Note that the post is in multipart/form-data format to accommodate both the XML request and the binary data. This example was sent using the "curl" utility.}}
<source lang="xml">
POST /xml HTTP/1.1
User-Agent: curl/7.18.2 (i386-redhat-linux-gnu) libcurl/7.18.2 NSS/3.12.2.0
zlib/1.2.3 libidn/0.6.14 libssh2/0.18
Host: pbx.example.com
Accept: */*
Content-Length: 107721
Content-Type: multipart/form-data; boundary=----------------------------61049bb0cd09

------------------------------61049bb0cd09
Content-Disposition: form-data; name="request"
Content-Type: application/xml

<request method="switchvox.digiumPhones.apps.add">
<parameters>
<note>That weather app that Bob shared with me. Seeing if it is better than Toms</note>
<auto_start>1</auto_start>
<include_credentials>1</include_credentials>
<users>
<user>
<id>1203</id>
<type>account</type>
</user>
</users>
<settings>
<setting>
<key>zipcode</key>
<value>11201</value>
</setting>
</settings>
</parameters>
</request>
-----------------------------61049bb0cd09
Content-Disposition: form-data; name="filename"; filename="weather_app.zip"
Content-Type: application/zip

-----------------------------61049bb0cd09--
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=Confirmation includes the ID of the new app.}}
<source lang="xml">
<response method="switchvox.digiumPhones.apps.add">
<result>
<app_id>12</app_id>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=90903
|p1_desc=Parameter "file" must be a file attachment. (Use a multipart/form-data post with "request" as your request and "file" as the file.)
|p2_code=21797
|p2_desc=Invalid note. Must be less than 256 characters and may only contain letters, numbers, spaces, and the following characters:\"&'():-_,.@#+
|p3_code=17769
|p3_desc=Invalid auto_start. Value must be either a 1 or a 0.
|p4_code=17769
|p4_desc=Invalid include_credentials. Value must be either a 1 or a 0.
|p5_code=55713
|p5_desc=A member has been passed in missing the id property. (from users)
|p6_code=10014
|p6_desc=Invalid account_id (1235). Account_ids may only contain digits. (from users)
|p7_code=84711
|p7_desc=That account_id is invalid. (from users)
|p8_code=66249
|p8_desc=Extension group Id can only be digits. (from users)
|p9_code=74243
|p9_desc=Invalid extension_group_id. Extension group ID (1241) does not exist. (from users)
|p10_code=91988
|p10_desc=Invalid setting-key_1 (). Must be at least 1 characters, not more than 32 characters in length and may only contain letters, numbers, underscores, and dashes.
|p11_code=21797
|p11_desc=Invalid setting-value_1. Must be less than 128 characters long.
|p12_code=37154
|p12_desc=Error writing file: %1
|p13_code=25695
|p13_desc=Error unzipping app package
|p14_code=95643
|p14_desc=Unable to locate app.json file
|p15_code=41594
|p15_desc=Error reading file %1
|p16_code=41594
|p16_desc=Error reading file %1
|p17_code=68687
|p17_desc=Invalid app name (%1). Must be 1 to 64 characters in length and beginning with an alphanumeric character and comprised of the same and/or the following characters '_', '.', and ','.
|p18_code=37871
|p18_desc=Missing required file %1
|p19_code=37154
|p19_desc=Error writing file: %1
|p20_code=24582
|p20_desc=Unable to save app package
}}

Switchvox.digiumPhones.apps.getInfo

Rnavaroli — Tue, 16 Apr 2013 19:14:15 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.apps.getInfo}} ==Description== Retrieve verbose details about a specific app based on app_id. {{XMLAPI_ARGUMENTS |p1_name=app_id |p1_requir...'

{{DISPLAYTITLE:switchvox.digiumPhones.apps.getInfo}}
==Description==
Retrieve verbose details about a specific app based on app_id.

{{XMLAPI_ARGUMENTS
|p1_name=app_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=The id of the app you wish to delete.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.apps.getInfo">
<parameters>
<app_id>110</app_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.apps.getInfo">
<result>
<app app_id="107" name="BigClock" note="" auto_start="0" include_credentials="0" filename="107_bigclock.zip" md5="d41d8cd98f00b204e9800998ecf8427e" user_count="5" icon_url="https://10.10.7.225/images/admin/D70.app_generic.png" description="" hidden="0" has_idle="1" type="foreground" >
<users>
<user id="1052" type="group" server_uuid="" />
<user id="1127" type="account" server_uuid="" />
<user id="1121" type="account" server_uuid="" />
<user id="1122" type="account" server_uuid="" />
</users>
<settings>
<setting key="nombre" value="%LAST_NAME%" />
</settings>
</app>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=59025
|p1_desc=Invalid (app_id). Value (X) must be all digits.
|p2_code=20442
|p2_desc=Invalid app_id, (1) does not exist.
}}

Switchvox.digiumPhones.apps.getList

Rnavaroli — Tue, 16 Apr 2013 19:14:11 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.apps.getList}} ==Description== Retrieve a list of all apps currently installed on the system. Gives you a brief amount of details on each. M...'

{{DISPLAYTITLE:switchvox.digiumPhones.apps.getList}}
==Description==
Retrieve a list of all apps currently installed on the system. Gives you a brief amount of details on each. More verbose information is available by using the getInfo API.

{{XMLAPI_ARGUMENTS}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.apps.getList">
<parameters>
<app_id>110</app_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.apps.getList">
<result>
<apps>
<app app_id="105" name="crm" note="My app" auto_start="0" include_credentials="0" filename="105_crm.zip" md5="d41d8cd98f00b204e9800998ecf8427e" user_count="0" icon_url="https://10.10.7.225/images/admin/D70.app_generic.png" description="" hidden="0" has_idle="0" type="foreground" >
</app>
<app app_id="104" name="Weather" note="" auto_start="0" include_credentials="0" filename="104_1354909775_weather_langd_out.zip" md5="d41d8cd98f00b204e9800998ecf8427e" user_count="0" icon_url="https://10.10.7.225/downloads/ItF,vPtDqwkp1FFdalVDJw.png" description="Simple weather app" hidden="0" has_idle="1" type="foreground" >
</app>
<app app_id="107" name="BigClock" note="" auto_start="0" include_credentials="0" filename="107_bigclock.zip" md5="d41d8cd98f00b204e9800998ecf8427e" user_count="5" icon_url="https://10.10.7.225/images/admin/D70.app_generic.png" description="" hidden="0" has_idle="1" type="foreground" >
</app>
</apps>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES}}

Switchvox.extensions.customSettings.remove

Rnavaroli — Tue, 16 Apr 2013 19:13:14 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.extensions.customSettings.remove}} ==Description== Delete all of the information pertaining to custom extension setting, Also, this will remove any value...'

{{DISPLAYTITLE:switchvox.extensions.customSettings.remove}}
==Description==
Delete all of the information pertaining to custom extension setting, Also, this will remove any values that may be saved by administrators or users pertaining to the 'key' in question.

{{XMLAPI_ARGUMENTS
|p1_name=key
|p1_required=required
|p1_type=string
|p1_default=
|p1_desc=The key all caps identifier of the custom setting.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=}}
<source lang="xml">
<request method="switchvox.extensions.customSettings.remove">
<parameters>
<key>ZIP_CODE</key>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=}}
<source lang="xml">
<response method="switchvox.extensions.customSettings.remove">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=33972
|p1_desc=Invalid format for key (%1). May only contain capital letters, numbers, underscores and must be less than 32 characters.
|p2_code=20442
|p2_desc=Invalid key, (%1) does not exist.
}}

Switchvox.extensions.customSettings.update

Rnavaroli — Tue, 16 Apr 2013 19:13:08 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.extensions.customSettings.update}} ==Description== Update a custom extension setting for the system. This is meant to work in conjunction with other aspe...'

{{DISPLAYTITLE:switchvox.extensions.customSettings.update}}
==Description==
Update a custom extension setting for the system. This is meant to work in conjunction with other aspects of the PBX.

{{XMLAPI_ARGUMENTS
|p1_name=key
|p1_required=required
|p1_type=string
|p1_default=
|p1_desc=This is an all caps string that serves as a unique identifier for this setting. It is used in replacement in other sections such as [[Switchvox.digiumPhones.apps.add|Digium Phone Apps ]].
|p2_name=name
|p2_required=optional
|p2_type=string
|p2_default=
|p2_desc=A descriptive name that describes the key / custom setting.
|p3_name=is_password
|p3_required=optional
|p3_type=string
|p3_default=
|p3_desc=Denotes whether or not this key corresponds to a password type field. If so users will be presented with password inputs instead of regular inputs. This will obscure their typing and add security.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=}}
<source lang="xml">
<request method="switchvox.extensions.customSettings.update">
<parameters>
<key>SECRETPASSWORD</key>
<is_password>1</is_password>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=}}
<source lang="xml">
<response method="switchvox.extensions.customSettings.update">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=33972
|p1_desc=Invalid format for key (%1). May only contain capital letters, numbers, underscores and must be less than 32 characters.
|p2_code=20442
|p2_desc=Invalid key, (%1) does not exist.
}}

Switchvox.extensions.customSettings.add

Rnavaroli — Tue, 16 Apr 2013 19:12:59 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.extensions.customSettings.add}} ==Description== Create a new custom extension setting for the system. This is meant to work in conjunction with other asp...'

{{DISPLAYTITLE:switchvox.extensions.customSettings.add}}
==Description==
Create a new custom extension setting for the system. This is meant to work in conjunction with other aspects of the PBX. The current sections that support the use of the custom extension settings are... [[Switchvox.digiumPhones.apps.add|Digium Phone Apps ]].

Custom settings allow you to create your own unique settings which values can be managed on any users phone settings. These can be modified in the administrative portal (including bulk modify) as well as the users portal.

{{XMLAPI_ARGUMENTS
|p1_name=key
|p1_required=required
|p1_type=string
|p1_default=
|p1_desc=This is an all caps string that serves as a unique identifier for this setting. It is used in replacement in other sections such as [[Switchvox.digiumPhones.apps.add|Digium Phone Apps ]].
|p2_name=name
|p2_required=required
|p2_type=string
|p2_default=
|p2_desc=A descriptive name that describes the key / custom setting.
|p3_name=is_password
|p3_required=optional
|p3_type=string
|p3_default=0
|p3_desc=Denotes whether or not this key corresponds to a password type field. If so users will be presented with password inputs instead of regular inputs. This will obscure their typing and add security.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=}}
<source lang="xml">
<request method="switchvox.extensions.customSettings.add">
<parameters>
<key>ZIP_CODE</key>
<name>Zip Code</name>
<is_password>0</is_password>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=}}
<source lang="xml">
<response method="switchvox.extensions.customSettings.add">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=33972
|p1_desc=Invalid format for key (%1). May only contain capital letters, numbers, underscores and must be less than 32 characters.
}}

Switchvox.extensions.customSettings.getInfo

Rnavaroli — Tue, 16 Apr 2013 19:12:51 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.extensions.customSettings.getInfo}} ==Description== Retrieve the settings for a specific key that already exists. {{XMLAPI_ARGUMENTS |p1_name=key |p1_r...'

{{DISPLAYTITLE:switchvox.extensions.customSettings.getInfo}}
==Description==
Retrieve the settings for a specific key that already exists.

{{XMLAPI_ARGUMENTS
|p1_name=key
|p1_required=required
|p1_type=string
|p1_default=
|p1_desc=The key all caps identifier of the custom setting.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=}}
<source lang="xml">
<request method="switchvox.extensions.customSettings.getInfo">
<parameters>
<key>ZIP_CODE</key>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=}}
<source lang="xml">
<response method="switchvox.extensions.customSettings.getInfo">
<result>
<custom_setting key="ZIP_CODE" name="Zip Code" is_password="0" />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=33972
|p1_desc=Invalid format for key (%1). May only contain capital letters, numbers, underscores and must be less than 32 characters.
|p2_code=20442
|p2_desc=Invalid key, (%1) does not exist.
}}

Switchvox.extensions.customSettings.getList

Rnavaroli — Tue, 16 Apr 2013 19:12:38 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.extensions.customSettings.getList}} ==Description== Retrieve the list of all currently created custom extension settings on the system. {{XMLAPI_ARGUMEN...'

{{DISPLAYTITLE:switchvox.extensions.customSettings.getList}}
==Description==
Retrieve the list of all currently created custom extension settings on the system.

{{XMLAPI_ARGUMENTS}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}

{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=}}
<source lang="xml">
<request method="switchvox.extensions.customSettings.getList">
<parameters>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=}}
<source lang="xml">
<response method="switchvox.extensions.customSettings.getList">
<result>
<custom_settings>
<custom_setting key="CRM_PASS" name="CRM Password" is_password="1" />
<custom_setting key="FAVORITE_HAT" name="Favorite Hat" is_password="0" />
<custom_setting key="ZIP_CODE" name="Zip Code" is_password="0" />
</custom_settings>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES}}

Switchvox.extensions.settings.update

Rnavaroli — Tue, 16 Apr 2013 19:12:22 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.extensions.settings.update}} ==Description== Update the extensions settings. {{XMLAPI_ARGUMENTS_60 |p1_name=extension_length_constraint |p1_required=o...'

{{DISPLAYTITLE:switchvox.extensions.settings.update}}
==Description==
Update the extensions settings.

{{XMLAPI_ARGUMENTS_60
|p1_name=extension_length_constraint
|p1_required=optional
|p1_type=integer [3-6]
|p1_default=
|p1_desc=Length of the extensions in Switchvox
|p2_name=beep_after_assisted_transfer
|p2_required=optional
|p2_type=boolean
|p2_default=
|p2_desc=If 1 plays a beep sound when an assisted transfer is done.
|p3_name=require_strong_user_password
|p3_required=optional
|p3_type=boolean
|p3_default=
|p3_desc=If 1 requires that extension-owners use strong extension passwords.
|p4_name=require_strong_phone_password
|p4_required=optional
|p4_type=boolean
|p4_default=
|p4_desc=If 1 requires that phones register with Switchvox using a strong password.
|p5_name=force_weak_user_password_change
|p5_required=optional
|p5_type=boolean
|p5_default=
|p5_desc=If 1 requires that all extension-owners change their password if it is not already strong.

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.extensions.settings.update">
<parameters>
<extension_length_constraint>3</extension_length_constraint>
<beep_after_assisted_transfer>0</beep_after_assisted_transfer>
<require_strong_user_password>1</require_strong_user_password>
<require_strong_phone_password>0</require_strong_phone_password>
<force_weak_user_password_change>1</force_weak_user_password_change>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.extensions.settings.update">
<result>
<success />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

Switchvox.extensions.settings.getInfo

Rnavaroli — Tue, 16 Apr 2013 19:12:04 GMT

Rnavaroli: Created page with '{{DISPLAYTITLE:switchvox.extensions.settings.getInfo}} ==Description== Retrieve all the extensions settings. {{XMLAPI_ARGUMENTS_60 }} {{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_...'

{{DISPLAYTITLE:switchvox.extensions.settings.getInfo}}
==Description==
Retrieve all the extensions settings.

{{XMLAPI_ARGUMENTS_60
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.extensions.settings.getInfo">
<parameters>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.extensions.settings.getInfo">
<result>
<extensions_settings extension_length_constraint="3" beep_after_assisted_transfer="0" require_strong_user_password="1" require_strong_phone_password="" force_weak_user_password_change="1" />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

Switchvox.externalContacts.update

Dblood — Tue, 06 Mar 2012 00:29:26 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.externalContacts.update}} ==Description== Update your externalContacts sheet with a newly uploaded file / file_id uploaded from [[Switchvox.file.add|swi...'

{{DISPLAYTITLE:switchvox.externalContacts.update}}
==Description==
Update your externalContacts sheet with a newly uploaded file / file_id uploaded from [[Switchvox.file.add|switchvox.file.add]]

===Example CSV===
<source lang="xml">
first_name, last_name, organization, job_title, location, email_address, primary_number, primary_number_label, secondary_number, secondary_number_label, jabber_id, subscription_url
Ryan,Ravarioli,WizCom,Grand Wizlord,Wizard Town,mfp@wizlord.com,6016565446,Mobile,6015351253,Home,mfp2002,54@host.com
Karl,Lopez,WizCom,Junior Wizlord,Wizard Town,jl@wizlord.com,555555555
</source>
===Example XML===
<source lang="xml">
<phonebooks>
<contacts group_name="PBX Directory" editable="0" id="">
<contact
id="1004"
prefix="Mr"
first_name="David"
second_name="Wesley"
last_name="Podolsky"
suffix="III"
picture="http://pbx.site.com/images/cil.jpg"
contact_type="sip|call_queue|external"
organization="Digium"
job_title="Direction Manager"
location="East Texas"
integration_source="Salesforce"
notes=""
subscription_url="101@ip.pbx.com"
can_intercom="1"
can_page="1"
can_pickup_ringing="1"
>
<numbers>
<number dial="104" dial_prefix="" label="Extension" primary="1" />
<number dial="8583379236" dial_prefix="9" label="Mobile" /> </numbers>
<emails>
<email address="dwp@switchvox.com" label="Work" primary="1" />
</emails>
<chats>
<chat type="jabber" id="123123" display="Jabber"/>
</chats>
</contact>
</contacts>
</phonebooks>
</source>

{{XMLAPI_ARGUMENTS
|p1_name=file_id
|p1_required=required
|p1_type=integer
|p1_default=
|p1_desc=id of a file added with switchvox.file.add
|p2_name=digits_to_prepend
|p2_required=
|p2_type=string
|p2_default=
|p2_desc=digits or (*,#,%) that get prepended on the front of numbers when processing the uploaded sheet.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.externalContacts.update">
<parameters>
<file_id>63</file_id>
<digits_to_prepend>9</digits_to_prepend>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.externalContacts.update">
<result>
<external_contact num_success="240" num_error="0" link="https://10.10.2.108/dl?cmd=get_external_contacts_xml&id=externalContacts&hash=592ffd246e85c21e614d27b27ad15270" />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=47895|p1_desc=There was an error writing the formatted XML.
|p2_code=28243|p2_desc=Trying to process file as a CSV. Required fields in the header line were found missing (%1).
}}

Switchvox.externalContacts.remove

Dblood — Tue, 06 Mar 2012 00:28:36 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.externalContacts.remove}} ==Description== Remove the external contacts from your system. {{XMLAPI_ARGUMENTS }} {{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_...'

{{DISPLAYTITLE:switchvox.externalContacts.remove}}
==Description==
Remove the external contacts from your system.
{{XMLAPI_ARGUMENTS
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=}}
<source lang="xml">
<request method="switchvox.externalContacts.remove">
<parameters>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=}}
<source lang="xml">
<response method="switchvox.externalContacts.remove">
<result>
<success />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

Switchvox.externalContacts.getInfo

Dblood — Tue, 06 Mar 2012 00:27:34 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.externalContacts.getInfo}} ==Description== Returns info about externalContacts such as number of contacts, a link to request the file, and the date it wa...'

{{DISPLAYTITLE:switchvox.externalContacts.getInfo}}
==Description==
Returns info about externalContacts such as number of contacts, a link to request the file, and the date it was last uploaded.

{{XMLAPI_ARGUMENTS
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=Get info about status of external contacts}}
<source lang="xml">
<request method="switchvox.externalContacts.getInfo">
<parameters>
</parameters>
</request>

</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=Response with an uploaded external contact sheet)}}
<source lang="xml">
<response method="switchvox.externalContacts.getInfo">
<result>
<external_contacts has_contacts="1" num_contacts="240" last_uploaded="2011-10-20 13:46:00" link="https://10.10.2.108/dl?cmd=get_external_contacts_xml&id=externalContacts&hash=592ffd246e85c21e614d27b27ad15270" />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=Response without an uploaded external contact sheet)}}
<source lang="xml">
<result>
<external_contacts has_contacts="0" num_contacts="0" />
</result>
</response>

</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES

}}

Switchvox.extensions.phones.virtual.getInfo

Dblood — Tue, 06 Mar 2012 00:26:35 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.extensions.phones.virtual.getInfo}} ==Description== Retrieve information on an existing virtual phone extension from the system. {{XMLAPI_ARGUMENTS_60...'

{{DISPLAYTITLE:switchvox.extensions.phones.virtual.getInfo}}
==Description==
Retrieve information on an existing virtual phone extension from the system.

{{XMLAPI_ARGUMENTS_60
|p1_name=account_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=The account ID of the extension to get info for.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.extensions.phones.virtual.getInfo">
<parameters>
<account_id>1808</account_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.extensions.phones.virtual.getInfo">
<result>
<extension number="151" type="virtual" account_id="1808" first_name="Joe" last_name="Smith" email_address="jsmith@example.com" vm_quota="" prepend_for_outgoing="9" prepend_one="1" dtmfmode="rfc2833" nat="yes" template_account_id="1" first_name_editable="1" last_name_editable="1" email_address_editable="1" password_editable="1" force_password_change="1" voicemail="1" web_admin="1" vm_attachments="1" call_block="1" call_unpark="1" transfer_call="1" call_cascade="1" call_ringall="1" voicemail_forwarding="1" custom_voicemail_email="1" switchboard_chat="1" >
<supported_codecs>
<supported_codec name="h264"/>
<supported_codec name="h263"/>
<supported_codec name="g722"/>
<supported_codec name="ulaw"/>
<supported_codec name="alaw"/>
</supported_codecs>
<outgoing_call_rules_allow>
</outgoing_call_rules_allow>
<outgoing_call_rules_deny>
</outgoing_call_rules_deny>
<extension_groups>
<extension_group id="1" name="Default Group" public="1"/>
<extension_group id="1001" name="All Extensions" public="1"/>
</extension_groups>
</extension>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=10014|p1_desc=Invalid account_id (%1). Account_ids may only contain digits.
|p2_code=84711|p2_desc=That account_id is invalid.
}}

Switchvox.extensions.phones.sip.getInfo

Dblood — Tue, 06 Mar 2012 00:25:32 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.extensions.phones.sip.getInfo}} ==Description== Retrieve information on an existing sip phone extension from the system. {{XMLAPI_ARGUMENTS_60 |p1_na...'

{{DISPLAYTITLE:switchvox.extensions.phones.sip.getInfo}}
==Description==
Retrieve information on an existing sip phone extension from the system.

{{XMLAPI_ARGUMENTS_60
|p1_name=account_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=The account ID of the extension to get info for.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.extensions.phones.sip.getInfo">
<parameters>
<account_id>1101</account_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.extensions.phones.sip.getInfo">
<result>
<extension server_uuid="4428492265501239296" number="100" account_id="1101" first_name="Joe" last_name="Smith" email_address="jsmith@example.com" title="Software Engineer" template_id="1" type="sip" profile_image_id="0" location="San Jose" prepend_for_outgoing="9" prepend_one="1" lang_locale="en_us" force_password_change="0" force_lang_change="0" sound_prompt_language_id="0" lightweight_mode="0" dtmfmode="rfc2833" nat="yes" voicemail_quota="" pbx_managed_phone="0" line_label="" hide_missed_calls="0" sb_auto_answer="0" no_profile_popup_in="0" no_profile_popup_out="1" line2_active="0" line3_active="0" line_keys_per_num="1" secondary_line="0">
<supported_codecs>
<supported_codec id="h264"/>
<supported_codec id="h263"/>
<supported_codec id="g722"/>
<supported_codec id="ulaw"/>
<supported_codec id="alaw"/>
</supported_codecs>
<permissions>
<permission id="change_first_name" value="1" />
<permission id="change_last_name" value="1" />
<permission id="change_email_address" value="1" />
<permission id="change_language" value="1" />
<permission id="change_password" value="1" />
<permission id="change_location" value="1" />
<permission id="change_title" value="1" />
<permission id="change_picture" value="1" />
<permission id="change_sound_prompt_language" value="1" />
<permission id="use_call_block" value="1" />
<permission id="use_call_forward" value="1" />
<permission id="use_call_cascade" value="1" />
<permission id="use_secret_code" value="1" />
<permission id="use_ring_all" value="1" />
<permission id="can_create_decline" value="1" />
<permission id="use_voicemail" value="1" />
<permission id="receive_voicemail_attachments" value="1" />
<permission id="use_voicemail_forwarding" value="1" />
<permission id="use_voicemail_notifications" value="1" />
<permission id="use_web_suite" value="1" />
<permission id="use_mobile_apps" value="1" />
<permission id="use_sip_phone_apps" value="1" />
<permission id="use_switchboard" value="1" />
<permission id="use_chat" value="1" />
<permission id="unpark_calls" value="1" />
<permission id="record_calls" value="1" />
<permission id="use_ringtones" value="1" />
<permission id="upload_ringtones" value="1" />
<permission id="use_icm" value="1" />
<permission id="can_converge_phones" value="1" />
<permission id="change_lightweight_mode" value="1" />
<permission id="digium_use_queues_app" value="1" />
<permission id="digium_use_parking_lot_app" value="1" />
<permission id="digium_use_phonebooks_app" value="1" />
<permission id="digium_use_system_directory" value="1" />
<permission id="digium_use_visual_voicemail" value="1" />
<permission id="digium_use_presence" value="" />
<permission id="digium_can_forward_calls" value="1" />
<permission id="digium_change_line_label" value="1" />
<permission id="digium_change_language" value="1" />
<permission id="digium_change_idle_screen" value="1" />
<permission id="digium_change_mc_notification" value="1" />
<permission id="digium_change_msgs_button" value="1" />
<permission id="digium_change_display_settings" value="1" />
<permission id="digium_change_sounds_settings" value="1" />
<permission id="digium_change_caller_profiles" value="1" />
<permission id="digium_change_auto_answer" value="1" />
<permission id="digium_send_to_voicemail" value="1" />
<permission id="digium_can_ignore_call" value="1" />
</permissions>
<outgoing_call_rules>
<outgoing_call_rule id="4" state="allow" />
<outgoing_call_rule id="2" state="deny" />
<outgoing_call_rule id="3" state="allow" />
<outgoing_call_rule id="5" state="allow" />
<outgoing_call_rule id="6" state="allow" />
<outgoing_call_rule id="1" state="allow" />
<outgoing_call_rule id="100" state="allow" />
</outgoing_call_rules>
<extension_groups>
<extension_group id="1" name="Default Group" public="1" />
<extension_group id="1001" name="All Extensions" public="1" />
<extension_group id="1010" name="qmem_1324590185" public="0" />
<extension_group id="1011" name="qperm_1324590186" public="0" />
<extension_group id="1021" name="qmem_1324592328" public="0" />
<extension_group id="1022" name="qperm_1324592329" public="0" />
<extension_group id="1023" name="qmem_1324592459" public="0" />
<extension_group id="1024" name="qperm_1324592460" public="0" />
<extension_group id="1027" name="qmem_1324593213" public="0" />
<extension_group id="1028" name="qperm_1324593214" public="0" />
</extension_groups>
<digium_phone_settings line_label="%EXTENSION% blah" visual_voicemail="1" idle_image_id="0" missed_calls_notification="1" brightness="5" contrast="5" dim_backlight="1" backlight_timeout="30" backlight_dim_level="2" ringer_volume="3" speaker_volume="5" handset_volume="5" headset_volume="5" reset_call_volume="0" headset_answer="0" electronic_hook_switch="regular" auto_answer_from_sb="1" show_incoming_caller_profile="1" show_outgoing_caller_profile="1" accept_local_calls="host" local_sip_port="5060" ringtone="ring1" override_dial_plan="0" dial_plan="[0-8]xx|911|9411|9611|9011xxx.T3|91xxxxxxxxxx|9[2-9]xxxxxx|*xx.T3|[0-8]xx.T3" assignment_id="2" skip_line_keys_for_blf="0" change_phone_password_on_steal="1" admin_password="63087" >
<codecs>
<codec name="g729" enabled="0" priority="1" target_holding_time="0" minimum_holding_time="0" maximum_holding_time="0" packetization_period="20" />
<codec name="g726" enabled="1" priority="2" target_holding_time="0" minimum_holding_time="0" maximum_holding_time="0" packetization_period="20" />
<codec name="pcmu" enabled="1" priority="3" target_holding_time="0" minimum_holding_time="0" maximum_holding_time="0" packetization_period="20" />
<codec name="pcma" enabled="1" priority="4" target_holding_time="0" minimum_holding_time="0" maximum_holding_time="0" packetization_period="20" />
<codec name="g722" enabled="1" priority="5" target_holding_time="0" minimum_holding_time="0" maximum_holding_time="0" packetization_period="20" />
</codecs>
</digium_phone_settings>
</extension>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=10014|p1_desc=Invalid account_id (%1). Account_ids may only contain digits.
|p2_code=84711|p2_desc=That account_id is invalid.
}}

Switchvox.extensions.phones.sip.bulkUpdate

Dblood — Tue, 06 Mar 2012 00:22:57 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.extensions.phones.sip.bulkUpdate}} ==Description== Updates a SIP extension. If values are not passed in for parameters then they are left unchanged. {{X...'

{{DISPLAYTITLE:switchvox.extensions.phones.sip.bulkUpdate}}
==Description==
Updates a SIP extension. If values are not passed in for parameters then they are left unchanged.

{{XMLAPI_ARGUMENTS_80
|p1_name=account_id
|p1_required=required
|p1_type=number
|p1_default=
|p1_desc=The account_id of the sip extension you want to update.

|p2_name=first_name
|p2_required=optional
|p2_type=string
|p2_default=
|p2_desc=First name.

|p3_name=voicemail_password
|p3_required=optional
|p3_type=string
|p3_default=
|p3_desc=Password to access voicemail and the web suite

|p5_name=last_name
|p5_required=optional
|p5_type=number
|p5_default=
|p5_desc=Last name.

|p6_name=email_address
|p6_required=optional
|p6_type=string
|p6_default=
|p6_desc=Email address.

|p7_name=location
|p7_required=optional
|p7_type=string
|p7_default=
|p7_desc=The profile location for this account. For example, "San Diego Office".

|p8_name=title
|p8_required=optional
|p8_type=string
|p8_default=
|p8_desc=The profile title for this account. For example, "Software Developer".

|p9_name=lang_locale
|p9_required=optional
|p9_type=string
|p9_default=
|p9_desc=The language _ locale for this account. For example, en_us.

|p11_name=voicemail_quota
|p11_required=optional
|p11_type=number
|p11_default=
|p11_desc=Voicemail mailbox quota in megabytes. Must be numeric.

|p12_name=prepend_for_outgoing
|p12_required=optional
|p12_type=number
|p12_default=
|p12_desc=Digits to prepend if number is not an extension. Must be numeric or blank.

|p13_name=prepend_one
|p13_required=optional
|p13_type=boolean
|p13_default=
|p13_desc=If set to '1', prepends a 1 if number is 10 digits in length. Set to '0' otherwise.

|p14_name=dtmfmode
|p14_required=optional
|p14_type=enum
|p14_default=
|p14_desc=DTMF mode. Valid values are: rfc2833, inband and info.

|p15_name=phone_password
|p15_required=optional
|p15_type=string
|p15_default=generated
|p15_desc=Phone password. If not supplied the system will generate a strong random password for your phone.

|p16_name=nat
|p16_required=optional
|p16_type=enum
|p16_default=
|p16_desc=Phone NAT traversal. Valid values: yes, no, never and route.

|p17_name=force_password_change
|p17_required=optional
|p17_type=boolean
|p17_default=
|p17_desc=Force the user to change their password on next login

|p18_name=force_lang_change
|p18_required=optional
|p18_type=boolean
|p18_default=
|p18_desc=Force the user to change / confirm their language on next login

|p19_name=sound_prompt_language_id
|p19_required=optional
|p19_type=number
|p19_default=
|p19_desc=Set the language the sound prompts for the user will play in

|p20_name=lightweight_mode
|p20_required=optional
|p20_type=boolean
|p20_default=0
|p20_desc=If set to 1, renders the UI in lightweight mode

|p26_name=supported_codecs
|p26_required=optional
|p26_type=enum
|p26_default=
|p26_desc=List of supported codecs. Valid values: ulaw, alaw, gsm, g726, adpcm, lpc10, speex, g729, g722, h263, h263p, h264.

|p27_name=add_outgoing_call_rules<div class="sub_name">add_outgoing_call_rule<div class="sub_name">id</div></div>
|p27_required=optional
|p27_type=number
|p27_default=
|p27_desc=The id of the outgoing call rule to add

|p28_name=add_outgoing_call_rules<div class="sub_name">add_outgoing_call_rule<div class="sub_name">state</div></div>
|p28_required=optional
|p28_type=string
|p28_default=
|p28_desc=The state of the outgoing call rule for the extension. Possible value: allow/deny

|p29_name=add_to_extension_groups<div class="sub_name">add_to_extension_group<div class="sub_name">id</div></div>
|p29_required=optional
|p29_type=enum
|p29_default=
|p29_desc=List of extension group IDs for this extension to join.

|p30_name=permissions<div class="sub_name">permission<div class="sub_name">id</div></div>
|p30_required=optional
|p30_type=enum
|p30_default=
|p30_desc=Id of the permission. Click [[Permissions IDs]]

|p31_name=permissions<div class="sub_name">permission<div class="sub_name">value</div></div>
|p31_required=optional
|p31_type=boolean
|p31_default=
|p31_desc=Allow (1) / deny (0) access to a given permissions / feature. If the permissions is not included it defaults to value from template.

|p32_name=remove_outgoing_call_rules<div class="sub_name">remove_outgoing_call_rule<div class="sub_name">id</div></div>
|p32_required=optional
|p32_type=number
|p32_default=
|p32_desc=The id of the outgoing call rule to remove

|p33_name=remove_from_extension_groups<div class="sub_name">remove_from_extension_group<div class="sub_name">id</div></div>
|p33_required=optional
|p33_type=enum
|p33_default=
|p33_desc=List of extension group IDs for this extension to leave.

|p34_name=digium_phone_settings<div class="sub_name">language</div>
|p34_required=optional
|p34_type=
|p34_default=
|p34_desc=The language for the phone. This can be different than the language for the extension.

|p35_name=digium_phone_settings<div class="sub_name">visual_voicemail</div>
|p35_required=optional
|p35_type=boolean
|p35_default=1
|p35_desc=Use Visual Voicemail

|p36_name=digium_phone_settings<div class="sub_name">voicemail_extension</div>
|p36_required=optional
|p36_type=integer
|p36_default=
|p36_desc=When Visual Voicemail is not used, what is the voicemail extension? Required when visual_voicemail is 0.

|p37_name=digium_phone_settings<div class="sub_name">missed_calls_notification</div>
|p37_required=optional
|p37_type=boolean
|p37_default=1
|p37_desc=

|p38_name=digium_phone_settings<div class="sub_name">brightness</div>
|p38_required=optional
|p38_type=integer
|p38_default=5
|p38_desc=Integer between 0 - 10

|p39_name=digium_phone_settings<div class="sub_name">contrast</div>
|p39_required=optional
|p39_type=integer
|p39_default=5
|p39_desc=Integer between 0 - 10

|p40_name=digium_phone_settings<div class="sub_name">backlight_timeout</div>
|p40_required=optional
|p40_type=integer
|p40_default=0
|p40_desc=Integer between 0 - 999. 0 = never.

|p41_name=digium_phone_settings<div class="sub_name">ringer_volume</div>
|p41_required=optional
|p41_type=integer
|p41_default=5
|p41_desc=Integer between 0 - 10

|p42_name=digium_phone_settings<div class="sub_name">speaker_volume</div>
|p42_required=optional
|p42_type=integer
|p42_default=5
|p42_desc=Integer between 0 - 10

|p43_name=digium_phone_settings<div class="sub_name">handset_volume</div>
|p43_required=optional
|p43_type=integer
|p43_default=5
|p43_desc=Integer between 0 - 10

|p44_name=digium_phone_settings<div class="sub_name">headset_volume</div>
|p44_required=optional
|p44_type=integer
|p44_default=5
|p44_desc=Integer between 0 - 10

|p45_name=digium_phone_settings<div class="sub_name">reset_call_volume</div>
|p45_required=optional
|p45_type=boolean
|p45_default=0
|p45_desc=*reset after each call to default. false=next call starts at last call's volume

|p46_name=digium_phone_settings<div class="sub_name">headset_answer</div>
|p46_required=optional
|p46_type=
|p46_default=
|p46_desc=

|p47_name=digium_phone_settings<div class="sub_name">electronic_hook_switch</div>
|p47_required=optional
|p47_type=boolean
|p47_default=0
|p47_desc=*enable headset answer button

|p48_name=digium_phone_settings<div class="sub_name">auto_answer_from_sb</div>
|p48_required=optional
|p48_type=boolean
|p48_default=1
|p48_desc=

|p49_name=digium_phone_settings<div class="sub_name">show_incoming_caller_profile</div>
|p49_required=optional
|p49_type=boolean
|p49_default=1
|p49_desc= *popup on the phone

|p50_name=digium_phone_settings<div class="sub_name">show_outgoing_caller_profile</div>
|p50_required=optional
|p50_type=boolean
|p50_default=1
|p50_desc=*popup on the phone

|p51_name=digium_phone_settings<div class="sub_name">accept_local_calls</div>
|p51_required=optional
|p51_type=enum
|p51_default=any
|p51_desc=can be 'host', 'whitelist' or 'any'. When 'whitelist', a list of hosts must be provided.

|p52_name=digium_phone_settings<div class="sub_name">whitelist_hosts</div>
|p52_required=optional
|p52_type=array
|p52_default=
|p52_desc=a list of hosts when accept_local_calls is 'whitelist'. in the inet format: 192.168.1.1/24

|p53_name=digium_phone_settings<div class="sub_name">local_sip_port</div>
|p53_required=optional
|p53_type=integer
|p53_default=5060
|p53_desc=

|p54_name=digium_phone_settings<div class="sub_name">override_dial_plan</div>
|p54_required=optional
|p54_type=boolean
|p54_default=0
|p54_desc=Must provide a dial plan if this is true.

|p55_name=digium_phone_settings<div class="sub_name">dial_plan</div>
|p55_required=optional
|p55_type=string
|p55_default=
|p55_desc=This must be specified if override_dial_plan = 1

|p56_name=digium_phone_settings<div class="sub_name">ringtone</div>
|p56_required=optional
|p56_type=string
|p56_default=
|p56_desc=

|p57_name=digium_phone_settings<div class="sub_name">idle_image_id</div>
|p57_required=optional
|p57_type=
|p57_default=
|p57_desc=

|p58_name=digium_phone_settings<div class="sub_name">codecs</div>
|p58_required=optional
|p58_type=
|p58_default=
|p58_desc=

|p59_name=digium_phone_settings<div class="sub_name">skip_line_keys_for_blf</div>
|p59_required=optional
|p59_type=boolean
|p59_default=
|p59_desc=

|p60_name=digium_phone_settings<div class="sub_name">codecs<div class="sub_name">codec<div class="sub_name">name</div></div></div>
|p60_required=optional
|p60_type=string
|p60_default=
|p60_desc=

|p61_name=digium_phone_settings<div class="sub_name">codecs<div class="sub_name">codec<div class="sub_name">packetization_period</div></div></div>
|p61_required=optional
|p61_type=integer
|p61_default=
|p61_desc=

|p62_name=digium_phone_settings<div class="sub_name">codecs<div class="sub_name">codec<div class="sub_name">minimum_holding_time</div></div></div>
|p62_required=optional
|p62_type=integer
|p62_default=
|p62_desc=

|p63_name=digium_phone_settings<div class="sub_name">codecs<div class="sub_name">codec<div class="sub_name">maximum_holding_time</div></div></div>
|p63_required=optional
|p63_type=integer
|p63_default=
|p63_desc=

|p64_name=digium_phone_settings<div class="sub_name">codecs<div class="sub_name">codec<div class="sub_name">target_holding_time</div></div></div>
|p64_required=optional
|p64_type=integer
|p64_default=
|p64_desc=

|p65_name=digium_phone_settings<div class="sub_name">codecs<div class="sub_name">codec<div class="sub_name">enabled</div></div></div>
|p65_required=optional
|p65_type=boolean
|p65_default=
|p65_desc=

|p66_name=digium_phone_settings<div class="sub_name">codecs<div class="sub_name">codec<div class="sub_name">priority</div></div></div>
|p66_required=optional
|p66_type=integer
|p66_default=
|p66_desc=

|p67_name=digium_phone_settings<div class="sub_name">line_label</div>
|p67_required=optional
|p67_type=string
|p67_default=%FIRST% %LAST%
|p67_desc=The display or template string to appear on the phone as the extension's name.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.extensions.phones.sip.bulkUpdate">
<parameters>
<account_ids>
<account_id>1101</account_id>
<account_id>1102</account_id>
</account_ids>
<first_name>Joe</first_name>
<voicemail_password>908231</voicemail_password>
<last_name>Updated</last_name>
<email_address>jupdated@example.com</email_address>
<location>San Jose</location>
<title>Software Engineer</title>
<lang_locale>en_us</lang_locale>
<lightweight_mode>0</lightweight_mode>
<voicemail_quota>10</voicemail_quota>
<prepend_for_outgoing>9</prepend_for_outgoing>
<prepend_one>1</prepend_one>
<dtmfmode>rfc2833</dtmfmode>
<phone_password>dfdfefefe</phone_password>
<nat>1</nat>
<force_password_change>1</force_password_change>
<force_lang_change>1</force_lang_change>
<sound_prompt_language_id>0</sound_prompt_language_id>
<permissions>
<permission>
<id>change_first_name</id>
<value>1</value>
</permission>
</permissions>
<supported_codecs>
<supported_codec name="h264"/>
<supported_codec name="h263"/>
<supported_codec name="g722"/>
<supported_codec name="ulaw"/>
<supported_codec name="alaw"/>
</supported_codecs>
<add_outgoing_call_rules>
<add_outgoing_call_rule>
<id>1</id>
<state>deny</state>
</add_outgoing_call_rule>
</add_outgoing_call_rules>
<remove_outgoing_call_rules>
<remove_outgoing_call_rule>2</remove_outgoing_call_rule>
<remove_outgoing_call_rule>3</remove_outgoing_call_rule>
<add_to_extension_groups>
<add_to_extension_group>1201</add_to_extension_group>
<add_to_extension_group>1202</add_to_extension_group>
</add_to_extension_groups>
<remove_from_extension_groups>
<remove_from_extension_group>1205</remove_from_extension_group>
<remove_from_extension_group>1206</remove_from_extension_group>
</remove_from_extension_groups>
<digium_phone_settings>
<line_label>%FIRST_NAME% %LAST_NAME%</line_label>
<language>en_us</language>
<visual_voicemail>1</visual_voicemail>
<idle_image_id>1101</idle_image_id>
<missed_calls_notification>1</missed_calls_notification>
<brightness>5</brightness>
<contrast>5</contrast>
<backlight_timeout>5</backlight_timeout>
<ringer_volume>5</ringer_volume>
<speaker_volume>5</speaker_volume>
<handset_volume>5</handset_volume>
<headset_volume>5</headset_volume>
<reset_call_volume>0</reset_call_volume>
<headset_answer>0</headset_answer>
<electronic_hook_switch>regular</electronic_hook_switch>
<auto_answer_from_sb>1</auto_answer_from_sb>
<show_incoming_caller_profile>1</show_incoming_caller_profile>
<show_outgoing_caller_profile>1</show_outgoing_caller_profile>
<accept_local_calls>whitelist</accept_local_calls>
<whitelist_hosts>
<whitelist_host>192.168.1.1/24</whitelist_host>
<whitelist_host>10.10.2.1/24</whitelist_host>
</whitelist_hosts>
<local_sip_port>5060</local_sip_port>
<ringtone>ring1</ringtone>
<override_dial_plan>1</override_dial_plan>
<dial_plan>[0-8]xxx|911|9411|9611|9011xxx.T3|91xxxxxxxxxx|9[2-9]xxxxxx|*xx.T3|[0-8]xx.T3</dial_plan>
<skip_line_keys_for_blf>0</skip_line_keys_for_blf>
<codecs>
<codec>
<name>g722</name>
<packetization_period>20</packetization_period>
<minimum_holding_time>0</minimum_holding_time>
<maximum_holding_time>0</maximum_holding_time>
<target_holding_time>0</target_holding_time>
<enabled>0</enabled>
<priority>1</priority>
</codec>
<codec>
<name>g729</name>
<packetization_period>20</packetization_period>
<minimum_holding_time>0</minimum_holding_time>
<maximum_holding_time>0</maximum_holding_time>
<target_holding_time>0</target_holding_time>
<enabled>0</enabled>
<priority></priority>
</codec>
</codecs>
</digium_phone_settings>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.extensions.phones.sip.bulkUpdate">
<result>
<success />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p3_code=51304|p3_desc=Invalid first_name. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p4_code=888228|p4_desc=Invalid last_name. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p5_code=86165|p5_desc=Email address may only be 50 characters in length and must contain an @ sign.
|p6_code=50163|p6_desc=Invalid phone_password. Strong passwords are required on this system. You can change this on the Extension Settings page.
|p7_code=86168|p7_desc=Invalid phone_password. Value must be 3-20 characters in length.
|p8_code=86172|p8_desc=Invalid voicemail_password. Value must be 3-20 characters in length.
|p9_code=41952|p9_desc=Strong user account passwords are required on this system. You can change this on the Extension Settings page.
|p10_code=86167|p10_desc=You can only prepend digits for the Call API
|p11_code=86169|p11_desc=Invalid DTMF Mode (%1)
|p12_code=86170|p12_desc=Invalid Phone NAT Traversal (%1)
|p14_code=86179|p14_desc=Template id (%1) is not a valid id in the system.
|p15_code=37237|p15_desc=Invalid %1. Outgoing call rule must have a state and an id.
|p16_code=89997|p16_desc=Invalid %1. Outgoing call rule state must be allow or deny.
|p17_code=71900|p17_desc=Invalid %1. Outgoing call rule id does not exist.
|p18_code=66249|p18_desc=Extension group Id can only be digits
|p19_code=74243|p19_desc=Invalid %1. Extension group ID (%2) does not exist.
|p20_code=51304|p20_desc=Invalid %1. Value must be either a 1 or a 0.'
|p21_code=86178|p21_desc=Invalid extension (%1). Extension may only consist of digits and must be %2 digits in length.
|p22_code=86189|p22_desc=Invalid extension (%1). Extensions must start with a non-zero digit.
|p23_code=86190|p23_desc=Extensions %1 thru %2 are reserved for call parking.
|p27_code=91219|p27_desc=Invalid location. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p28_code=45279|p28_desc=Invalid title. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p29_code=62188|p29_desc=Invalid supported_codec. Value (%2) is not a valid sip codec choice.
|p30_code=10454|p30_desc=Invalid email_address. Email address can not contain a quote.
|p33_code=40320|p33_desc=Invalid (permissions). Value must be either a 1 or a 0.
}}

Switchvox.extensions.phones.remove

Dblood — Tue, 06 Mar 2012 00:20:39 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.extensions.phones.remove}} ==Description== Removes an existing extension from the system. {{XMLAPI_ARGUMENTS_60 |p1_name=account_id |p1_required=re...'

{{DISPLAYTITLE:switchvox.extensions.phones.remove}}
==Description==
Removes an existing extension from the system.

{{XMLAPI_ARGUMENTS_60
|p1_name=account_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=The account ID of the call parking extension.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.extensions.phones.remove">
<parameters>
<account_id>1808</account_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.extensions.phones.remove">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=10014|p1_desc=Invalid account_id (%1). Account_ids may only contain digits.
|p2_code=84711|p2_desc=That account_id is invalid.
}}

Switchvox.extensions.phones.analog.update

Dblood — Tue, 06 Mar 2012 00:18:53 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.extensions.phones.analog.update}} ==Description== Update an existing analog extension. {{XMLAPI_ARGUMENTS_60 |p1_name=account_id |p1_required=required...'

{{DISPLAYTITLE:switchvox.extensions.phones.analog.update}}
==Description==
Update an existing analog extension.

{{XMLAPI_ARGUMENTS_60
|p1_name=account_id
|p1_required=required
|p1_type=number
|p1_default=
|p1_desc=The account_id of the extension to update.
|p2_name=first_name
|p2_required=optional
|p2_type=string
|p2_default=
|p2_desc=First name.
|p3_name=voicemail_password
|p3_required=optional
|p3_type=string
|p3_default=
|p3_desc=Password to access voicemail and the web suite.
|p5_name=last_name
|p5_required=optional
|p5_type=string
|p5_default=
|p5_desc=Last name.
|p6_name=email_address
|p6_required=optional
|p6_type=string
|p6_default=
|p6_desc=Email address.
|p7_name=location
|p7_required=optional
|p7_type=string
|p7_default=
|p7_desc=The profile location for this account. For example, "San Diego Office".
|p8_name=title
|p8_required=optional
|p8_type=string
|p8_default=
|p8_desc=The profile title for this account. For example, "Software Developer".
|p9_name=lang_locale
|p9_required=optional
|p9_type=string
|p9_default=
|p9_desc=The language _ locale for this account. For example, en_us.
|p10_name=lightweight_mode
|p10_required=optional
|p10_type=boolean
|p10_default=0
|p10_desc=If set to 1, turns on lightweight mode for UI rendering
|p11_name=profile_image_id
|p11_required=optional
|p11_type=enum
|p11_default=
|p11_desc=Id of an image previously uploaded. Defaults to stock image. See: [[switchvox.images.add]]
|p12_name=voicemail_quota
|p12_required=optional
|p12_type=number
|p12_default=
|p12_desc=Voicemail mailbox quota in megabytes. Must be numeric.
|p13_name=prepend_for_outgoing
|p13_required=optional
|p13_type=number
|p13_default=
|p13_desc=Digits to prepend if number is not an extension. Must be numeric or blank.
|p14_name=prepend_one
|p14_required=optional
|p14_type=boolean
|p14_default=
|p14_desc=If set to '1', prepends a 1 if number is 10 digits in length. Set to '0' otherwise.
|p15_name=dtmfmode
|p15_required=optional
|p15_type=enum
|p15_default=
|p15_desc=DTMF mode. Valid values are: rfc2833, inband and info.

|p18_name=force_password_change
|p18_required=optional
|p18_type=boolean
|p18_default=
|p18_desc=Force the user to change their password on next login.
|p19_name=force_lang_change
|p19_required=optional
|p19_type=boolean
|p19_default=
|p19_desc=Force the user to change / confirm their language on next login.
|p20_name=sound_prompt_language_id
|p20_required=optional
|p20_type=number
|p20_default=
|p20_desc=Set the language the sound prompts will play in for the user.

|p22_name=outgoing_call_rules<div class="sub_name">outgoing_call_rule<div class="sub_name">id</div></div>
|p22_required=optional
|p22_type=number
|p22_default=
|p22_desc=The id of the outgoing call rule that the extension will have access to.
|p28_name=outgoing_call_rules<div class="sub_name">outgoing_call_rule<div class="sub_name">state</div></div>
|p28_required=optional
|p28_type=string
|p28_default=
|p28_desc=The state of the outgoing call rule for the extension. Possible value: allow/deny.
|p29_name=extension_groups<div class="sub_name">extension_group<div class="sub_name">id</div></div>
|p29_required=optional
|p29_type=enum
|p29_default=
|p29_desc=List of extension group IDs for this extension to join.
|p30_name=permissions<div class="sub_name">permission<div class="sub_name">id</div></div>
|p30_required=optional
|p30_type=enum
|p30_default=
|p30_desc=Id of the permission. Click [[Permissions IDs]]
|p31_name=permissions<div class="sub_name">permission<div class="sub_name">value</div></div>
|p31_required=optional
|p31_type=boolean
|p31_default=
|p31_desc=Allow (1) / deny (0) access to a given permissions / feature. If the permissions is not included it defaults to value from template.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.extensions.phones.analog.update">
<parameters>
<account_id>1110</account_id>
<channel_id>11</channel_id>
<first_name>John</first_name>
<voicemail_password>123654</voicemail_password>
<last_name>Smith</last_name>
<email_address>jsmith@example.com</email_address>
<location>San Jose</location>
<title>Software Engineer</title>
<lang_locale>en_us</lang_locale>
<lightweight_mode>0</lightweight_mode>
<profile_image_id></profile_image_id>
<voicemail_quota>10</voicemail_quota>
<prepend_for_outgoing>9</prepend_for_outgoing>
<prepend_one>0</prepend_one>
<force_password_change>1</force_password_change>
<force_lang_change>0</force_lang_change>
<sound_prompt_language_id>0</sound_prompt_language_id>
<outgoing_call_rules>
<outgoing_call_rule>
<id>1</id>
<state>allow</state>
</outgoing_call_rule>
</outgoing_call_rules>
<extension_groups>
<extension_group>
<id>1</id>
</extension_group>
</extension_groups>
<permissions>
<permission>
<id>change_first_name</id>
<value>1</value>
</permission>
</permissions>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.extensions.phones.analog.update">
<result>
<success />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=86161|p1_desc=Your phone system has not yet been registered and is limited to %1 extensions.
|p2_code=86162|p2_desc=You have exceeded the number of phone extensions available for your PBX. Please contact your reseller to purchase more extensions.
|p3_code=51304|p3_desc=Invalid first_name. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p4_code=888228|p4_desc=Invalid last_name. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p5_code=86165|p5_desc=Email address may only be 50 characters in length and must contain an @ sign.
|p6_code=50163|p6_desc=Invalid phone_password. Strong passwords are required on this system. You can change this on the Extension Settings page.
|p7_code=86168|p7_desc=Invalid phone_password. Value must be 3-20 characters in length.
|p8_code=86172|p8_desc=Invalid voicemail_password. Value must be 3-20 characters in length.
|p9_code=41952|p9_desc=Strong user account passwords are required on this system. You can change this on the Extension Settings page.
|p10_code=86167|p10_desc=You can only prepend digits for the Call API.
|p13_code=86173|p13_desc=Invalid template id (%1). Must be numeric.
|p14_code=86179|p14_desc=Template id (%1) is not a valid id in the system.
|p15_code=37237|p15_desc=Invalid %1. Outgoing call rule must have a state and an id.
|p16_code=89997|p16_desc=Invalid %1. Outgoing call rule state must be allow or deny.
|p17_code=71900|p17_desc=Invalid %1. Outgoing call rule id does not exist.
|p18_code=66249|p18_desc=Extension group Id can only be digits.
|p19_code=74243|p19_desc=Invalid %1. Extension group ID (%2) does not exist.
|p20_code=51304|p20_desc=Invalid %1. Value must be either a 1 or a 0.'
|p21_code=86178|p21_desc=Invalid extension (%1). Extension may only consist of digits and must be %2 digits in length.
|p22_code=86189|p22_desc=Invalid extension (%1). Extensions must start with a non-zero digit.
|p23_code=86190|p23_desc=Extensions %1 thru %2 are reserved for call parking.
|p24_code=86191|p24_desc=An extension with that number (%1) already exists.
|p25_code=86192|p25_desc=Your PBX is limited to the creation of %1 extensions. If you wish to expand the number of extensions please contact your PBX reseller.
|p26_code=86193|p26_desc=Your extension number (%1) conflicts (matches) with some of your Outgoing Call rules.
|p27_code=91219|p27_desc=Invalid location. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p28_code=45279|p28_desc=Invalid title. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p30_code=10454|p30_desc=Invalid email_address. Email address can not contain a quote.
|p31_code=59025|p31_desc=Invalid (profile_image_id). Value (%2) must be all digits.
|p32_code=13354|p32_desc=Invalid (profile_image_id). Your ID was not found in the system.
|p33_code=40320|p33_desc=Invalid (permissions). Value must be either a 1 or a 0.
}}

Switchvox.extensions.phones.analog.getInfo

Dblood — Tue, 06 Mar 2012 00:18:07 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.extensions.phones.analog.getInfo}} ==Description== Retrieve information on an existing analog phone extension from the system. {{XMLAPI_ARGUMENTS_60 ...'

{{DISPLAYTITLE:switchvox.extensions.phones.analog.getInfo}}
==Description==
Retrieve information on an existing analog phone extension from the system.

{{XMLAPI_ARGUMENTS_60
|p1_name=account_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=The account ID of the extension to get info for.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.extensions.phones.analog.getInfo">
<parameters>
<account_id>1807</account_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.extensions.phones.analog.getInfo">
<result>
<extension server_uuid="4428492265501239296" number="110" account_id="1807" channel_id="11" first_name="Joe" last_name="Smith" email_address="jsmith@example.com" title="Software Engineer" template_id="1" type="analog" profile_image_id="0" location="San Jose" prepend_for_outgoing="9" prepend_one="1" lang_locale="en_us" force_password_change="1" force_lang_change="0" sound_prompt_language_id="0" lightweight_mode="0" voicemail_quota="" pbx_managed_phone="0" line_label="" hide_missed_calls="0" sb_auto_answer="0" no_profile_popup_in="0" no_profile_popup_out="1" line2_active="0" line3_active="0" line_keys_per_num="1" secondary_line="0">
<permissions>
<permission id="change_first_name" value="1" />
<permission id="change_last_name" value="1" />
<permission id="change_email_address" value="1" />
<permission id="change_language" value="1" />
<permission id="change_password" value="1" />
<permission id="change_location" value="1" />
<permission id="change_title" value="1" />
<permission id="change_picture" value="1" />
<permission id="change_sound_prompt_language" value="1" />
<permission id="use_call_block" value="1" />
<permission id="use_call_forward" value="1" />
<permission id="use_call_cascade" value="1" />
<permission id="use_secret_code" value="1" />
<permission id="use_ring_all" value="1" />
<permission id="can_create_decline" value="1" />
<permission id="use_voicemail" value="1" />
<permission id="receive_voicemail_attachments" value="1" />
<permission id="use_voicemail_forwarding" value="1" />
<permission id="use_voicemail_notifications" value="1" />
<permission id="use_web_suite" value="1" />
<permission id="use_mobile_apps" value="1" />
<permission id="use_sip_phone_apps" value="1" />
<permission id="use_switchboard" value="1" />
<permission id="use_chat" value="1" />
<permission id="unpark_calls" value="1" />
<permission id="record_calls" value="1" />
<permission id="use_ringtones" value="1" />
<permission id="upload_ringtones" value="1" />
<permission id="use_icm" value="1" />
<permission id="can_converge_phones" value="1" />
<permission id="change_lightweight_mode" value="1" />
<permission id="digium_use_queues_app" value="1" />
<permission id="digium_use_parking_lot_app" value="1" />
<permission id="digium_use_phonebooks_app" value="1" />
<permission id="digium_use_system_directory" value="1" />
<permission id="digium_use_visual_voicemail" value="1" />
<permission id="digium_use_presence" value="" />
<permission id="digium_can_forward_calls" value="1" />
<permission id="digium_change_line_label" value="1" />
<permission id="digium_change_language" value="1" />
<permission id="digium_change_idle_screen" value="1" />
<permission id="digium_change_mc_notification" value="1" />
<permission id="digium_change_msgs_button" value="1" />
<permission id="digium_change_display_settings" value="1" />
<permission id="digium_change_sounds_settings" value="1" />
<permission id="digium_change_caller_profiles" value="1" />
<permission id="digium_change_auto_answer" value="1" />
<permission id="digium_send_to_voicemail" value="1" />
<permission id="digium_can_ignore_call" value="1" />
</permissions>
<outgoing_call_rules>
<outgoing_call_rule id="4" state="allow" />
<outgoing_call_rule id="2" state="deny" />
<outgoing_call_rule id="3" state="allow" />
<outgoing_call_rule id="5" state="allow" />
<outgoing_call_rule id="6" state="allow" />
<outgoing_call_rule id="1" state="allow" />
<outgoing_call_rule id="100" state="allow" />
</outgoing_call_rules>
<extension_groups>
<extension_group id="1" name="Default Group" public="1" />
<extension_group id="1001" name="All Extensions" public="1" />
</extension_groups>
</extension>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=10014|p1_desc=Invalid account_id (%1). Account_ids may only contain digits.
|p2_code=84711|p2_desc=That account_id is invalid.
}}

Switchvox.extensions.phones.analog.add

Dblood — Tue, 06 Mar 2012 00:16:53 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.extensions.phones.analog.add}} ==Description== Adds a new analog extension to the system and returns the account ID. If values are not passed in for para...'

{{DISPLAYTITLE:switchvox.extensions.phones.analog.add}}
==Description==
Adds a new analog extension to the system and returns the account ID. If values are not passed in for parameters then the default value comes from the phone template you designate via the template_id variable.

{{XMLAPI_ARGUMENTS_60
|p1_name=extension
|p1_required=required
|p1_type=number
|p1_default=
|p1_desc=The extension number. Must be numeric and cannot start with zero.
|p2_name=first_name
|p2_required=required
|p2_type=string
|p2_default=
|p2_desc=First name.
|p3_name=voicemail_password
|p3_required=required
|p3_type=string
|p3_default=
|p3_desc=Password to access voicemail and the web suite.
|p4_name=template_id
|p4_required=required
|p4_type=number
|p4_default=
|p4_desc=Template ID to create extension from. Any missing parameters will default to values from this template.
|p5_name=last_name
|p5_required=optional
|p5_type=string
|p5_default=
|p5_desc=Last name.
|p6_name=email_address
|p6_required=optional
|p6_type=string
|p6_default=
|p6_desc=Email address.
|p7_name=location
|p7_required=optional
|p7_type=string
|p7_default=
|p7_desc=The profile location for this account. For example, "San Diego Office".
|p8_name=title
|p8_required=optional
|p8_type=string
|p8_default=
|p8_desc=The profile title for this account. For example, "Software Developer".
|p9_name=lang_locale
|p9_required=optional
|p9_type=string
|p9_default=
|p9_desc=The language _ locale for this account. For example, en_us.
|p10_name=lightweight_mode
|p10_required=optional
|p10_type=boolean
|p10_default=0
|p10_desc=If set to 1, turns on lightweight mode for UI rendering
|p11_name=profile_image_id
|p11_required=optional
|p11_type=enum
|p11_default=
|p11_desc=Id of an image previously uploaded. Defaults to stock image. See: [[switchvox.images.add]]
|p12_name=voicemail_quota
|p12_required=optional
|p12_type=number
|p12_default=
|p12_desc=Voicemail mailbox quota in megabytes. Must be numeric.
|p13_name=prepend_for_outgoing
|p13_required=optional
|p13_type=number
|p13_default=
|p13_desc=Digits to prepend if number is not an extension. Must be numeric or blank.
|p14_name=prepend_one
|p14_required=optional
|p14_type=boolean
|p14_default=
|p14_desc=If set to '1', prepends a 1 if number is 10 digits in length. Set to '0' otherwise.
|p15_name=dtmfmode
|p15_required=optional
|p15_type=enum
|p15_default=
|p15_desc=DTMF mode. Valid values are: rfc2833, inband and info.

|p18_name=force_password_change
|p18_required=optional
|p18_type=boolean
|p18_default=
|p18_desc=Force the user to change their password on next login.
|p19_name=force_lang_change
|p19_required=optional
|p19_type=boolean
|p19_default=
|p19_desc=Force the user to change / confirm their language on next login.
|p20_name=sound_prompt_language_id
|p20_required=optional
|p20_type=number
|p20_default=
|p20_desc=Set the language the sound prompts will play in for the user.

|p22_name=outgoing_call_rules<div class="sub_name">outgoing_call_rule<div class="sub_name">id</div></div>
|p22_required=optional
|p22_type=number
|p22_default=
|p22_desc=The id of the outgoing call rule that the extension will have access to.
|p28_name=outgoing_call_rules<div class="sub_name">outgoing_call_rule<div class="sub_name">state</div></div>
|p28_required=optional
|p28_type=string
|p28_default=
|p28_desc=The state of the outgoing call rule for the extension. Possible value: allow/deny.
|p29_name=extension_groups<div class="sub_name">extension_group<div class="sub_name">id</div></div>
|p29_required=optional
|p29_type=enum
|p29_default=
|p29_desc=List of extension group IDs for this extension to join.
|p30_name=permissions<div class="sub_name">permission<div class="sub_name">id</div></div>
|p30_required=optional
|p30_type=enum
|p30_default=
|p30_desc=Id of the permission. Click [[Permissions IDs]]
|p31_name=permissions<div class="sub_name">permission<div class="sub_name">value</div></div>
|p31_required=optional
|p31_type=boolean
|p31_default=
|p31_desc=Allow (1) / deny (0) access to a given permissions / feature. If the permissions is not included it defaults to value from template.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.extensions.phones.analog.add">
<parameters>
<extension>110</extension>
<channel_id>11</channel_id>
<template_id>1</template_id>
<first_name>John</first_name>
<voicemail_password>123654</voicemail_password>
<last_name>Smith</last_name>
<email_address>jsmith@example.com</email_address>
<location>San Jose</location>
<title>Software Engineer</title>
<lang_locale>en_us</lang_locale>
<lightweight_mode>0</lightweight_mode>
<profile_image_id></profile_image_id>
<voicemail_quota>10</voicemail_quota>
<prepend_for_outgoing>9</prepend_for_outgoing>
<prepend_one>0</prepend_one>
<force_password_change>1</force_password_change>
<force_lang_change>0</force_lang_change>
<sound_prompt_language_id>0</sound_prompt_language_id>
<outgoing_call_rules>
<outgoing_call_rule>
<id>1</id>
<state>allow</state>
</outgoing_call_rule>
</outgoing_call_rules>
<extension_groups>
<extension_group>
<id>1</id>
</extension_group>
</extension_groups>
<permissions>
<permission>
<id>change_first_name</id>
<value>1</value>
</permission>
</permissions>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.extensions.phones.analog.add">
<result>
<account id="1808" />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=86161|p1_desc=Your phone system has not yet been registered and is limited to %1 extensions.
|p2_code=86162|p2_desc=You have exceeded the number of phone extensions available for your PBX. Please contact your reseller to purchase more extensions.
|p3_code=51304|p3_desc=Invalid first_name. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p4_code=888228|p4_desc=Invalid last_name. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p5_code=86165|p5_desc=Email address may only be 50 characters in length and must contain an @ sign.
|p6_code=50163|p6_desc=Invalid phone_password. Strong passwords are required on this system. You can change this on the Extension Settings page.
|p7_code=86168|p7_desc=Invalid phone_password. Value must be 3-20 characters in length.
|p8_code=86172|p8_desc=Invalid voicemail_password. Value must be 3-20 characters in length.
|p9_code=41952|p9_desc=Strong user account passwords are required on this system. You can change this on the Extension Settings page.
|p10_code=86167|p10_desc=You can only prepend digits for the Call API.
|p13_code=86173|p13_desc=Invalid template id (%1). Must be numeric.
|p14_code=86179|p14_desc=Template id (%1) is not a valid id in the system.
|p15_code=37237|p15_desc=Invalid %1. Outgoing call rule must have a state and an id.
|p16_code=89997|p16_desc=Invalid %1. Outgoing call rule state must be allow or deny.
|p17_code=71900|p17_desc=Invalid %1. Outgoing call rule id does not exist.
|p18_code=66249|p18_desc=Extension group Id can only be digits.
|p19_code=74243|p19_desc=Invalid %1. Extension group ID (%2) does not exist.
|p20_code=51304|p20_desc=Invalid %1. Value must be either a 1 or a 0.'
|p21_code=86178|p21_desc=Invalid extension (%1). Extension may only consist of digits and must be %2 digits in length.
|p22_code=86189|p22_desc=Invalid extension (%1). Extensions must start with a non-zero digit.
|p23_code=86190|p23_desc=Extensions %1 thru %2 are reserved for call parking.
|p24_code=86191|p24_desc=An extension with that number (%1) already exists.
|p25_code=86192|p25_desc=Your PBX is limited to the creation of %1 extensions. If you wish to expand the number of extensions please contact your PBX reseller.
|p26_code=86193|p26_desc=Your extension number (%1) conflicts (matches) with some of your Outgoing Call rules.
|p27_code=91219|p27_desc=Invalid location. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p28_code=45279|p28_desc=Invalid title. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:&\'.:-_
|p30_code=10454|p30_desc=Invalid email_address. Email address can not contain a quote.
|p31_code=59025|p31_desc=Invalid (profile_image_id). Value (%2) must be all digits.
|p32_code=13354|p32_desc=Invalid (profile_image_id). Your ID was not found in the system.
|p33_code=40320|p33_desc=Invalid (permissions). Value must be either a 1 or a 0.
}}

Switchvox.extensions.featureCodes.directedPickup.update

Dblood — Tue, 06 Mar 2012 00:16:03 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.extensions.featureCodes.directedPickup.update}} ==Description== Create a Directed Pickup Feature Code. {{XMLAPI_ARGUMENTS_20 |p1_name=account_...'

{{DISPLAYTITLE:switchvox.extensions.featureCodes.directedPickup.update}}
==Description==

Create a Directed Pickup Feature Code.

{{XMLAPI_ARGUMENTS_20

|p1_name=account_id
|p1_required=required
|p1_type=integer
|p1_default=
|p1_desc=The account ID of the feature code to update

|p2_name=groups
|p2_required=
|p2_type=array
|p2_default=
|p2_desc=A list of groups, each of whch has two sub groups: authorized and targeted. The accounts in the authorized sub group can pick up calls intended for accounts int he targeted sub group.
|p8_name=authorized<div class='sub_name'>members<div class="sub_name">member<div class="sub_name">id</div></div></div>
|p8_required=
|p8_type=integer
|p8_default=
|p8_desc=The ids of the member you want in the authorized group.

|p9_name=authorized<div class='sub_name'>members<div class="sub_name">member<div class="sub_name">type</div></div></div>
|p9_required=
|p9_type=string
|p9_default=
|p9_desc=The type of the member you are adding. The value of this parameter must be one of the following:
*account
*extension_group

|p10_name=targeted<div class='sub_name'>members<div class="sub_name">member<div class="sub_name">id</div></div></div>
|p10_required=
|p10_type=integer
|p10_default=
|p10_desc=The ids of the member you want in the authorized group.

|p11_name=targeted<div class='sub_name'>members<div class="sub_name">member<div class="sub_name">type</div></div></div>
|p11_required=
|p11_type=string
|p11_default=
|p11_desc=The type of the member you are adding. The value of this parameter must be one of the following:
*account
*extension_group

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang='xml'>
<request method="switchvox.extensions.featureCodes.directedPickup.update">
<parameters>
<account_id>1151</account_id>
<groups>
<group>
<authorized>
<members>
<member>
<type>account</type>
<id>1102</id>
</member>
<member>
<type>account</type>
<id>1101</id>
</member>
</members>
</authorized>
<targeted>
<members>
<member>
<type>extension_group</type>
<id>1019</id>
</member>
</members>
</targeted>
</group>
</groups>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang='xml'>
<response method="switchvox.extensions.featureCodes.directedPickup.update">
<result>
<success />
</result>
</response>

</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES

}}

Switchvox.extensions.featureCodes.callMonitoring.update

Dblood — Tue, 06 Mar 2012 00:15:04 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.extensions.featureCodes.callMonitoring.update}} ==Description== Create a Call Monitoring Feature Code. {{XMLAPI_ARGUMENTS_20 |p1_name=account_i...'

{{DISPLAYTITLE:switchvox.extensions.featureCodes.callMonitoring.update}}
==Description==

Create a Call Monitoring Feature Code.

{{XMLAPI_ARGUMENTS_20
|p1_name=account_id
|p1_required=required
|p1_type=integer
|p1_default=
|p1_desc=The account ID of the feature code to update

|p7_name=groups
|p7_required=
|p7_type=array
|p7_default=
|p7_desc=A list of groups, each of whch has two sub groups: authorized and targeted. The accounts in the authorized sub group can monitor the calls of accounts in the targeted sub group.

|p8_name=authorized<div class='sub_name'>members<div class="sub_name">member<div class="sub_name">id</div></div></div>
|p8_required=required
|p8_type=integer
|p8_default=
|p8_desc=The ids of the member you want in the authorized group.

|p9_name=authorized<div class='sub_name'>members<div class="sub_name">member<div class="sub_name">type</div></div></div>
|p9_required=required
|p9_type=string
|p9_default=
|p9_desc=The type of the member you are adding. The value of this parameter must be one of the following:
*account
*extension_group

|p10_name=targeted<div class='sub_name'>members<div class="sub_name">member<div class="sub_name">id</div></div></div>
|p10_required=required
|p10_type=integer
|p10_default=
|p10_desc=The ids of the member you want in the authorized group.

|p11_name=targeted<div class='sub_name'>members<div class="sub_name">member<div class="sub_name">type</div></div></div>
|p11_required=required
|p11_type=string
|p11_default=
|p11_desc=The type of the member you are adding. The value of this parameter must be one of the following:
*account
*extension_group

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang='xml'>
<request method="switchvox.extensions.featureCodes.callMonitoring.update">
<parameters>
<account_id>1151</account_id>
<groups>
<group>
<authorized>
<members>
<member>
<type>account</type>
<id>1102</id>
</member>
<member>
<type>account</type>
<id>1101</id>
</member>
</members>
</authorized>
<targeted>
<members>
<member>
<type>extension_group</type>
<id>1019</id>
</member>
</members>
</targeted>
</group>
</groups>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang='xml'>
<response method="switchvox.extensions.featureCodes.callMonitoring.update">
<result>
<success />
</result>
</response>

</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES

}}

Switchvox.directories.update

Dblood — Tue, 06 Mar 2012 00:11:53 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.directories.update}} ==Description== Updates a directory to the system and returns the id of the newly created directory. {{XMLAPI_ARGUMENTS |p1_name=n...'

{{DISPLAYTITLE:switchvox.directories.update}}
==Description==
Updates a directory to the system and returns the id of the newly created directory.

{{XMLAPI_ARGUMENTS
|p1_name=name
|p1_required=
|p1_type=string
|p1_default=
|p1_desc=Name of the directoriy

|p2_name=member_extension_group_ids
|p2_required=
|p2_type=array of integers
|p2_default=
|p2_desc=Array of public extension_group_ids that will comprise the body of the group.

|p3_name=description
|p3_required=
|p3_type=string
|p3_default=
|p3_desc=Describe the directory
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.directories.update">
<parameters>
<name>Sales Directory</name>
<member_extension_group_ids>
<member_extension_group_id>1202</member_extension_group_id>
<member_extension_group_id>1049</member_extension_group_id>
</member_extension_group_ids>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.directories.update">
<result>
<successs />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

Switchvox.directories.getInfo

Dblood — Tue, 06 Mar 2012 00:10:59 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.directories.getInfo}} ==Description== Get info about a system directory. Returns simple information use Switchvox.directories.getExtensionList to get...'

{{DISPLAYTITLE:switchvox.directories.getInfo}}
==Description==
Get info about a system directory. Returns simple information use [[Switchvox.directories.getExtensionList]] to get the data about phones and extensions in the directory.

{{XMLAPI_ARGUMENTS
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=Gets info about system directory}}
<source lang="xml">
<request method="switchvox.directories.getInfo">
<parameters>
</parameters>
</request>

</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=Returned information about directory 1 (default directory)}}
<source lang="xml">
<response method="switchvox.directories.getInfo">
<result>
<directory id="1" name="Default Directory" description ="asdfasdf" server_uuid="10010002108">
<member_groups>
<member_group id="1170" name="Squiggles FTW" server_uuid="10010002108" />
</member_groups>
</directory>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES

}}

Switchvox.directories.getExtensionList

Dblood — Tue, 06 Mar 2012 00:10:06 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.directories.getExtensionList}} ==Description== Returns all the extensions associated with the groups that are added to a system directory. {{XMLAPI_ARG...'

{{DISPLAYTITLE:switchvox.directories.getExtensionList}}
==Description==
Returns all the extensions associated with the groups that are added to a system directory.

{{XMLAPI_ARGUMENTS
|p1_name=sort_field
|p1_required=optional
|p1_type=string
|p1_default=number
|p1_desc=The field on which to sort the returned extensions.‭ ‬Possible values:‭ number,‭ ‬display, account_id,‭ ‬extension_type‭ ‬and date_created.
|p2_name=sort_order
|p2_required=optional
|p2_type=string
|p2_default=ASC
|p2_desc=The order in which to sort returned extensions. Possible values: ASC and DESC.
|p3_name=items_per_page
|p3_required=optional
|p3_type=integer
|p3_default=50
|p3_desc=Number of extensions to return per page.
|p4_name=page_number
|p4_required=optional
|p4_type=integer
|p4_default=1
|p4_desc= The page number of extensions to return.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
{{XMLAPI_EXAMPLE_REQUEST_HEADER|example_description=Requests a list of all the SIP,Analog,and Virtual extensions on the system.}}
<source lang="xml">
<request method="switchvox.directories.getExtensionList">
<parameters>
<sort_field>number</sort_field>
<sort_order>ASC</sort_order>
<items_per_page>50</items_per_page>
<page_number>1</page_number>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER|example_description=returns a flattened array of all the extensions contained within the groups that are in the directory. Results returned are formatted the same way as the switchvox_extensions_search api">
<response method="switchvox.directories.getExtensionList}}
<source lang="xml">
<result>
<directory id="1" name="Default Directory" description ="asdfasdf" server_uuid="10010002108">
<extensions page_number="1" total_pages="1" items_per_page="50" total_items="4">
<extension server_uuid="10010002108" number="101" status="1" account_id="1101" display="Ryan Ravioli" date_created="2011-01-13 17:43:08" type="sip" type_display="SIP Extension" first_name="Ryan" last_name="Ravioli" email_address="ryan.navaroli@gmail.com" template_id="1" template_name="" phone_password_score="104" voicemail_password_score="80" lang_locale="en_us" title="Yeeehaw Stuff" location="East Texas" profile_image_id="11" profile_image_link="https://centos5-5-ryan/dl?cmd=profile_image&amp;cs=1&amp;id=11&amp;hash=8146ef6bcab97ae40ef003fded9e7672" />
<extension server_uuid="10010002108" number="102" status="1" account_id="1102" display="a Koopa()+#+@.,'"&amp;" date_created="2011-01-14 11:42:45" type="sip" type_display="SIP Extension" first_name="a" last_name="Koopa()+#+@.,'"&amp;" email_address="rnavaroli@switchvox.com" template_id="1" template_name="" phone_password_score="104" voicemail_password_score="-99" lang_locale="en_us" title="()+#+@.,'"&" location="()+#+@.,'"&" profile_image_id="15" profile_image_link="https://centos5-5-ryan/dl?cmd=profile_image&amp;cs=1&amp;id=15&amp;hash=518d3dffd929ce436dc2a93d39fcfccb" />
<extension server_uuid="10010002108" number="103" status="1" account_id="1103" display="Vladimir2 The Grandest Pumba Flonkerton2 Of the sea came by w" date_created="2011-01-14 12:01:29" type="sip" type_display="SIP Extension" first_name="Vladimir2 The Grandest Pumba " last_name="Flonkerton2 Of the sea came by w" email_address="2@2.com" template_id="1" template_name="" phone_password_score="104" voicemail_password_score="80" lang_locale="en_us" title="mr 2" location="2diego" profile_image_id="0" profile_image_link="https://centos5-5-ryan/dl?cmd=profile_image&amp;cs=0&amp;id=0&amp;hash=de6de8233830fdc935aae4ffe7003a85" />
<extension server_uuid="10010002108" number="401" status="1" account_id="1106" display="Droids" date_created="2011-03-03 15:31:09" type="call_queue" type_display="Call Queue" call_queue_name="Droids" strategy="Ring All" member_count="6" />
</extensions>
</directory>
</result>
</response>

</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

Switchvox.directories.add

Dblood — Tue, 06 Mar 2012 00:09:10 GMT

Dblood: Blanked the page

Switchvox.digiumPhones.assignments.update

Dblood — Mon, 05 Mar 2012 23:52:23 GMT

Dblood:

{{DISPLAYTITLE:switchvox.digiumPhones.assignments.update}}
==Description==
Update details about a phone assignment, including the ability to add line information.

{{XMLAPI_ARGUMENTS
|p1_name=account_id
|p1_required=
|p1_type=integer
|p1_desc=The account_id this assignment should belong to

|p2_name=model
|p2_required=
|p2_type=string
|p2_desc=The model of the phone

|p3_name=lines<div class="sub_name">lines<div class="sub_name">line_key</div></div>
|p3_required=required
|p3_type=integer
|p3_default=
|p3_desc=The line key you want this line mapped to on your phone.

|p4_name=lines<div class="sub_name">lines<div class="sub_name">type</div></div>
|p4_required=required
|p4_type=string
|p4_default=
|p4_desc=Must be either 'external' if you want to register to an external server or 'internal' if you want to register to an extension on this system.

|p5_name=lines<div class="sub_name">lines<div class="sub_name">account_id</div></div>
|p5_required=
|p5_type=integer
|p5_default=
|p5_desc=If type is 'internal' you need to specify the account_id you want this phone to be.

|p6_name=lines<div class="sub_name">lines<div class="sub_name">host</div></div>
|p6_required=
|p6_type=string
|p6_default=
|p6_desc=External host to connect to.

|p7_name=lines<div class="sub_name">lines<div class="sub_name">alternate_host</div></div>
|p7_required=
|p7_type=string
|p7_default=
|p7_desc=Alternate external host to connect to.

|p8_name=lines<div class="sub_name">lines<div class="sub_name">port</div></div>
|p8_required=
|p8_type=integer
|p8_default=
|p8_desc=External port to connect to.

|p9_name=lines<div class="sub_name">lines<div class="sub_name">user_id</div></div>
|p9_required=
|p9_type=string
|p9_default=
|p9_desc=External username to use.

|p10_name=lines<div class="sub_name">lines<div class="sub_name">password</div></div>
|p10_required=
|p10_type=string
|p10_default=
|p10_desc=External password to use.

|p11_name=lines<div class="sub_name">lines<div class="sub_name">line_label</div></div>
|p11_required=required
|p11_type=string
|p11_default=
|p11_desc=The label for the line one to thirty two characters in length.

|p12_name=lines<div class="sub_name">lines<div class="sub_name">register</div></div>
|p12_required=required
|p12_type=integer
|p12_default=0
|p12_desc=If the phone should register to this host.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.assignments.update">
<parameters>
<assignment_id>26</assignment_id>
<account_id>1134</account_id>
<lines>
<line>
<line_key>2</line_key>
<type>internal</type>
<account_id>1101</account_id>
<host></host>
<line_label>Bob's Phone</line_label>
</line>
<line>
<line_key>3</line_key>
<type>external</type>
<host>10.10.10.1</host>
<alternate_host>10.10.10.2</alternate_host>
<port>5060</port>
<user_id>bob</user_id>
<password>topsekret</password>
<line_label>Jill's Phone</line_label>
<register>1</register>
</line>
</lines>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.assignments.update">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=50554|p1_desc=A phone assignment id can only consist of numbers.
|p2_code=22835|p2_desc=No phone assignment was found with that id.
|p3_code=50554|p3_desc=A phone assignment id can only consist of numbers.
|p4_code=22835|p4_desc=No phone assignment was found with that id.
|p5_code=44229|p5_desc=Invalid phone model.
|p6_code=43051|p6_desc=Invalid host (%1).
|p7_code=51319|p7_desc=Password must be a string of letters, numbers, or underscores 3 to 64 characters in length.
|p8_code=54375|p8_desc=User id must be a string of letters, numbers, or underscores 3 to 64 characters in length.
|p9_code=36967|p9_desc=Invalid port parameter (%1).
|p10_code=68398|p10_desc=Duplicate line key numbers are not allowed.
|p11_code=34606|p11_desc=The line key 1 is reserved for the phones main extension.
}}

Switchvox.digiumPhones.assignments.remove

Dblood — Mon, 05 Mar 2012 23:51:19 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.assignments.remove}} ==Description== {{XMLAPI_ARGUMENTS |p1_name=assignment_id |p1_required=required |p1_type=integer |p1_desc=The ID ...'

{{DISPLAYTITLE:switchvox.digiumPhones.assignments.remove}}
==Description==

{{XMLAPI_ARGUMENTS
|p1_name=assignment_id
|p1_required=required
|p1_type=integer
|p1_desc=The ID of an assignment you want additional information on.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.assignments.remove">
<parameters>
<assignment_id>26</assignment_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.assignments.remove">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=50554|p1_desc=A phone assignment id can only consist of numbers.
|p2_code=22835|p2_desc=No phone assignment was found with that id.
}}

Switchvox.digiumPhones.assignments.options.update

Dblood — Mon, 05 Mar 2012 23:48:38 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.assignments.options.update}} ==Description== Update the Digium phone assignment options. A new system starts out with defaults that should...'

{{DISPLAYTITLE:switchvox.digiumPhones.assignments.options.update}}
==Description==

Update the Digium phone assignment options. A new system starts out with defaults that should be fine, but you can change them with this method.

{{XMLAPI_ARGUMENTS_20
|p1_name=setup_code
|p1_required=0
|p1_type=integer
|p1_default=
|p1_desc=3 - 9 digits (default 5). This is the pass code to enter on the phone to allow setup

|p2_name=setup_code_bypass_end_time
|p2_required=0
|p2_type=ISO 8601 Date
|p2_default=
|p2_desc=You can bypass the requirement for a setup_code, for example, if you are setting up a lot of phones all at once. This is when the bypass expires, and a setup_code is again required.

|p3_name=server_name
|p3_required=0
|p3_type=string
|p3_default=
|p3_desc=The display name of the PBX

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang='xml'>
<request method="switchvox.digiumPhones.assignments.options.update">
<parameters>
<server_name>Awesome Server One</server_name>
<setup_code>12345</setup_code>
<setup_code_bypass_end_time>2011-08-04 12:00:00</setup_code_bypass_end_time>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang='xml'>
<response method="switchvox.digiumPhones.assignments.options.update">
<result>
<success />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES

}}

Switchvox.digiumPhones.assignments.options.getInfo

Dblood — Mon, 05 Mar 2012 23:47:40 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.assignments.options.getInfo}} ==Description== Get the setup options {{XMLAPI_ARGUMENTS }} {{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE...'

{{DISPLAYTITLE:switchvox.digiumPhones.assignments.options.getInfo}}
==Description==

Get the setup options

{{XMLAPI_ARGUMENTS

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang='xml'>
<request method="switchvox.digiumPhones.assignments.options.getInfo">
<parameters>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang='xml'>
<response method="switchvox.digiumPhones.assignments.options.getInfo">
<result>
<options server_name="Switchvox" setup_code="56789" setup_code_bypass_end_time="2011-08-03 12:00:00" />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES

}}

Switchvox.digiumPhones.assignments.ignore.remove

Dblood — Mon, 05 Mar 2012 23:46:56 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.assignments.ignore.remove}} ==Description== Add a phone assignment to your system. {{XMLAPI_ARGUMENTS |p1_name=account_id |p1_required= ...'

{{DISPLAYTITLE:switchvox.digiumPhones.assignments.ignore.remove}}
==Description==
Add a phone assignment to your system.

{{XMLAPI_ARGUMENTS
|p1_name=account_id
|p1_required=
|p1_type=integer
|p1_desc=The account id that you want to un-ignore.

|p2_name=assignment_id
|p2_required=
|p2_type=integer
|p2_desc=The assignment id you want to un-ignore.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.assignments.ignore.remove">
<parameters>
<assignment_id>25</assignment_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.assignments.ignore.remove">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=10014|p1_desc=Invalid account_id (%1). Account_ids may only contain digits.
|p2_code=84711|p2_desc=That account_id is invalid.
|p3_code=50554|p3_desc=A phone assignment id can only consist of numbers.
|p4_code=22835|p4_desc=No phone assignment was found with that id.
}}

Switchvox.digiumPhones.assignments.ignore.add

Dblood — Mon, 05 Mar 2012 23:46:04 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.assignments.ignore.add}} ==Description== Add a phone assignment to your system. {{XMLAPI_ARGUMENTS |p1_name=account_id |p1_required= |p1...'

{{DISPLAYTITLE:switchvox.digiumPhones.assignments.ignore.add}}
==Description==
Add a phone assignment to your system.

{{XMLAPI_ARGUMENTS
|p1_name=account_id
|p1_required=
|p1_type=integer
|p1_desc=The account id that you want to ignore.

|p2_name=assignment_id
|p2_required=
|p2_type=integer
|p2_desc=The assignment id you want to ignore.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.assignments.ignore.add">
<parameters>
<assignment_id>25</assignment_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.assignments.ignore.add">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=10014|p1_desc=Invalid account_id (%1). Account_ids may only contain digits.
|p2_code=84711|p2_desc=That account_id is invalid.
|p3_code=50554|p3_desc=A phone assignment id can only consist of numbers.
|p4_code=22835|p4_desc=No phone assignment was found with that id.
}}

Switchvox.digiumPhones.assignments.getList

Dblood — Mon, 05 Mar 2012 23:45:01 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.assignments.getList}} ==Description== Get a list of phone assignments the system knows about. {{XMLAPI_ARGUMENTS |p1_name=filter |p1_requ...'

{{DISPLAYTITLE:switchvox.digiumPhones.assignments.getList}}
==Description==
Get a list of phone assignments the system knows about.

{{XMLAPI_ARGUMENTS
|p1_name=filter
|p1_required=required
|p1_type=string
|p1_desc=Specify the assignments you want a list of. Must be one of type:
*assigned
*ignored
*unassigned_extensions
*unassigned_phones
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.assignments.getList">
<parameters>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.assignments.getList">
<result>
<assignments>
<assignment assignment_id="25" type="assigned" mac="abcdef123456" ip="10.10.10.2" model="s9000" />
<assignment assignment_id="26" type="assigned" mac="2387293827ac" ip="10.10.10.3" model="s5000" extension="882" />
</assignments>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
}}

Switchvox.digiumPhones.assignments.getInfo

Dblood — Mon, 05 Mar 2012 23:43:59 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.assignments.getInfo}} ==Description== Get information about a specific assignment. {{XMLAPI_ARGUMENTS |p1_name=assignment_id |p1_required...'

{{DISPLAYTITLE:switchvox.digiumPhones.assignments.getInfo}}
==Description==
Get information about a specific assignment.

{{XMLAPI_ARGUMENTS
|p1_name=assignment_id
|p1_required=required
|p1_type=integer
|p1_desc=The ID of an assignment you want additional information on.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.assignments.getInfo">
<parameters>
<assignment_id>26</assignment_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.assignments.getInfo">
<result>
<assignment id="26" mac="2387293827ac" ip="10.10.10.3" model="s5000" >
<lines>
<line type="internal" port="5060" account_id="1101" line_key="2" line_label="Tom" />
<line password="topsekret" user_id="bob" type="external" port="5060" host="10.10.10.1" line_key="3" line_label="San Diego" register="0" />
</lines>
</assignment>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=50554|p1_desc=A phone assignment id can only consist of numbers.
|p2_code=22835|p2_desc=No phone assignment was found with that id.
}}

Switchvox.digiumPhones.assignments.checkConflicts

Dblood — Mon, 05 Mar 2012 23:43:08 GMT

Dblood: Created page with '{{DISPLAYTITLE:Switchvox.digiumPhones.assignments.checkConflicts}} ==Description== Check if an account_id is already assigned to a phone {{XMLAPI_ARGUMENTS |p1_name=account_ids...'

{{DISPLAYTITLE:Switchvox.digiumPhones.assignments.checkConflicts}}
==Description==
Check if an account_id is already assigned to a phone

{{XMLAPI_ARGUMENTS
|p1_name=account_ids<br/><span class="sub_name">account_id</span>
|p1_required=
|p1_type=arrary
|p1_default=
|p1_desc=A list of account_ids to check

|p2_name=mac_addresses<br/><span class="sub_name">mac_address</span>
|p2_required=
|p2_type=arrary
|p2_default=
|p2_desc=A list of mac_addresses to check
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER|}}
<source lang="xml">
<request method="switchvox.digiumPhones.assignments.checkConflicts">
<parameters>
<account_ids>
<account_id>1106</account_id>
</account_ids>
<mac_addresses>
<mac_address>aabbcc112233</mac_address>
</mac_addresses>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.assignments.checkConflicts">
<result>
<conflicts>
<conflict account_id="1106" extension="665" line_number="1" model="Polycom IP550" mac_address="00:04:f2:13:d6:f7" conflict_type="account_id" />
</conflicts>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES

}}

Switchvox.digiumPhones.assignments.add

Dblood — Mon, 05 Mar 2012 23:42:20 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.digiumPhones.assignments.add}} ==Description== Add a phone assignment to your system. {{XMLAPI_ARGUMENTS |p1_name=account_id |p1_required= |p1_type=i...'

{{DISPLAYTITLE:switchvox.digiumPhones.assignments.add}}
==Description==
Add a phone assignment to your system.

{{XMLAPI_ARGUMENTS
|p1_name=account_id
|p1_required=
|p1_type=integer
|p1_desc=The account_id this assignment should belong to

|p2_name=model
|p2_required=
|p2_type=string
|p2_desc=The model of the phone

|p3_name=mac
|p3_required=required
|p3_type=string
|p3_desc=The MAC address of the phone

|p4_name=ip
|p4_required=
|p4_type=string
|p4_desc=The ip of the phone if you know it
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.digiumPhones.assignments.add">
<parameters>
<account_id>1101</account_id>
<model>s9000</model>
<mac>abcdef123456</mac>
<ip>10.10.10.3</ip>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.digiumPhones.assignments.add">
<result>
<assignment id="26" />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=59182|p1_desc=Invalid MAC address.
|p2_code=10014|p2_desc=Invalid account_id (%1). Account_ids may only contain digits.
|p3_code=84711|p3_desc=That account_id is invalid.
|p4_code=81923|p4_desc=You are missing required parameters to add a phone assignment.
|p5_code=48143|p5_desc=IP Address should be in the format xxx.xxx.xxx.xxx.
|p6_code=44229|p6_desc=Invalid phone model.
}}

Switchvox.callRecordings.recordedCalls.search

Dblood — Mon, 05 Mar 2012 23:41:00 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.callRecordings.recordedCalls.search}} ==Description== Returns information about recorded calls based on search criteria. {{XMLAPI_ARGUMENTS_20 |p1_name...'

{{DISPLAYTITLE:switchvox.callRecordings.recordedCalls.search}}
==Description==
Returns information about recorded calls based on search criteria.

{{XMLAPI_ARGUMENTS_20
|p1_name=filter_type
|p1_required=optional
|p1_type=string
|p1_default=none
|p1_desc=Possible values : date, scheduled_recording, duration, caller_id, account, extension_group, call_queue, none
|p2_name=start_date
|p2_required=optional
|p2_type=string
|p2_default=
|p2_desc=Lower bound of date range. expects format: YYYY-MM-DD hh:mm:ss
|p3_name=end_date
|p3_required=optional
|p3_type=string
|p3_default=
|p3_desc=Upper bound of date range. expects format: YYYY-MM-DD hh:mm:ss
|p4_name=scheduled_recording_id
|p4_required=required if filter_type=scheduled_recording
|p4_type=string
|p4_default=
|p4_desc=recording tag
|p5_name=min_duration
|p5_required=optional
|p5_type=string
|p5_default=
|p5_desc=Lower bound of duration range. expects digits and units (e.g. 10s, 2m, 1h)
|p6_name=max_duration
|p6_required=optional
|p6_type=string
|p6_default=
|p6_desc=Upper bound of duration range. expects digits and units (e.g. 10s, 2m, 1h)
|p7_name=caller_id_number
|p7_required=required if filter_type=caller_id
|p7_type=string
|p7_default=
|p7_desc=
|p8_name=caller_id_direction
|p8_required=required if filter_type=caller_id
|p8_type=string
|p8_default=
|p8_desc=Possible values: to, from
|p9_name=extension_group_id
|p9_required=required if filter_type=extension_group
|p9_type=string
|p9_default=
|p9_desc=extension_group_id (single value only)
|p10_name=account_ids
|p10_required=required if filter_type=account
|p10_type=array
|p10_default=
|p10_desc=array of account_ids
|p11_name=call_queue_account_ids
|p11_required=required if filter_type=call_queue
|p11_type=array
|p11_default=
|p11_desc=array of call queue ids
|p12_name=sort_order
|p12_required=optional
|p12_type=string
|p12_default=date_created (only valid value)
|p12_desc=expects format: YYYY-MM-DD hh:mm:ss
|p13_name=sort_direction
|p13_required=optional
|p13_type=string
|p13_default=DESC
|p13_desc=
|p14_name=items_per_page
|p14_required=optional
|p14_type=string
|p14_default=50
|p14_desc=
|p15_name=page_number
|p15_required=optional
|p15_type=string
|p15_default=1
|p15_desc=
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<?xml version="1.0"?>
<request method="switchvox.callRecordings.recordedCalls.search">
<parameters>
<filter_type>date</filter_type>
<start_date>2011-06-06 00:00:00</start_date>
<end_date>2011-06-06 23:59:59</end_date>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.callRecordings.recordedCalls.search">
<result>
<recorded_calls page_number="1" total_pages="1" items_per_page="50" total_items="50">
<recorded_call recorded_call_id="1009" rc_tag="" from_account_id="1101" to_account_id="1102" from_caller_id_name="" from_caller_id_number="" to_caller_id_name="" to_caller_id_number="" duration="6" start_time="2011-06-06 15:27:51.168521" file=""/>
<recorded_call recorded_call_id="1005" rc_tag="" from_account_id="1101" to_account_id="1102" from_caller_id_name="" from_caller_id_number="" to_caller_id_name="" to_caller_id_number="" duration="2" start_time="2011-06-06 15:17:50.505115" file=""/>
</recorded_calls>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=10000|p1_desc=Invalid filter_type
}}

Switchvox.incomingCallerIdRules.update

Dblood — Mon, 05 Mar 2012 23:30:50 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.incomingCallerIdRules.update}} ==Description== Updates an existing incoming caller id rule. {{XMLAPI_ARGUMENTS_20 |p1_name=id |p1_required=required |...'

{{DISPLAYTITLE:switchvox.incomingCallerIdRules.update}}
==Description==
Updates an existing incoming caller id rule.

{{XMLAPI_ARGUMENTS_20
|p1_name=id
|p1_required=required
|p1_type=integer
|p1_default=
|p1_desc=The ID of an existing incoming caller id rule.
|p2_name=name
|p2_required=required
|p2_type=string
|p2_default=
|p2_desc=The name of the incoming caller id rule.
|p3_name=note
|p3_required=optional
|p3_type=string
|p3_default=
|p3_desc=A note describing this incoming caller id rule.
|p4_name=priority
|p4_required=required
|p4_type=integer
|p4_default=
|p4_desc=The priority order for this incoming caller id rule.
|p5_name=type
|p5_required=required
|p5_type=string
|p5_default=
|p5_desc=Possible values: transfer_call, call_block
|p6_name=prefix
|p6_required=optional
|p6_type=integer
|p6_default=
|p6_desc=The prefix that this rule applies to.
|p7_name=number
|p7_required=optional
|p7_type=integer
|p7_default=
|p7_desc=The number that this rule applies to.
|p8_name=account_id
|p8_required=required for transfer_call
|p8_type=integer
|p8_default=
|p8_desc=The account ID for the extension to transfer the call to.
|p9_name=action
|p9_required=required for call_block
|p9_type=string
|p9_default=
|p9_desc=The action to be applied to blocked calls. Possible values: busy, congestion, hangup
|p10_name=timeframe_id
|p10_required=required
|p10_type=integer
|p10_default=
|p10_desc=Represents the predefined values for time frames.
|p11_name=reorder_only
|p11_required=optional
|p11_type=integer
|p11_default=
|p11_desc=Used when only updating the priority of an item. Pass in a value of 1 along with the id and priority values.

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<?xml version="1.0"?>
<request method="switchvox.incomingCallerIdRules.update">
<parameters>
<id>44</id>
<name>Updated Orange Rule</name>
<note>description of this orange rule</note>
<priority>1</priority>
<type>transfer_call</type>
<prefix>324</prefix>
<account_id>1121</account_id>
<timeframe_id>2</timeframe_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.incomingCallerIdRules.update">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=73546|p1_desc=Rule name is a required field.
|p2_code=34530|p2_desc=Priority is a required field and must be an integer.
|p3_code=82786|p3_desc=Either number or prefix must exist.
|p4_code=27710|p4_desc=Number must be an integer.
|p5_code=73261|p5_desc=Prefix must be an integer.
|p6_code=16617|p6_desc=Timeframe must match an existing predefined timeframe.
|p7_code=19690|p7_desc=Account ID is required to transfer call.
|p8_code=94265|p8_desc=An action is required to transfer call.
|p9_code=16752|p9_desc=Invalid entry for type.
|p10_code=50203|p10_desc=ID is a required field to update record.
}}

Switchvox.incomingCallerIdRules.search

Dblood — Mon, 05 Mar 2012 23:30:02 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.incomingCallerIdRules.search}} ==Description== Returns information about incoming caller id rules based on search criteria. {{XMLAPI_ARGUMENTS_20 |p1_n...'

{{DISPLAYTITLE:switchvox.incomingCallerIdRules.search}}
==Description==
Returns information about incoming caller id rules based on search criteria.

{{XMLAPI_ARGUMENTS_20
|p1_name=name
|p1_required=optional
|p1_type=string
|p1_default=
|p1_desc=The name of the caller id rule to filter by.
|p2_name=type
|p2_required=optional
|p2_type=string
|p2_default=
|p2_desc=The call type to filter by. Possible values : transfer_call, call_block

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<?xml version="1.0"?>
<request method="switchvox.incomingCallerIdRules.search">
<parameters>
<name>green</name>
<type>transfer_call</type>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.incomingCallerIdRules.search">
<result>
<incoming_call_rules total_items="2">
<incoming_call_rule id="45" name="Green Rule" note="my description of this green rule" priority="2" type="transfer_call" prefix="234" number="" action="" timeframe_id="1" >
<extension number="813" status="1" can_dial_from_ivr="0" account_id="1121" display="Voicemail Access" date_created="2010-06-24 10:28:51" type="voicemail" type_display="Voicemail Access" password_required="no" />
</incoming_call_rule>
<incoming_call_rule id="29" name="Green" note="description here" priority="9" type="transfer_call" prefix="" number="34" action="" timeframe_id="4" >
<extension number="813" status="1" can_dial_from_ivr="0" account_id="1121" display="Voicemail Access" date_created="2010-06-24 10:28:51" type="voicemail" type_display="Voicemail Access" password_required="no" />
</incoming_call_rule>
</incoming_call_rules>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=39522|p1_desc=Invalid Type
}}

Switchvox.incomingCallerIdRules.remove

Dblood — Mon, 05 Mar 2012 23:29:15 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.incomingCallerIdRules.remove}} ==Description== Removes an existing incoming caller id rule. {{XMLAPI_ARGUMENTS_20 |p1_name=id |p1_required=required |...'

{{DISPLAYTITLE:switchvox.incomingCallerIdRules.remove}}
==Description==
Removes an existing incoming caller id rule.

{{XMLAPI_ARGUMENTS_20
|p1_name=id
|p1_required=required
|p1_type=integer
|p1_default=
|p1_desc=The ID of an existing incoming caller id rule.

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<?xml version="1.0"?>
<request method="switchvox.incomingCallerIdRules.remove">
<parameters>
<id>28</id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.incomingCallerIdRules.remove">
<result>
<success/>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=50203|p1_desc=ID is a required field to update record.
}}

Switchvox.incomingCallerIdRules.getList

Dblood — Mon, 05 Mar 2012 23:28:24 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.incomingCallerIdRules.getList}} ==Description== Returns all existing incoming caller id rules ordered based on the criteria provided. {{XMLAPI_ARGUMENTS...'

{{DISPLAYTITLE:switchvox.incomingCallerIdRules.getList}}
==Description==
Returns all existing incoming caller id rules ordered based on the criteria provided.

{{XMLAPI_ARGUMENTS_20
|p1_name=sort_field
|p1_required=optional
|p1_type=string
|p1_default=
|p1_desc=The name of the field to sort on.
|p2_name=sort_order
|p2_required=optional
|p2_type=string
|p2_default=
|p2_desc=Order to sort in. Possible values are ASC and DESC

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<?xml version="1.0"?>
<request method="switchvox.incomingCallerIdRules.getList">
<parameters>
<sort_field>priority</sort_field>
<sort_order>ASC</sort_order>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.incomingCallerIdRules.getList">
<result>
<incoming_call_rules total_items="3">
<incoming_call_rule id="45" name="Green Rule" note="my description of this green rule" priority="2" type="transfer_call" prefix="234" number="" action="" timeframe_id="1" >
<extension number="813" status="1" can_dial_from_ivr="0" account_id="1121" display="Voicemail Access" date_created="2010-06-24 10:28:51" type="voicemail" type_display="Voicemail Access" password_required="no" />
</incoming_call_rule>
<incoming_call_rule id="30" name="Green" note="whatever" priority="8" type="call_block" prefix="3242" number="" action="busy" timeframe_id="4" >
<extension number="" status="" can_dial_from_ivr="" account_id="" display="" date_created="" type="" type_display="" />
</incoming_call_rule>
<incoming_call_rule id="29" name="Green" note="description here" priority="9" type="transfer_call" prefix="" number="34" action="" timeframe_id="4" >
<extension number="813" status="1" can_dial_from_ivr="0" account_id="1121" display="Voicemail Access" date_created="2010-06-24 10:28:51" type="voicemail" type_display="Voicemail Access" password_required="no" />
</incoming_call_rule>
</incoming_call_rules>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES

}}

Switchvox.incomingCallerIdRules.getInfo

Dblood — Mon, 05 Mar 2012 23:17:33 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.incomingCallerIdRules.getInfo}} ==Description== Returns all the details for a specific caller id rule. {{XMLAPI_ARGUMENTS_20 |p1_name=id |p1_required=...'

{{DISPLAYTITLE:switchvox.incomingCallerIdRules.getInfo}}
==Description==
Returns all the details for a specific caller id rule.

{{XMLAPI_ARGUMENTS_20
|p1_name=id
|p1_required=required
|p1_type=integer
|p1_default=
|p1_desc=The ID of an existing incoming caller id rule.

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<?xml version="1.0"?>
<request method="switchvox.incomingCallerIdRules.getInfo">
<parameters>
<id>30</id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.incomingCallerIdRules.getInfo">
<result>
<incoming_call_rule id="30" name="Green" note="whatever" priority="8" type="call_block" prefix="3242" number="" action="busy" timeframe_id="4" >
<extension number="" status="" can_dial_from_ivr="" account_id="" display="" date_created="" type="" type_display="" />
</incoming_call_rule>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=50203|p1_desc=ID is a required field to update record.
}}

Switchvox.network.hostAddresses.add

Dblood — Mon, 05 Mar 2012 22:57:49 GMT

Rnavaroli:

{{DISPLAYTITLE:switchvox.network.hostAddresses.add}}
==Description==
Adds a new phone network to host address mapping. Digium Phones can have specific host settings based on the current IP of the phone. This allows for portability of the phone and always having your proper configuration.

{{XMLAPI_ARGUMENTS_60
|p1_name=name
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=Name for the host address mapping
|p2_name=network
|p2_required=required
|p2_type=
|p2_default=
|p2_desc=Network definition in CIDR notation. Defines which network host applies to.
|p3_name=host
|p3_required=required
|p3_type=
|p3_default=
|p3_desc=Hostname or ip address that phones on network should connect to.
|p4_name=ntp_server
|p4_required=required
|p4_type=string
|p4_default=
|p4_desc=valid address for ntp server
|p5_name=is_trusted_network
|p5_required=optional
|p5_type=boolean
|p5_default=0
|p5_desc=Whether or not this network should be used for Direct Port Access
|p6_name=failover_host
|p6_required=optional
|p6_type=string
|p6_default=
|p6_desc=A fallback hostname or ip address that phones on network should connect to when primary host
|p7_name=failover_port
|p7_required=optional
|p7_type=integer
|p7_default=5060
|p7_desc=Port to be used for the failover_host
|p8_name=failover_transport
|p8_required=optional
|p8_type=string
|p8_default=udp
|p8_desc=(udp | tcp) Type of protocol to be used for the failover_host
|p9_name=failover_reregister
|p9_required=optional
|p9_type=integer
|p9_default=120
|p9_desc=Interval in seconds (60 - 999999999) between registration attempts for the failover_host.
|p10_name=failover_retry
|p10_required=optional
|p10_type=integer
|p10_default=25
|p10_desc=Interval in seconds (1 - 999) between attempts to retry registration on failure for the failover_host.
|p11_name=vlan_discovery_mode
|p11_required=optional
|p11_type=string
|p11_default=LLDP
|p11_desc=(LLDP|NONE|MANUAL) if manual vlan_id is required
|p12_name=vlan_id
|p12_required=
|p12_type=integer
|p12_default=
|p12_desc=(1-4095)
|p13_name=rtp_qos
|p13_required=optional
|p13_type=integer
|p13_default=6
|p13_desc=0-7
|p14_name=sip_qos
|p14_required=optional
|p14_type=integer
|p14_default=3
|p14_desc=0-7
|p15_name=rtp_dscp
|p15_required=optional
|p15_type=integer
|p15_default=46
|p15_desc=0-63
|p16_name=sip_dscp
|p16_required=optional
|p16_type=integer
|p16_default=26
|p16_desc=0-63
|p17_name=reregister
|p17_required=optional
|p17_type=integer
|p17_default=120
|p17_desc=Interval in seconds (60 - 999999999) between registration attempts for the primary host.
|p18_name=retry
|p18_required=optional
|p18_type=integer
|p18_default=25
|p18_desc=Interval in seconds (1 - 999) between attempts to retry registration on failure for the primary host.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.network.hostAddresses.add">
<parameters>
<name>Test Host</name>
<network>3.2.1.0/16</network>
<host>3.2.1.128</host>
<ntp_server>pool.ntp.org</ntp_server>
<vlan_discovery_mode>MANUAL</vlan_discovery_mode>
<vlan_id>300</vlan_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.network.hostAddresses.add">
<result>
<host_address id="13" />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=21797|p1_desc=Invalid %1. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:"&\'():-_,.@#+
|p2_code=22286|p2_desc=Invalid hostname (%1)
|p3_code=28221|p3_desc= Invalid network/netmask (it should be something like: 192.168.0.0/24).
|p4_code=64301|p4_desc=A host address for the network %1 already exists.

|p5_code=54625|p5_desc=If vlan_discovery_mode is set to MANUAL vlan_id and vlan_qos are required parameters.

}}

Switchvox.network.hostAddresses.remove

Dblood — Mon, 05 Mar 2012 22:56:55 GMT

Rnavaroli:

{{DISPLAYTITLE:switchvox.network.hostAddresses.remove}}
==Description==
Delete an existing network to host address mapping

{{XMLAPI_ARGUMENTS_60
|p1_name=host_address_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=ID of the host address mapping to update
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.network.hostAddresses.remove">
<parameters>
<host_address_id>13</host_address_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.network.hostAddresses.remove">
<result>
<success />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=29085|p1_desc=The host_address_id is invalid or does not exist.
|p2_code=94574|p2_desc=System network host address mappings cannot be deleted.
}}

Switchvox.network.hostAddresses.getList

Dblood — Mon, 05 Mar 2012 22:55:04 GMT

Rnavaroli:

{{DISPLAYTITLE:switchvox.network.hostAddresses.getList}}
==Description==
Returns the list of all network to host address mappings.

{{XMLAPI_ARGUMENTS
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.network.hostAddresses.getList">
<parameters>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}
{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.network.hostAddresses.getList">
<result>
<host_addresses>
<host_address id="2" name="All Networks" network="0.0.0.0/0" host="pbx.system.net" reregister="120" retry="25" failover_host="" failover_port="5060" failover_transport="udp" failover_reregister="120" failover_retry="25" ntp_server="0.digium.pool.ntp.org" system="1" vlan_discovery_mode="LLDP" vlan_id="" is_trusted_network="0" rtp_qos="7" sip_qos="7" rtp_dscp="63" sip_dscp="63" />
<host_address id="1" name="Internal" network="10.10.0.0/16" host="10.10.7.225" reregister="120" retry="25" failover_host="" failover_port="5060" failover_transport="udp" failover_reregister="120" failover_retry="25" ntp_server="10.10.7.225" system="1" vlan_discovery_mode="LLDP" vlan_id="" is_trusted_network="1" rtp_qos="2" sip_qos="3" rtp_dscp="46" sip_dscp="26" />
<host_address id="4" name="New Host" network="128.128.128.255/12" host="example.server.com" reregister="120" retry="25" failover_host="failover_example.server.com" failover_port="5060" failover_transport="udp" failover_reregister="120" failover_retry="25" ntp_server="pool.ntp.org" system="0" vlan_discovery_mode="" vlan_id="3" is_trusted_network="0" rtp_qos="6" sip_qos="3" rtp_dscp="46" sip_dscp="26" />
</host_addresses>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
}}

Switchvox.network.hostAddresses.update

Dblood — Mon, 05 Mar 2012 21:42:30 GMT

Rnavaroli:

{{DISPLAYTITLE:switchvox.network.hostAddresses.update}}
==Description==
Update an existing network to host address mapping

{{XMLAPI_ARGUMENTS_60
|p1_name=host_address_id
|p1_required=required
|p1_type=
|p1_default=
|p1_desc=ID of the host address mapping to update
|p2_name=name
|p2_required=optional
|p2_type=
|p2_default=
|p2_desc=Name for the host address mapping
|p3_name=network
|p3_required=optional
|p3_type=
|p3_default=
|p3_desc=Network definition in CIDR notation. Defines which network host applies to.
|p4_name=host
|p4_required=optional
|p4_type=
|p4_default=
|p4_desc=Hostname or ip address that phones on network should connect to.
|p5_name=ntp_server
|p5_required=optional
|p5_type=string
|p5_default=
|p5_desc=valid address for ntp server
|p6_name=is_trusted_network
|p6_required=optional
|p6_type=boolean
|p6_default=0
|p6_desc=Whether or not this network should be used for Direct Port Access
|p7_name=failover_host
|p7_required=optional
|p7_type=string
|p7_default=
|p7_desc=A fallback hostname or ip address that phones on network should connect to when primary host
|p8_name=failover_port
|p8_required=optional
|p8_type=integer
|p8_default=5060
|p8_desc=Port to be used for the failover_host
|p9_name=failover_transport
|p9_required=optional
|p9_type=string
|p9_default=udp
|p9_desc=(udp | tcp) Type of protocol to be used for the failover_host
|p10_name=failover_reregister
|p10_required=optional
|p10_type=integer
|p10_default=120
|p10_desc=Interval in seconds between registration attempts for the failover_host.
|p11_name=failover_retry
|p11_required=optional
|p11_type=integer
|p11_default=25
|p11_desc=Interval in seconds between attempts to retry registration on failure for the failover_host.
|p12_name=vlan_discovery_mode
|p12_required=optional
|p12_type=string
|p12_default=LLDP
|p12_desc=(LLDP|NONE|MANUAL) if manual vlan_id is required
|p13_name=vlan_id
|p13_required=
|p13_type=integer
|p13_default=
|p13_desc=(1-4095)
|p14_name=rtp_qos
|p14_required=optional
|p14_type=integer
|p14_default=6
|p14_desc=0-7
|p15_name=sip_qos
|p15_required=optional
|p15_type=integer
|p15_default=3
|p15_desc=0-7
|p16_name=rtp_dscp
|p16_required=optional
|p16_type=integer
|p16_default=46
|p16_desc=0-63
|p17_name=sip_dscp
|p17_required=optional
|p17_type=integer
|p17_default=26
|p17_desc=0-63
|p18_name=reregister
|p18_required=optional
|p18_type=integer
|p18_default=120
|p18_desc=Interval in seconds (60 - 999999999) between registration attempts for the primary host.
|p19_name=retry
|p19_required=optional
|p19_type=integer
|p19_default=25
|p19_desc=Interval in seconds (1 - 999) between attempts to retry registration on failure for the primary host.
}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang="xml">
<request method="switchvox.network.hostAddresses.update">
<parameters>
<host_address_id>13</host_address_id>
<name>New Name</name>
<network>20.20.0.0/16</network>
<host>new.host.com</host>
<alternate_host>alt.host.com</alternate_host>
<ntp_server>pool.ntp.org</ntp_server>
<vlan_discovery_mode>MANUAL</vlan_discovery_mode>
<vlan_id>300</vlan_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang="xml">
<response method="switchvox.network.hostAddresses.update">
<result>
<success />
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES_40
|p1_code=21797|p1_desc=Invalid %1. Must be less than %2 characters and may only contain letters, numbers, spaces, and the following characters:"&\'():-_,.@#+
|p2_code=22286|p2_desc=Invalid hostname (%1)
|p3_code=28221|p3_desc= Invalid network/netmask (it should be something like: 192.168.0.0/24).
|p4_code=64301|p4_desc=A host address for the network %1 already exists.
|p5_code=24741|p5_desc= The name and network cannot be updated on a system default network host address mapping.
|p6_code=29085|p6_desc=The host_address_id is invalid or does not exist.
|p7_code=54625|p7_desc=If vlan_discovery_mode is set to MANUAL vlan_id and vlan_qos are required parameters.

}}

Switchvox.users.callQueues.getList

Dblood — Mon, 05 Mar 2012 21:02:42 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.users.callQueues.getList}} ==Description== Get a list of call queues the user has permission to act on. {{XMLAPI_ARGUMENTS_20 |p1_name=sort_order |p1...'

{{DISPLAYTITLE:switchvox.users.callQueues.getList}}
==Description==

Get a list of call queues the user has permission to act on.

{{XMLAPI_ARGUMENTS_20
|p1_name=sort_order
|p1_required=
|p1_type=string
|p1_default=
|p1_desc=

|p2_name=sort_field
|p2_required=
|p2_type=string
|p2_default=
|p2_desc=

|p3_name=items_per_page
|p3_required=
|p3_type=integer
|p3_default=
|p3_desc=

|p4_name=page_number
|p4_required=
|p4_type=integer
|p4_default=
|p4_desc=

|p5_name=account_id
|p5_required=1
|p5_type=integer
|p5_default=
|p5_desc=The account ID of the user to get the list for,

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang='xml'>
<request method="switchvox.users.callQueues.getList">
<parameters>
<sort_field>extension</sort_field>
<sort_order>ASC</sort_order>
<account_id>1101</account_id>
<items_per_page>50</items_per_page>
<page_number>1</page_number>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang='xml'>
<response method="switchvox.users.callQueues.getList">
<result>
<callQueues page_number="1" total_pages="1" items_per_page="50" total_items="2" permission_level="my_status" login_type="login | permamnent | none">
<callQueue account_id="1055" name="Groups 2" extension="455" loggedin_status="" login_time="555" paused_time="" total_members="" members_logged_in="" callers_waiting=""/> 
<callQueue account_id="1056" name="Groups 3" extension="456" />
</callQueues>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
|p1_code=|p1_desc=
}}

Switchvox.users.callQueues.getTodaysStatus

Dblood — Mon, 05 Mar 2012 21:00:55 GMT

Dblood: Created page with '{{DISPLAYTITLE:switchvox.users.callQueues.getTodaysStatus}} ==Description== Get today's status for a call queue. The results will differ depending on the Switchboard Panel Perm...'

{{DISPLAYTITLE:switchvox.users.callQueues.getTodaysStatus}}
==Description==

Get today's status for a call queue. The results will differ depending on the Switchboard Panel Permissions for the spcified user in the specified queue. Information includes callers waiting, users logged in, etc.

{{XMLAPI_ARGUMENTS_20
|p1_name=call_queue_account_id
|p1_required=1
|p1_type=integer
|p1_default=
|p1_desc=The id of the call queue to get today's status for

|p2_name=account_id
|p2_required=1
|p2_type=integer
|p2_default=
|p2_desc=The account_id of the user maing the request.

}}

{{XMLAPI_EXAMPLE_REQUESTS_AND_RESPONSES_TITLE}}
===Example One===
{{XMLAPI_EXAMPLE_REQUEST_HEADER}}
<source lang='xml'>
<request method="switchvox.users.callQueues.getTodaysStatus">
<parameters>
<account_id>1114</account_id>
<call_queue_account_id>1888</call_queue_account_id>
</parameters>
</request>
</source>
{{XMLAPI_EXAMPLE_REQUEST_FOOTER}}

{{XMLAPI_EXAMPLE_RESPONSE_HEADER}}
<source lang='xml'>
<response method="switchvox.users.callQueues.getTodaysStatus">
<result>
<callQueue account_id="1888" name="The New Queue" extension="301" >
<my_status login_status="permanent" current_call_duration="" current_caller_id_name="" current_caller_id_number="" calls_taken="0" login_time="" time_of_last_call="" total_talk_time="0" avg_talk_time="0" max_talk_time="0" paused_time="" />
<overview callers_waiting="0" members_on_call="0" total_members="2" total_calls="0" abandoned_calls="0" redirected_calls="0" completed_calls_today="0" avg_talk_time="0" max_talk_time="0" avg_wait_time="0" max_wait_time="0" avg_entry_position="0" longest_queue_length="0" max_wait_time_abandoned_calls="0" avg_wait_time_abandoned_calls="0" max_wait_time_completed_calls="0" avg_wait_time_completed_calls="0" logged_in_count="2" />
<detailed_view>
<queue_members>
<queue_member account_id="1114" extension="100" fullname="Jim Smith" order="1" loggedin_status="permanent" login_type="permanent" talking_to_name="" talking_to_number="" time_of_last_call="" completed_calls="0" missed_calls="" avg_talk_time="0" max_talk_time="0" login_time="" paused_time="" call_duration="" />
<queue_member account_id="1105" extension="102" fullname="Michael Jones" order="2" loggedin_status="permanent" login_type="permanent" talking_to_name="" talking_to_number="" time_of_last_call="" completed_calls="0" missed_calls="" avg_talk_time="0" max_talk_time="0" login_time="" paused_time="" call_duration="" />
</queue_members>
<waiting_callers>
</waiting_callers>
</detailed_view>
</callQueue>
</result>
</response>
</source>
{{XMLAPI_EXAMPLE_RESPONSE_FOOTER}}

{{XMLAPI_FAULTCODES
}}