Personal tools

switchvox.extensions.simpleConferenceRoom.update

From SwitchvoxExtendAPI

Jump to: navigation, search

Contents

Description

Updates an existing simple conference room extension in the system.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.
Name Required Type Default Description
account_id required The account ID of the simple conference room extension
play_enter_and_leave_sound optional If set to 1, play sound when people enter and leave conference room. If no value is provided, will leave it unchanged.
play_music_on_hold optional If set to 1, plays music on hold when there is only 1 person in the conference room. If no value is provided, will leave unchanged.
send_to_extension_on_pound optional Send conference participants to this extension when they press #. If no value is provided, will leave unchanged.

Example Requests & Responses

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

Example One

Request

<request method="switchvox.extensions.simpleConferenceRoom.update">
  <parameters>
    <account_id>1101</account_id>
    <play_enter_and_leave_sound>1</play_enter_and_leave_sound>
    <play_music_on_hold>1</play_music_on_hold>
    <send_to_extension_on_pound>101</send_to_extension_on_pound>
  </parameters>
</request>

Response

<response method="switchvox.extensions.simpleConferenceRoom.update">
  <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
17769 Invalid play_moh. Value must be either a 1 or a 0.
17769 Invalid play_enter_snd. Value must be either a 1 or a 0.
10014 Invalid account_id (%1). Account_ids may only contain digits.
84711 That account_id is invalid.