Name
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 9
Returns a list of telephony providers.
To return a list of user-configured providers for a particular user, pass the user’s principal ID to principal-id and pass a value of true for is-meeting-host.
To return a list of account-level providers for a specified account, pass the account’s ID to account-id and pass a value of false for is-meeting-host.
To return a list of account-level providers for the account of the currently logged-in user, pass a value of false for is-meeting-host.
Syntax
http://server_name/api/xml?action=telephony-provider-list&is-meeting-host=boolean&account-id=integer&principal-id=integer
Parameters
|
|
Required? |
Description |
|
principal-id |
Y if the value of is-meeting-host is true; otherwise N |
Integer that represents the principal ID of the user who created the user-configured providers. If not specified, the principal ID of the logged-in user is used. |
|
account-id |
N |
Integer that specifies the ID of the account to which the account-level providers belong. If not specified, the account ID of the logged-in user is used. |
|
is-meeting-host |
N |
Boolean value that, if true, indicates that the providers are user-configured and returns a list of providers based on the value of principal-id. The default value is false. |
Permission
For a user-configured provider, you must have view permissions on the provider. For account-level providers, you must have view permission on the account.
Example
Request:
http://example.com/api/xml?action=telephony-provider-list&is-meeting-host=true&principal-id=11032
Response:
<results>
<status code="ok"/>
-
<providers-user>
-
<provider provider-id="11722" acl-id="11032" provider-type="user-conf">
<adaptor-id>11722-adaptor</adaptor-id>
<name>Test</name>
<provider-status>enabled</provider-status>
</provider>
</providers-user>
</results>