switchvox.users.phonebooks.entries.getInfo

From SwitchvoxExtendAPI

Description

Gets the details of a specific phone book entry. This is the same info returned by switchvox.users.phonebooks.getInfo, except it is only the specified entry, instead of all the entries in the phone book.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.

Example Requests & Responses

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

Example One

Request

Get phonebook entry id 655 info for account_id 1989

<request method="switchvox.users.phonebooks.entries.getInfo">
    <parameters>
        <account_id>1989</account_id>
        <phonebook_entry_id>655</phonebook_entry_id>
    </parameters>
</request>

Response

Phonebook entry info returned.

<response method="switchvox.users.phonebooks.entries.getInfo">
	<result>
		<phonebook_entry id="655" name="Brian Jones" extension="102" account_id="1989" permission_type="normal" jid="102@pbx" can_dial_voicemail="1" can_intercom="1" email_address="bjones@example.com" extension_type="sip" extension_type_display="SIP Extension" number_type="internal"  > 
		    <extra_numbers>
		        <extra_number id="3" prefix="" number="5555551212" number_type="external" icon_type="home" icon_path="/images/main/number_icons/home.png" sort_order="" title="Brian Hone" source="entry" hidden="0" />
		    </extra_numbers>
		</phonebook_entry>
	</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.