Using the Telephony XML API

This chapter is a reference for the telephony XML API you use to call back to Adobe® Connect™ Web Services. This API is available in Adobe Connect 7.5 Service Pack 1 and later.

The response values from the XML API actions represent name/value pairs that are fields in the Adobe Connect account. A Java Row object is a name/value pair instantiated from the XML response string. For more information, see Adobe Connect Telephony API Javadoc at www.adobe.com/go/learn_cnn_telephony_javadoc_en.

If an API can’t run as designed (for example, a mandatory parameter isn’t passed), <status code="no-data"/> is returned.

The following table summarizes the XML API actions available, in alphabetical order:

Name

Description

telephony-profile-delete

Deletes the specified profile and removes it from any meetings with which it is associated.

telephony-profile-info

Retrieves the settings for a specified profile.

telephony-profile-list

Retrieves the profiles associated with the specified user’s principal ID.

telephony-profile-update

Creates a new telephony profile or updates an existing profile.

telephony-provider-conf-number-update

For the specified provider, creates conference numbers that can be used for dialing in to an audio conferences.

telephony-provider-delete

Deletes a telephony provider and all information associated with that provider.

telephony-provider-dial-in-info-update

Creates or updates the dial-in-sequence for a provider.

telephony-provider-field-delete

Deletes a provider field.

telephony-provider-field-list

Displays a list of the fields of a provider.

telephony-provider-field-update

Creates or updates a provider field.

telephony-provider-info

Displays information on a telephony provider.

telephony-provider-list

Returns a list of telephony providers.

telephony-provider-update

Creates a new provider or updates an existing provider.

telephony-profile-delete

Deletes the specified profile and removes it from any meetings with which it is associated. To determine profile names, see telephony-profile-list.

Syntax

http://<connect_server_name>/api/xml?action=telephony-profile-delete&profile-id=integer

Parameters

Name

Required?

Description

profile-id

Y

Integer that specifies the ID of the profile you want to delete.

Permission

You must have permission to modify the profile you want to delete.

Example

Request:

http://connectdev1/api/xml?action=telephony-profile-delete&profile-id=11066

Response:

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

telephony-profile-info

Retrieves the settings for a specified profile.

Syntax

http://server_name/api/xml?action=telephony-profile-info&profile-id=integer

Parameters

Name

Required?

Description

account-id

N

Integer that specifies the ID of the account to which the profile belongs. If not specified, the logged in user's account is used.

profile-id

Y

Integer that specifies the ID of the profile you want to view.

Permission

You must have permission to view the profile.

Example

Request:

http://connectdev1.corp.adobe.com/api/xml?action=telephony-profile-info&profile-id=11422

Response:

<results> 
    <status code="ok"/> 
    - 
    <telephony-profile profile-id="11422" provider-id="11319" profile-status="enabled" provider-type="integrated"> 
        <adaptor-id>premiere-adaptor</adaptor-id> 
        <provider-name>premiere-adaptor</provider-name> 
        - 
        <class-name> 
        com.macromedia.breeze_ext.premiere.gateway.PTekGateway 
        </class-name> 
        <profile-name>PNA1-1</profile-name> 
        <provider-status>enabled</provider-status> 
    </telephony-profile> 
    - 
    <telephony-profile-fields disabled="" principal-id="11202" profile-id="11422" profile-status="enabled" provider-id="11319"> 
        <profile-name>PNA1-1</profile-name> 
        <x-tel-premiere-conference-id>5074202</x-tel-premiere-conference-id> 
        <x-tel-premiere-conference-number>1-888-208-8183</x-tel-premiere-conference-number> 
        <x-tel-premiere-uv-conference-number>1-888-208-8183</x-tel-premiere-uv-conference-number> 
        <x-tel-premiere-participant-code>726988</x-tel-premiere-participant-code> 
        <x-tel-premiere-user-id>7003155</x-tel-premiere-user-id> 
        <x-tel-premiere-password>#C$F%P@E!i4/XRiuxhMAZLnQPpS4f0w==</x-tel-premiere-password> 
        <x-tel-premiere-moderator-code>7269889</x-tel-premiere-moderator-code> 
    </telephony-profile-fields> 
</results>

telephony-profile-list

Retrieves the profiles associated with the specified user’s principal ID.

Syntax

http://server_name/api/xml?action=telephony-profile-list&principal-id=integer

Parameters

Name

Required?

Description

principal-id

N

Integer that specifies the principal ID of the user for whom profiles are retrieved. If you don’t specify a value, the logged-in user’s principal ID is used.

Permission

You must have view permissions on the principal-id, if provided.

Example

Request:

http://connectdev1/api/xml?action=telephony-profile-list&principal-id=11032

Response:

<results> 
    <status code="ok"/> 
    - 
    <telephony-profiles> 
        - 
        <profile profile-id="11091" provider-id="11049" profile-status="enabled"> 
            <adaptor-id>premiere-emea-adaptor</adaptor-id> 
            <name>Premiere EMEA</name> 
            <profile-name>PE1</profile-name> 
        </profile> 
        - 
        <profile profile-id="11232" provider-id="11035" profile-status="enabled"> 
            <adaptor-id>premiere-adaptor</adaptor-id> 
            <name>Premiere NA</name> 
            <profile-name>P2</profile-name> 
        </profile> 
    </telephony-profiles> 
</results>

telephony-profile-update

Creates a new telephony profile or updates an existing profile.

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://connectdev1/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://connectdev1/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>

telephony-provider-conf-number-update

For the specified provider, creates conference numbers that can be used for dialing in to an audio conferences.
Note: This API deletes any existing conference numbers.

Syntax

http://server_name/api/xml?action=telephony-provider-conf-number-update&provider-id=integer&conf-number=integer&location=location

Parameters

Name

Required?

Description

provider-id

Y

Integer specifying the provider ID for which the conference number is to be updated.

conf-number

Y

Integer specifying the conference number to be updated.

location

Y

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

Permission

You must have permission to modify the provider whose conference number is being updated.

Example

Request:

http://connectdev1/api/xml?action=telephony-provider-conf-number-update&provider-id=11712&conf-number=4567&location=USA

Response:

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

telephony-provider-delete

Deletes a telephony provider and all information associated with that provider.

Syntax

http://server_name/api/xml?action=telephony-provider-delete&provider-id=integer

Parameters

Name

Required?

Description

provider-id

Y

Integer specifying the provider ID for the provider you want to delete.

Permission

You must have permission to modify the provider which is being deleted.

Example

Request:

http://connectdev1/api/xml?action=telephony-provider-delete&provider-id=11049

Response:

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

telephony-provider-dial-in-info-update

Creates or updates the dial-in-sequence for a provider.
Note: This API deletes any existing dial-in sequences.

Syntax

http://server_name/api/xml?action=telephony-provider-dial-in-info-udpate&step-type=step-type&name=name&provider-id=integer&field-id=integer&value=value

Parameters

Name

Required?

Description

step-type

Y

String that specifies the type of step that is being updated or added. Acceptable values are conf-num, dtmf, and delay.

field-id

N

Integer that specifies the field whose value needs to be updated.

value

N

Specifies the value of the specified field-id.

name

N

String that specifies the name of the dial-in step being created.

provider-id

Y

Integer that specifies the ID of the provider whose dial-in step being created.

Permission

You must have modify permission on the provider whose dial-in-sequence is being update or created.

Example

Request:

http://connectdev1/api/xml?action=telephony-provider-dial-in-info-udpate&step-type=conf-num&name=xyz&provider-id=11814&field-id=11058&value=1000

Response:

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

telephony-provider-field-delete

Deletes a provider field. For a list of available fields, see telephony-provider-field-list.

Syntax

http://server_name/api/xml?action=telephony-provider-field-delete&provider-id=integer&xml-name=xml-name&field-id=integer

Parameters

Name

Required?

Description

provider-id

Y

Integer that specifies the provider whose field is to be deleted.

field-id

N if xml-name is specified, otherwise Y

Integer that specifies the ID of the field to be deleted.

xml-name

N if field-id is specified, otherwise Y

String that specifies the XML name of the field to be deleted. If you also specify a value for field-id, this value is ignored.

Permission

You must have modify permission on the provider whose field is being deleted

Example

Request:

http://connectdev1/api/xml?action=telephony-provider-field-delete&provider-id=11814&xml-name=x-tel-premiere-emea-uv-conference-number

Response:

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

telephony-provider-field-list

Displays a list of the fields of a provider.

Syntax

http://server_name/api/xml?action=telephony-provider-field-list&provider-id=integer

Parameters

Name

Required?

Description

provider-id

Y

The provider whose fields are to be listed.

Permission

You must have view permissions on the provider.

Example

Request:

http://connectdev1/api/xml?action=telephony-provider-field-list&provider-id=11718

Response:

<results> 
    <status code="ok"/> 
    - 
    <telephony-provider-fields> 
        - 
        <field provider-id="11718" field="11038" field-id="x-premiere-direct-phone" display-in-meeting="none" required="false" user-specified="true" input-type="text" is-hidden="true"> 
            <name>Phone Number</name> 
        </field> 
        - 
        <field provider-id="11718" field="11039" field-id="x-premiere-direct-phone-key" display-in-meeting="none" required="false" user-specified="false" input-type="text" is-hidden="true"> 
            <name>{x-premiere-direct-phone-key}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11046" field-id="x-tel-premiere-sign-up-text" display-in-meeting="none" required="false" user-specified="false" input-type="text" is-hidden="false"> 
            - 
            <name> 
                To learn more about Premiere Global or to sign up for a new account, please go to 
                <u><a target="_blank" href="http://www.premiereglobal.com/adobeconnect/">http://www.premiereglobal.com/adobeconnect</a></u>. 
            </name> 
        </field> 
        - 
        <field provider-id="11718" field="11051" field-id="x-tel-premiere-emea-conference-number-part2" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part2}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11052" field-id="x-tel-premiere-emea-conference-number-part3" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part3}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11053" field-id="x-tel-premiere-emea-conference-number-part4" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part4}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11054" field-id="x-tel-premiere-emea-conference-number-part5" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part5}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11055" field-id="x-tel-premiere-emea-conference-number-part6" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part6}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11056" field-id="x-tel-premiere-emea-conference-id" display-in-meeting="none" required="false" user-specified="false" input-type="text" is-hidden="true"> 
            <name>{x-tel-premiere-emea-conference-id}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11057" field-id="x-tel-premiere-emea-conference-number" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>Conference Number(s)</name> 
        </field> 
        - 
        <field provider-id="11718" field="11058" field-id="x-tel-premiere-emea-uv-conference-number" display-in-meeting="none" required="false" user-specified="false" input-type="text" is-hidden="true"> 
            <name>{x-tel-premiere-emea-uv-conference-number}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11059" field-id="x-tel-premiere-emea-participant-code" display-in-meeting="participants" required="false" user-specified="false" input-type="text" is-hidden="false"> 
            <name>Participant Code</name> 
        </field> 
        - 
        <field provider-id="11718" field="11060" field-id="x-tel-premiere-emea-user-id" display-in-meeting="none" required="true" user-specified="true" input-type="text" is-hidden="false"> 
            <name>Client ID</name> 
        </field> 
        - 
        <field provider-id="11718" field="11061" field-id="x-tel-premiere-emea-password" display-in-meeting="none" required="true" user-specified="true" input-type="password" is-hidden="false"> 
            <name>Premiere Password</name> 
        </field> 
        - 
        <field provider-id="11718" field="11062" field-id="x-tel-premiere-emea-moderator-code" display-in-meeting="hosts" required="true" user-specified="true" input-type="text" is-hidden="false"> 
            <name>Moderator Code</name> 
        </field> 
    </telephony-provider-fields> 
</results>

telephony-provider-field-update

Creates or updates a provider field. If updating a field might result in profiles for this provider to be invalid, all profiles are disassociated from meetings.

For example, if you change a field from optional to mandatory, some existing profiles might not meet the new criteria. Therefore, Connect disassociates all this provider’s profiles from meetings. After updating the field or fields, you need to update profiles as needed and then re-associate them with meetings.

Syntax

http://server_name/api/xml?action=telephony-provider-field-update&provider-id=integer&input-type=input-type&display-in-meeting=display-in-meeting&required=boolean&user-specified=boolean&is-hidden=boolean

Parameters

Name

Required?

Description

provider-id

Y

Integer that specifies the provider whose fields need to be updated or created.

field-id

Y if you don’t specify a value for xml-name; otherwise N

Integer that specifies the ID of the field to be updated or created.

xml-name

Y if you don’t specify a value for field-id; otherwise N

String that specifies the XML name of the field to be updated or created. If a value is also specified for field-id, xml-name is ignored.

input-type

Y

Input type of this field. Acceptable values are text, password, textarea, and url.

display-in-meeting

N

String that specifies which participants can see this field in the Connect meeting room. Acceptable values are none and participants.

required

Y

Boolean value that specifies if this is a required field.

user-specified

N

Boolean value that specifies whether this is a field that the user specifies, such as password.

is-hidden

N

Boolean value that specifies whether this field can be displayed through a user interface.

Permission

You must have permission to modify the provider whose field you are creating or updating.

Example

Request (to create a provider field):

http://connectdev1/api/xml?action=telephony-provider-field-update&provider-id=11718&input-type=text&display-in-meeting=participants&required=true&user-specified=true&is-hidden=false

Response:

<results> 
    <status code="ok"/> 
    - 
    <telephony-provider provider-status="enabled" provider-type="user-conf" provider-id="12000"> 
        <name>my-provider</name> 
        <adaptor-id>12000-adaptor</adaptor-id> 
    </telephony-provider> 
</results>

Request (to update a provider field):

http://connectdev1/api/xml?action=telephony-provider-field-update&provider-id=11718&input-type=text&display-in-meeting=participants&required=false&user-specified=false&is-hidden=false&field-id=11829&xml-name=x-tel-11829

Response:

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

telephony-provider-info

Displays information on a telephony provider, including dial-in sequence, provider fields, and associated conference numbers.

Syntax

http://server_name/api/xml?action=telephony-provider-info&is-meeting-host=boolean&provider-id=integer&account-id=integer&principal-id=integer

Parameters

Name

Required?

Description

provider-id

Y

Integer that specifies the provider ID for which information is to be retrieved.

principal-id

N

Integer which, if specified, represents the principal ID of the user who created the provider. If not specified, this value is the principal ID of the currently logged-in user.

account-id

N

If provider-id represents an account-level provider (that is, a provider that was not created by a user), this value is a string that specifies the ID of the account to which the provider belongs. If not specified, this value is the ID of the account of the logged-in user.

is-meeting-host

N

A Boolean value that specifies whether provider-id is a user-configured provider. If this value is true, information is returned based on the value provided for principal-id.

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://connectdev1/api/xml?action=telephony-provider-info&is-meeting-host=false&provider-id=11718&account-id=7

Response:

<results> 
    <status code="ok"/> 
    - 
    <telephony-provider provider-id="11718" provider-type="integrated" token-length="0"> 
        - 
        <class-name> 
        com.macromedia.breeze_ext.premiere.gateway.EMEA.PTekGateway 
        </class-name> 
        <adaptor-id>premiere-emea-adaptor</adaptor-id> 
        <name>Premiere EMEA</name> 
        <token-prefix>#4</token-prefix> 
        <token-postfix>#</token-postfix> 
        <provider-status>enabled</provider-status> 
    </telephony-provider> 
    - 
    <telephony-provider-dial-in-info> 
        <step provider-id="11718" sequence-number="1" field="11058" step-type="conf-num"/> 
        - 
        <step provider-id="11718" sequence-number="2" field="" step-type="delay"> 
            <value>6000</value> 
        </step> 
        <step provider-id="11718" sequence-number="3" field="11059" step-type="dtmf"/> 
        - 
        <step provider-id="11718" sequence-number="4" field="" step-type="dtmf"> 
            <value>#</value> 
        </step> 
        - 
        <step provider-id="11718" sequence-number="5" field="" step-type="delay"> 
            <value>5000</value> 
        </step> 
    </telephony-provider-dial-in-info> 
    - 
    <telephony-provider-fields> 
        - 
        <field provider-id="11718" field="11038" field-id="x-premiere-direct-phone" display-in-meeting="none" required="false" user-specified="true" input-type="text" is-hidden="true"> 
            <name>Phone Number</name> 
        </field> 
        - 
        <field provider-id="11718" field="11039" field-id="x-premiere-direct-phone-key" display-in-meeting="none" required="false" user-specified="false" input-type="text" is-hidden="true"> 
            <name>{x-premiere-direct-phone-key}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11046" field-id="x-tel-premiere-sign-up-text" display-in-meeting="none" required="false" user-specified="false" input-type="text" is-hidden="false"> 
            - 
            <name> 
                To learn more about Premiere Global or to sign up for a new account, please go to 
                <u><a target="_blank" href="http://www.premiereglobal.com/adobeconnect/">http://www.premiereglobal.com/adobeconnect</a></u>. 
            </name> 
        </field> 
        - 
        <field provider-id="11718" field="11051" field-id="x-tel-premiere-emea-conference-number-part2" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part2}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11052" field-id="x-tel-premiere-emea-conference-number-part3" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part3}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11053" field-id="x-tel-premiere-emea-conference-number-part4" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part4}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11054" field-id="x-tel-premiere-emea-conference-number-part5" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part5}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11055" field-id="x-tel-premiere-emea-conference-number-part6" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>{x-tel-premiere-emea-conference-number-part6}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11056" field-id="x-tel-premiere-emea-conference-id" display-in-meeting="none" required="false" user-specified="false" input-type="text" is-hidden="true"> 
            <name>{x-tel-premiere-emea-conference-id}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11057" field-id="x-tel-premiere-emea-conference-number" display-in-meeting="participants" required="false" user-specified="false" input-type="textarea" is-hidden="false"> 
            <name>Conference Number(s)</name> 
        </field> 
        - 
        <field provider-id="11718" field="11058" field-id="x-tel-premiere-emea-uv-conference-number" display-in-meeting="none" required="false" user-specified="false" input-type="text" is-hidden="true"> 
            <name>{x-tel-premiere-emea-uv-conference-number}</name> 
        </field> 
        - 
        <field provider-id="11718" field="11059" field-id="x-tel-premiere-emea-participant-code" display-in-meeting="participants" required="false" user-specified="false" input-type="text" is-hidden="false"> 
            <name>Participant Code</name> 
        </field> 
        - 
        <field provider-id="11718" field="11060" field-id="x-tel-premiere-emea-user-id" display-in-meeting="none" required="true" user-specified="true" input-type="text" is-hidden="false"> 
            <name>Client ID</name> 
        </field> 
        - 
        <field provider-id="11718" field="11061" field-id="x-tel-premiere-emea-password" display-in-meeting="none" required="true" user-specified="true" input-type="password" is-hidden="false"> 
            <name>Premiere Password</name> 
        </field> 
        - 
        <field provider-id="11718" field="11062" field-id="x-tel-premiere-emea-moderator-code" display-in-meeting="hosts" required="true" user-specified="true" input-type="text" is-hidden="false"> 
            <name>Moderator Code</name> 
        </field> 
    </telephony-provider-fields> 
</results>

telephony-provider-list

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

Name

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://connectdev1/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>

telephony-provider-update

Creates a new provider or updates an existing provider. Only users who are administrators or meeting hosts can create a provider.
  • 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://server_name/api/xml?action=telephony-provider-update&is-meeting-host=boolean&principal-id=integer&name=name

Parameters

Name

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://connectdev1/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://connectdev1/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>