Displays information about 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://example.com/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>

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