AlexaForBusiness / Client / create_conference_provider

create_conference_provider#

AlexaForBusiness.Client.create_conference_provider(**kwargs)#

Adds a new conference provider under the user’s AWS account.

See also: AWS API Documentation

Request Syntax

response = client.create_conference_provider(
    ConferenceProviderName='string',
    ConferenceProviderType='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'
    },
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ConferenceProviderName (string) –

    [REQUIRED]

    The name of the conference provider.

  • ConferenceProviderType (string) –

    [REQUIRED]

    Represents a type within a list of predefined types.

  • IPDialIn (dict) –

    The IP endpoint and protocol for calling.

    • Endpoint (string) – [REQUIRED]

      The IP address.

    • CommsProtocol (string) – [REQUIRED]

      The protocol, including SIP, SIPS, and H323.

  • PSTNDialIn (dict) –

    The information for PSTN conferencing.

    • CountryCode (string) – [REQUIRED]

      The zip code.

    • PhoneNumber (string) – [REQUIRED]

      The phone number to call to join the conference.

    • OneClickIdDelay (string) – [REQUIRED]

      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) – [REQUIRED]

      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) –

    [REQUIRED]

    The meeting settings for the conference provider.

    • RequirePin (string) – [REQUIRED]

      The values that indicate whether the pin is always required.

  • ClientRequestToken (string) –

    The request token of the client.

    This field is autopopulated if not provided.

  • Tags (list) –

    The tags to be added to the specified resource. Do not provide system tags.

    • (dict) –

      A key-value pair that can be associated with a resource.

      • Key (string) – [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) – [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type:

dict

Returns:

Response Syntax

{
    'ConferenceProviderArn': 'string'
}

Response Structure

  • (dict) –

    • ConferenceProviderArn (string) –

      The ARN of the newly-created conference provider.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException