Personal tools

switchvox.ivr.globalVariables.remove

From SwitchvoxExtendAPI

Jump to: navigation, search

Contents

Description

Removes a global IVR variable.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.
Name Required Type Default Description
global_ivr_variable_id required integer The id of the global variable id to remove .


Example Requests & Responses

Please see the API Request and Response Format section for more information on various request encodings.

Example One

Request

Remove IVR Global variable with id of 2. 

<request method="switchvox.ivr.globalVariables.remove">
    <parameters>
        <global_ivr_variable_id>2</global_ivr_variable_id>
    </parameters>
</request>

Response

Variable successfully removed. 

<response method="switchvox.ivr.globalVariables.remove">
	<result>
		<success/>
	</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
29673 Invalid variable id (%1).
Retrieved from "http://developers.digium.com/switchvox/wiki/index.php/Switchvox.ivr.globalVariables.remove"