AlexaForBusiness / Client / list_conference_providers

list_conference_providers#

AlexaForBusiness.Client.list_conference_providers(**kwargs)#

Lists conference providers under a specific AWS account.

Request Syntax

response = client.list_conference_providers(
    NextToken='string',
    MaxResults=123
)

Parameters:

NextToken (string) – The tokens used for pagination.
MaxResults (integer) – The maximum number of conference providers to be returned, per paginated calls.

Return type:

dict

Returns:

Response Syntax

{
    'ConferenceProviders': [
        {
            '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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ConferenceProviders (list) –
  
  The conference providers.
  - (dict) –
    
    An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.
    - 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.
- NextToken (string) –
  
  The tokens used for pagination.