switchvox.users.voicemail.forward

From SwitchvoxExtendAPI

(Difference between revisions)

Jump to: navigation, search

Revision as of 00:04, 7 March 2009

1 Description
2 Arguments
3 Example Requests & Responses
- 3.1 Example One
  - 3.1.1 Request
  - 3.1.2 Response
4 Error Codes

Description

Forwards one or more voicemail/fax message(s) from one folder to another users INBOX/Fax folder.

Arguments

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

Name	Required	Type	Default	Description
account_from	required			The account ID of sender.
account_to	required			The account ID of the recipient. Cannot be the same as the sender.
message_ids	required			An array of message IDs. At least 1 ID is required.
folder	required			The name of the voicemail/fax folder the messages exist in.

Example Requests & Responses

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

Example One

Request

<?xml version="1.0"?>
<request method="switchvox.users.voicemail.forward">
    <parameters>
        <account_from>1101</account_from>
        <account_to>1102</account_to>
        <message_ids>1</message_ids>
        <folder>INBOX</folder>
    </parameters>
</request>

Response

<response method="switchvox.users.voicemail.forward">
  <result>
    <forward success="1" />
  </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
66939	Missing the account_id parameter.
10014	Invalid account_id (%1). Account_ids may only contain digits.
84711	That account_id is invalid.
64125	Invalid Folder (%1)
64127	Please provide at least one message ID
64128	Invalid message ID (%1)
64129	You cannot forward a voicemail message to yourself
27168	Your account is not permitted to run this action.

Retrieved from "http://developers.digium.com/switchvox/wiki/index.php/Switchvox.users.voicemail.forward"

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:switchvox.users.voicemail.forward}}
 ==Description==
-Forwards one or more voicemail message(s) from one folder to another users INBOX.
+Forwards one or more voicemail/fax message(s) from one folder to another users INBOX/Fax folder.
 {{XMLAPI_ARGUMENTS
-	|p1_name=extension_from
+	|p1_name=account_from
 	|p1_required=required
 	|p1_type=
 	|p1_default=
-	|p1_desc=The extension number of sender.
+	|p1_desc=The account ID of sender.
-	|p2_name=extension_to
+	|p2_name=account_to
 	|p2_required=required
 	|p2_type=
 	|p2_default=
-	|p2_desc=The extension number of the recipient. Cannot be the same as the sender.
+	|p2_desc=The account ID of the recipient. Cannot be the same as the sender.
 	|p3_name=message_ids
 	|p3_required=required
@@ Line 23: / Line 23: @@
 	|p4_type=
 	|p4_default=
-	|p4_desc=The name of the voicemail folder the messages exist in.
+	|p4_desc=The name of the voicemail/fax folder the messages exist in.
 }}
@@ Line 33: / Line 33: @@
 <request method="switchvox.users.voicemail.forward">
      <parameters>
-         <extension_from>100</extension_from>
+         <account_from>1101</account_from>
-         <extension_to>101</extension_to>
+         <account_to>1102</account_to>
          <message_ids>1</message_ids>
          <folder>INBOX</folder>
@@ Line 52: / Line 52: @@
 {{XMLAPI_FAULTCODES
-	|p1_code=10010|p1_desc=Invalid extension (%1). Extensions may only contain digits or *.
+	|p1_code=66939|p1_desc=Missing the account_id parameter.
-	|p2_code=86189|p2_desc=Invalid extension (%1). Extensions must start with a non-zero digit.
+	|p2_code=10014|p2_desc=Invalid account_id (%1). Account_ids may only contain digits.
-	|p3_code=74349|p3_desc=That extension number is invalid.
+	|p3_code=84711|p3_desc=That account_id is invalid.
 	|p4_code=64125|p4_desc=Invalid Folder (%1)
 	|p5_code=64127|p5_desc=Please provide at least one message ID

Search

Toolbox

Personal tools

Views