Using API, create a new telephony profile or updates an existing telephony profile in Adobe Connect.

Syntax

http://server_name/api/xml?action=telephony-profile-update&principal-id=integer&profile-name=profile-name&profile-status=profile-status&field-id=field-id&value=value&provider-id=integer

Parameters

Name

Required?

Description

conf-number

N

String that specifies the conference number associated with this profile. If you provide a value, any existing conference numbers for this profile are deleted.

field-id

N

String that specifies the field whose value needs to be updated. If this value is specified, you must also specify a value for provider-id.

location

Y if you specify a value for conf-number; otherwise N

String specifying the country code (for example, UK) of the location to be updated.

principal-id

N

Integer that specifies the user for which the profile is created or updated. If not specified, the principal ID of the user who is currently logged in is used.

profile-id

Y if you are updating a profile

Integer that specifies the profile to be updated. If not specified, a new profile is created.

profile-name

Y if you are creating a profile

The name of the profile being created or updated.

profile-status

Y if you are updating a profile

String that specifies the status of the profile. Acceptable values are enabled and disabled. If you disable a profile, all of its associations with meetings are removed. If you are creating a new profile, the default value is enabled.

provider-id

Y if you are creating a profile

String that specifies the telephony provider for the profile being created or updated

value

Y if field-id is specified; otherwise N

Specifies the value of the field-id.

Permission

If you are creating a new profile, you must have modify permissions on the principal-id. If you are updating a profile, you must have modify permissions on the profile.

Example

Request (to update a profile):

http://example.com/api/xml?action=telephony-profile-update&principal-id=11032&profile-id=11091&profile-status=disabled

Response:

<results> 
    <status code="ok"/> 
</results>

Request (to create a profile):

http://example.com/api/xml?action=telephony-profile-update&principal-id=11032&profile-name=P3&profile-status=enabled&field-id=x-tel-premiere-emea-user-id&value=8073174&field-id=x-tel-premiere-emea-moderator-code&value=4963832&field-id=x-tel-premiere-emea-password&value=password&provider-id=11049

Response:

<results> 
    <status code="ok"/> 
    - 
    <profile profile-status="enabled" provider-id="11050" principal-id="11032" profile-id="11900"> 
        <profile-name>PE3</profile-name> 
    </profile> 
</results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy