Overview
Returns a list of forwarding types.
The function is available as a Web Service request.
Request
Parameters of the API request:
| Parameter | Type | Description | Requirements |
|---|
| token | String | API authentication token | Mandatory |
Response
Parameters of the API response:
| Parameter | Type | Description |
|---|
| status | Status | Possible return values: - OK
- ERROR_GENERAL
- ERROR_UNAUTHORIZED
|
| forwardTypes | List<ForwardType> | Forward types list which can be associated to extensions |
Examples
Example ListForwardTypes transaction
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v3:listForwardTypes>
<token>YWygO3Nw0LlqWWThMKxBa18G3zQ8HKq3</token>
</v3:listForwardTypes>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:listForwardTypesResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
<return>
<forwardTypes>
<id>-1</id>
<idStr>all</idStr>
<name>All</name>
<seq>100</seq>
</forwardTypes>
<forwardTypes>
<id>1</id>
<idStr>fwd</idStr>
<name>Forwarded</name>
<seq>200</seq>
</forwardTypes>
<forwardTypes>
<id>2</id>
<idStr>xfer</idStr>
<name>Transferred</name>
<seq>300</seq>
</forwardTypes>
<forwardTypes>
<id>3</id>
<idStr>teamcall</idStr>
<name>Team Call</name>
<seq>400</seq>
</forwardTypes>
<forwardTypes>
<id>4</id>
<idStr>delegate</idStr>
<name>Delegated</name>
<seq>500</seq>
</forwardTypes>
<status>
<statusCode>OK</statusCode>
</status>
</return>
</ns2:listForwardTypesResponse>
</S:Body>
</S:Envelope>
