Personal tools

switchvox.extensionGroups.add

From SwitchvoxExtendAPI

(Difference between revisions)
Jump to: navigation, search
(updating text)
 
(One intermediate revision not shown)
Line 15: Line 15:
|p2_desc=The maximum amount of voicemail allowed in megabytes
|p2_desc=The maximum amount of voicemail allowed in megabytes
-
|p3_name=account_ids<br/><span class="sub_name">account_id</span>
+
|p3_name=members<div class="sub_name">member<div class="sub_name">id</div></div>
 +
|p3_required=
|p3_type=integer
|p3_type=integer
-
|p3_desc=The account_ids you want in your new extension group
+
|p3_default=
 +
|p3_desc=The ids of the member you want in your new extension group.
 +
 
 +
|p4_name=members<div class="sub_name">member<div class="sub_name">type</div></div>
 +
|p4_required=
 +
|p4_type=string
 +
|p4_default=
 +
|p4_desc=The type of the member you are adding. The value of this parameter must be one of the following:
 +
*account
 +
*extension_group
 +
 
 +
|p5_name=description
 +
|p5_type=string
 +
|p5_required=
 +
|p5_default=
 +
|p5_desc=The description for this extension group
 +
 
 +
|p6_name=user_viewable
 +
|p6_required=required
 +
|p6_type=boolean
 +
|p6_default=
 +
|p6_desc=Controls if the users can see this group
 +
 
}}
}}
Line 24: Line 47:
<source lang="xml">
<source lang="xml">
<request method="switchvox.extensionGroups.add">
<request method="switchvox.extensionGroups.add">
-
<parameters>
+
    <parameters>
-
<extension_group_name>How now brown cow</extension_group_name>
+
        <extension_group_name>Sales group</extension_group_name>
-
<vm_quota>50</vm_quota>
+
        <members>
-
<account_ids>
+
            <member>
-
<account_id>1104</account_id>
+
                <type>account</type>
-
</account_ids>
+
                <id>1160</id>
-
</parameters>
+
            </member>
 +
        </members>
 +
        <vm_quota>100</vm_quota>
 +
        <description>Midwest regional sales group</description>
 +
        <user_viewable>1</user_viewable>
 +
    </parameters>
</request>
</request>
</source>
</source>
Line 47: Line 75:
|p2_code=85285|p2_desc=Extension group name already exists
|p2_code=85285|p2_desc=Extension group name already exists
|p3_code=84711|p3_desc=That account_id is invalid.
|p3_code=84711|p3_desc=That account_id is invalid.
 +
|p4_code=24078|p4_desc=You must provide an extension group description.
 +
|p5_code=13597|p5_desc=Invalid extension group description. Must be letters, numbers, or underscores, 32 characters or less.
 +
|p6_code=14502|p6_desc=The group you have attempted to add creates a cycle, and it not permitted.
 +
|p7_code=54209|p7_desc=You may not update or remove this extension group.
 +
|p8_code=66939|p8_desc=Missing the user_viewable parameter.
 +
|p9_code=55713|p9_desc=A member has been passed in missing the %1 property.
}}
}}

Current revision as of 01:14, 6 March 2012

Contents

Description

Add a new extension group.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.
Name Required Type Default Description
extension_group_name required string The name of your new extension group
vm_quota integer Unlimited The maximum amount of voicemail allowed in megabytes
members
member
id
 integer The ids of the member you want in your new extension group.
members
member
type
 string The type of the member you are adding. The value of this parameter must be one of the following:
  • account
  • extension_group
description string The description for this extension group
user_viewable required boolean Controls if the users can see this group

Example One

Request

<request method="switchvox.extensionGroups.add">
    <parameters>
        <extension_group_name>Sales group</extension_group_name>
        <members>
            <member>
                <type>account</type>
                <id>1160</id>
            </member>
        </members>
        <vm_quota>100</vm_quota>
        <description>Midwest regional sales group</description>
        <user_viewable>1</user_viewable>
    </parameters>
</request>

Response

<response method="switchvox.extensionGroups.add">
	<result>
		<extension_group id="12" />
	</result>
</response>

Error Codes

See the Error Code Formatting section to see the xml structure when an error is returned.
See the Generic Error Codes section to see a list of general fault codes that may be returned.
Code Description
78539 You must provide an extension group name
85285 Extension group name already exists
84711 That account_id is invalid.
24078 You must provide an extension group description.
13597 Invalid extension group description. Must be letters, numbers, or underscores, 32 characters or less.
14502 The group you have attempted to add creates a cycle, and it not permitted.
54209 You may not update or remove this extension group.
66939 Missing the user_viewable parameter.
55713 A member has been passed in missing the %1 property.
Retrieved from "http://developers.digium.com/switchvox/wiki/index.php/Switchvox.extensionGroups.add"