Pinpoint / Client / get_voice_channel

get_voice_channel#

Pinpoint.Client.get_voice_channel(**kwargs)#

Retrieves information about the status and settings of the voice channel for an application.

Request Syntax

response = client.get_voice_channel(
    ApplicationId='string'
)

Parameters:

ApplicationId (string) –

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

(dict) –

The request succeeded.
- VoiceChannelResponse (dict) –
  
  Provides information about the status and settings of the voice channel for an application.
  - ApplicationId (string) –
    
    The unique identifier for the application that the voice channel applies to.
  - CreationDate (string) –
    
    The date and time, in ISO 8601 format, when the voice channel was enabled.
  - Enabled (boolean) –
    
    Specifies whether the voice channel is enabled for the application.
  - HasCredential (boolean) –
    
    (Not used) This property is retained only for backward compatibility.
  - Id (string) –
    
    (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
  - IsArchived (boolean) –
    
    Specifies whether the voice channel is archived.
  - LastModifiedBy (string) –
    
    The user who last modified the voice channel.
  - LastModifiedDate (string) –
    
    The date and time, in ISO 8601 format, when the voice channel was last modified.
  - Platform (string) –
    
    The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
  - Version (integer) –
    
    The current version of the voice channel.

Exceptions

Pinpoint.Client.exceptions.BadRequestException
Pinpoint.Client.exceptions.InternalServerErrorException
Pinpoint.Client.exceptions.PayloadTooLargeException
Pinpoint.Client.exceptions.ForbiddenException
Pinpoint.Client.exceptions.NotFoundException
Pinpoint.Client.exceptions.MethodNotAllowedException
Pinpoint.Client.exceptions.TooManyRequestsException