Name
Last updated on
May 15, 2021 12:15:24 AM GMT
|
Also Applies to Adobe Connect 9
Creates a new provider or updates an existing provider.
Only users who are administrators or meeting hosts can create a provider. Adobe Connect 9.5 onwards, this API is updated so that Named Webinar Administrators and Named Virtual Classroom Administrators are able to create audio providers.
To create or update a user-configured provider for the currently logged-in user, pass a value of true for is-meeting-host.
To create or update a user-configured provider for a particular user, pass the user’s principal ID to principal-id and pass a value of true for is-meeting-host.
To update an account-level provider for a specified account, pass the account’s ID to account-id and pass a value of false for is-meeting-host.
Syntax
http://example.com/api/xml?action=telephony-provider-update&is-meeting-host=boolean&principal-id=integer&name=name
Parameters
|
|
Required? |
Description |
|
provider-id |
Y if you are updating a provider; otherwise N |
Integer that specifies the ID of the provider to be updated. If not specified, a new provider is created. |
|
account-id |
N |
The ID of the account to which this provider belongs. If not specified, the ID of the logged- in account is used. |
|
is-meeting-host |
N |
Boolean value that, if true, indicates that the provider is user-configured and creates or updates the provider based on the value of principal-id. |
|
principal-id |
N |
Integer that specified the principal ID of the user for whom a provider needs to be created or updated. If not specified, the logged-in user's principal ID is used. |
|
provider-status |
N |
Boolean value that specifies the status of the provider that is being updated or created. Acceptable values are enabled and disabled. If you are creating a new provider, the default value is enabled. |
|
name |
Y if you are creating a new provider; otherwise N |
String that specifies the name of the provider being created or updated. |
Permission
If you are creating an account-level provider, you must have modify permission on the account. If you are creating a user-configured provider, you must be a member of the meeting hosts or administrators group. If you are updating a provider, you must have modify permission on the provider.
Example
Request (for creating a provider):
http://example.com/api/xml?action=telephony-provider-update&is-meeting-host=true&principal-id=11032&name=my-provider2
Response:
<results>
<status code="ok"/>
-
<telephony-provider provider-status="enabled" provider-type="user-conf" provider-id="12125">
<name>my-provider2</name>
<adaptor-id>12125-adaptor</adaptor-id>
</telephony-provider>
</results>
Request (for updating a provider):
http://example.com/api/xml?action=telephony-provider-update&is-meeting-host=true&principal-id=11032&provider-id=11814&provider-status=disabled
Response:
<results>
<status code="ok"/>
</results>
Sign in to your account
[Feedback V2 Badge]