Description
Retrieve information on an existing sip phone extension from 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 extension to get info for. |
Example
Request
<request method="switchvox.extensions.phones.sip.getInfo">
<parameters>
<account_id>1101</account_id>
</parameters>
</request>
Response
<response method="switchvox.extensions.phones.sip.getInfo"> <result> <extension server_uuid="4428492265501239296" number="100" account_id="1101" first_name="Joe" last_name="Smith" username="username" 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="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" allow_insecure_ssl="1" directed_pickup_ringtone="211" logout="1" > <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>
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 |
10014 | Invalid account_id (%1). Account_ids may only contain digits. |
84711 | That account_id is invalid. |