AlexaForBusiness / Client / get_conference_provider

get_conference_provider#

AlexaForBusiness.Client.get_conference_provider(**kwargs)#

Gets details about a specific conference provider.

See also: AWS API Documentation

Request Syntax

response = client.get_conference_provider(
    ConferenceProviderArn='string'
)
Parameters:

ConferenceProviderArn (string) –

[REQUIRED]

The ARN of the newly created conference provider.

Return type:

dict

Returns:

Response Syntax

{
    'ConferenceProvider': {
        'Arn': 'string',
        'Name': 'string',
        'Type': 'CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
        'IPDialIn': {
            'Endpoint': 'string',
            'CommsProtocol': 'SIP'|'SIPS'|'H323'
        },
        'PSTNDialIn': {
            'CountryCode': 'string',
            'PhoneNumber': 'string',
            'OneClickIdDelay': 'string',
            'OneClickPinDelay': 'string'
        },
        'MeetingSetting': {
            'RequirePin': 'YES'|'NO'|'OPTIONAL'
        }
    }
}

Response Structure

  • (dict) –

    • ConferenceProvider (dict) –

      The conference provider.

      • Arn (string) –

        The ARN of the newly created conference provider.

      • Name (string) –

        The name of the conference provider.

      • Type (string) –

        The type of conference providers.

      • IPDialIn (dict) –

        The IP endpoint and protocol for calling.

        • Endpoint (string) –

          The IP address.

        • CommsProtocol (string) –

          The protocol, including SIP, SIPS, and H323.

      • PSTNDialIn (dict) –

        The information for PSTN conferencing.

        • CountryCode (string) –

          The zip code.

        • PhoneNumber (string) –

          The phone number to call to join the conference.

        • OneClickIdDelay (string) –

          The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

        • OneClickPinDelay (string) –

          The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

      • MeetingSetting (dict) –

        The meeting settings for the conference provider.

        • RequirePin (string) –

          The values that indicate whether the pin is always required.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException