AWS API Changes

2022/11/18 - Amazon Chime SDK Voice - 74 new api methods

Changes Amazon Chime Voice Connector, Voice Connector Group and PSTN Audio Service APIs are now available in the Amazon Chime SDK Voice namespace. See https://docs.aws.amazon.com/chime-sdk/latest/dg/sdk-available-regions.html for more details.

GetVoiceConnectorStreamingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
}

Response Structure

(dict) --
- StreamingConfiguration (dict) --
  - DataRetentionInHours (integer) --
  - Disabled (boolean) --
  - StreamingNotificationTargets (list) --
    - (dict) --
      - NotificationTarget (string) --

DeleteSipRule (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_sip_rule(
    SipRuleId='string'
)

type SipRuleId: string
param SipRuleId: [REQUIRED]
returns: None

DeleteSipMediaApplication (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_sip_media_application(
    SipMediaApplicationId='string'
)

type SipMediaApplicationId: string
param SipMediaApplicationId: [REQUIRED]
returns: None

CreateSipMediaApplication (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.create_sip_media_application(
    AwsRegion='string',
    Name='string',
    Endpoints=[
        {
            'LambdaArn': 'string'
        },
    ]
)

type AwsRegion

string

param AwsRegion

[REQUIRED]

type Name

string

param Name

[REQUIRED]

type Endpoints

list

param Endpoints

[REQUIRED]

(dict) --
- LambdaArn (string) --

rtype

dict

returns

Response Syntax

{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- SipMediaApplication (dict) --
  - SipMediaApplicationId (string) --
  - AwsRegion (string) --
  - Name (string) --
  - Endpoints (list) --
    - (dict) --
      - LambdaArn (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

DeleteVoiceConnector (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector(
    VoiceConnectorId='string'
)

type VoiceConnectorId: string
param VoiceConnectorId: [REQUIRED]
returns: None

PutSipMediaApplicationAlexaSkillConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_sip_media_application_alexa_skill_configuration(
    SipMediaApplicationId='string',
    SipMediaApplicationAlexaSkillConfiguration={
        'AlexaSkillStatus': 'ACTIVE'|'INACTIVE',
        'AlexaSkillIds': [
            'string',
        ]
    }
)

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

type SipMediaApplicationAlexaSkillConfiguration

dict

param SipMediaApplicationAlexaSkillConfiguration

AlexaSkillStatus (string) -- [REQUIRED]
AlexaSkillIds (list) -- [REQUIRED]
- (string) --

rtype

dict

returns

Response Syntax

{
    'SipMediaApplicationAlexaSkillConfiguration': {
        'AlexaSkillStatus': 'ACTIVE'|'INACTIVE',
        'AlexaSkillIds': [
            'string',
        ]
    }
}

Response Structure

(dict) --
- SipMediaApplicationAlexaSkillConfiguration (dict) --
  - AlexaSkillStatus (string) --
  - AlexaSkillIds (list) --
    - (string) --

AssociatePhoneNumbersWithVoiceConnector (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.associate_phone_numbers_with_voice_connector(
    VoiceConnectorId='string',
    E164PhoneNumbers=[
        'string',
    ],
    ForceAssociate=True|False
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type E164PhoneNumbers

list

param E164PhoneNumbers

[REQUIRED]

(string) --

type ForceAssociate

boolean

param ForceAssociate

rtype

dict

returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- PhoneNumberErrors (list) --
  - (dict) --
    - PhoneNumberId (string) --
    - ErrorCode (string) --
    - ErrorMessage (string) --

GetSipRule (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_sip_rule(
    SipRuleId='string'
)

type SipRuleId

string

param SipRuleId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'SipRule': {
        'SipRuleId': 'string',
        'Name': 'string',
        'Disabled': True|False,
        'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
        'TriggerValue': 'string',
        'TargetApplications': [
            {
                'SipMediaApplicationId': 'string',
                'Priority': 123,
                'AwsRegion': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- SipRule (dict) --
  - SipRuleId (string) --
  - Name (string) --
  - Disabled (boolean) --
  - TriggerType (string) --
  - TriggerValue (string) --
  - TargetApplications (list) --
    - (dict) --
      - SipMediaApplicationId (string) --
      - Priority (integer) --
      - AwsRegion (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

GetSipMediaApplication (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_sip_media_application(
    SipMediaApplicationId='string'
)

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- SipMediaApplication (dict) --
  - SipMediaApplicationId (string) --
  - AwsRegion (string) --
  - Name (string) --
  - Endpoints (list) --
    - (dict) --
      - LambdaArn (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

UpdateVoiceConnector (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_voice_connector(
    VoiceConnectorId='string',
    Name='string',
    RequireEncryption=True|False
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type Name

string

param Name

[REQUIRED]

type RequireEncryption

boolean

param RequireEncryption

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  - VoiceConnectorId (string) --
  - AwsRegion (string) --
  - Name (string) --
  - OutboundHostName (string) --
  - RequireEncryption (boolean) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - VoiceConnectorArn (string) --

UpdateVoiceConnectorGroup (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_voice_connector_group(
    VoiceConnectorGroupId='string',
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ]
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

type Name

string

param Name

[REQUIRED]

type VoiceConnectorItems

list

param VoiceConnectorItems

[REQUIRED]

(dict) --
- VoiceConnectorId (string) -- [REQUIRED]
- Priority (integer) -- [REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnectorGroup (dict) --
  - VoiceConnectorGroupId (string) --
  - Name (string) --
  - VoiceConnectorItems (list) --
    - (dict) --
      - VoiceConnectorId (string) --
      - Priority (integer) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - VoiceConnectorGroupArn (string) --

GetVoiceConnectorEmergencyCallingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_emergency_calling_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'EmergencyCallingConfiguration': {
        'DNIS': [
            {
                'EmergencyPhoneNumber': 'string',
                'TestPhoneNumber': 'string',
                'CallingCountry': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- EmergencyCallingConfiguration (dict) --
  - DNIS (list) --
    - (dict) --
      - EmergencyPhoneNumber (string) --
      - TestPhoneNumber (string) --
      - CallingCountry (string) --

CreateSipMediaApplicationCall (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.create_sip_media_application_call(
    FromPhoneNumber='string',
    ToPhoneNumber='string',
    SipMediaApplicationId='string',
    SipHeaders={
        'string': 'string'
    },
    ArgumentsMap={
        'string': 'string'
    }
)

type FromPhoneNumber

string

param FromPhoneNumber

[REQUIRED]

type ToPhoneNumber

string

param ToPhoneNumber

[REQUIRED]

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

type SipHeaders

dict

param SipHeaders

(string) --
- (string) --

type ArgumentsMap

dict

param ArgumentsMap

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'SipMediaApplicationCall': {
        'TransactionId': 'string'
    }
}

Response Structure

(dict) --
- SipMediaApplicationCall (dict) --
  - TransactionId (string) --

DeleteVoiceConnectorStreamingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId: string
param VoiceConnectorId: [REQUIRED]
returns: None

UpdateProxySession (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string',
    Capabilities=[
        'Voice'|'SMS',
    ],
    ExpiryMinutes=123
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type ProxySessionId

string

param ProxySessionId

[REQUIRED]

type Capabilities

list

param Capabilities

[REQUIRED]

(string) --

type ExpiryMinutes

integer

param ExpiryMinutes

rtype

dict

returns

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

(dict) --
- ProxySession (dict) --
  - VoiceConnectorId (string) --
  - ProxySessionId (string) --
  - Name (string) --
  - Status (string) --
  - ExpiryMinutes (integer) --
  - Capabilities (list) --
    - (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - EndedTimestamp (datetime) --
  - Participants (list) --
    - (dict) --
      - PhoneNumber (string) --
      - ProxyPhoneNumber (string) --
  - NumberSelectionBehavior (string) --
  - GeoMatchLevel (string) --
  - GeoMatchParams (dict) --
    - Country (string) --
    - AreaCode (string) --

GetSipMediaApplicationAlexaSkillConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_sip_media_application_alexa_skill_configuration(
    SipMediaApplicationId='string'
)

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'SipMediaApplicationAlexaSkillConfiguration': {
        'AlexaSkillStatus': 'ACTIVE'|'INACTIVE',
        'AlexaSkillIds': [
            'string',
        ]
    }
}

Response Structure

(dict) --
- SipMediaApplicationAlexaSkillConfiguration (dict) --
  - AlexaSkillStatus (string) --
  - AlexaSkillIds (list) --
    - (string) --

DeleteVoiceConnectorEmergencyCallingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_emergency_calling_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId: string
param VoiceConnectorId: [REQUIRED]
returns: None

GetGlobalSettings (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_global_settings()

rtype

dict

returns

Response Syntax

{
    'VoiceConnector': {
        'CdrBucket': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  - CdrBucket (string) --

UpdateSipMediaApplication (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_sip_media_application(
    SipMediaApplicationId='string',
    Name='string',
    Endpoints=[
        {
            'LambdaArn': 'string'
        },
    ]
)

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

type Name

string

param Name

type Endpoints

list

param Endpoints

(dict) --
- LambdaArn (string) --

rtype

dict

returns

Response Syntax

{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- SipMediaApplication (dict) --
  - SipMediaApplicationId (string) --
  - AwsRegion (string) --
  - Name (string) --
  - Endpoints (list) --
    - (dict) --
      - LambdaArn (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

PutVoiceConnectorOrigination (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_origination(
    VoiceConnectorId='string',
    Origination={
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type Origination

dict

param Origination

[REQUIRED]

Routes (list) --
- (dict) --
  - Host (string) --
  - Port (integer) --
  - Protocol (string) --
  - Priority (integer) --
  - Weight (integer) --
Disabled (boolean) --

rtype

dict

returns

Response Syntax

{
    'Origination': {
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
}

Response Structure

(dict) --
- Origination (dict) --
  - Routes (list) --
    - (dict) --
      - Host (string) --
      - Port (integer) --
      - Protocol (string) --
      - Priority (integer) --
      - Weight (integer) --
  - Disabled (boolean) --

DisassociatePhoneNumbersFromVoiceConnectorGroup (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.disassociate_phone_numbers_from_voice_connector_group(
    VoiceConnectorGroupId='string',
    E164PhoneNumbers=[
        'string',
    ]
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

type E164PhoneNumbers

list

param E164PhoneNumbers

[REQUIRED]

(string) --

rtype

dict

returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- PhoneNumberErrors (list) --
  - (dict) --
    - PhoneNumberId (string) --
    - ErrorCode (string) --
    - ErrorMessage (string) --

GetPhoneNumberOrder (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_phone_number_order(
    PhoneNumberOrderId='string'
)

type PhoneNumberOrderId

string

param PhoneNumberOrderId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'PhoneNumberOrder': {
        'PhoneNumberOrderId': 'string',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled',
        'OrderType': 'New'|'Porting',
        'OrderedPhoneNumbers': [
            {
                'E164PhoneNumber': 'string',
                'Status': 'Processing'|'Acquired'|'Failed'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- PhoneNumberOrder (dict) --
  - PhoneNumberOrderId (string) --
  - ProductType (string) --
  - Status (string) --
  - OrderType (string) --
  - OrderedPhoneNumbers (list) --
    - (dict) --
      - E164PhoneNumber (string) --
      - Status (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

PutVoiceConnectorProxy (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_proxy(
    VoiceConnectorId='string',
    DefaultSessionExpiryMinutes=123,
    PhoneNumberPoolCountries=[
        'string',
    ],
    FallBackPhoneNumber='string',
    Disabled=True|False
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type DefaultSessionExpiryMinutes

integer

param DefaultSessionExpiryMinutes

[REQUIRED]

type PhoneNumberPoolCountries

list

param PhoneNumberPoolCountries

[REQUIRED]

(string) --

type FallBackPhoneNumber

string

param FallBackPhoneNumber

type Disabled

boolean

param Disabled

rtype

dict

returns

Response Syntax

{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

(dict) --
- Proxy (dict) --
  - DefaultSessionExpiryMinutes (integer) --
  - Disabled (boolean) --
  - FallBackPhoneNumber (string) --
  - PhoneNumberCountries (list) --
    - (string) --

PutVoiceConnectorTermination (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_termination(
    VoiceConnectorId='string',
    Termination={
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type Termination

dict

param Termination

[REQUIRED]

CpsLimit (integer) --
DefaultPhoneNumber (string) --
CallingRegions (list) --
- (string) --
CidrAllowedList (list) --
- (string) --
Disabled (boolean) --

rtype

dict

returns

Response Syntax

{
    'Termination': {
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
}

Response Structure

(dict) --
- Termination (dict) --
  - CpsLimit (integer) --
  - DefaultPhoneNumber (string) --
  - CallingRegions (list) --
    - (string) --
  - CidrAllowedList (list) --
    - (string) --
  - Disabled (boolean) --

CreatePhoneNumberOrder (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.create_phone_number_order(
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    E164PhoneNumbers=[
        'string',
    ]
)

type ProductType

string

param ProductType

[REQUIRED]

type E164PhoneNumbers

list

param E164PhoneNumbers

[REQUIRED]

(string) --

rtype

dict

returns

Response Syntax

{
    'PhoneNumberOrder': {
        'PhoneNumberOrderId': 'string',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled',
        'OrderType': 'New'|'Porting',
        'OrderedPhoneNumbers': [
            {
                'E164PhoneNumber': 'string',
                'Status': 'Processing'|'Acquired'|'Failed'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- PhoneNumberOrder (dict) --
  - PhoneNumberOrderId (string) --
  - ProductType (string) --
  - Status (string) --
  - OrderType (string) --
  - OrderedPhoneNumbers (list) --
    - (dict) --
      - E164PhoneNumber (string) --
      - Status (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

DeleteProxySession (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string'
)

type VoiceConnectorId: string
param VoiceConnectorId: [REQUIRED]
type ProxySessionId: string
param ProxySessionId: [REQUIRED]
returns: None

SearchAvailablePhoneNumbers (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.search_available_phone_numbers(
    AreaCode='string',
    City='string',
    Country='string',
    State='string',
    TollFreePrefix='string',
    PhoneNumberType='Local'|'TollFree',
    MaxResults=123,
    NextToken='string'
)

type AreaCode

string

param AreaCode

type City

string

param City

type Country

string

param Country

type State

string

param State

type TollFreePrefix

string

param TollFreePrefix

type PhoneNumberType

string

param PhoneNumberType

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

rtype

dict

returns

Response Syntax

{
    'E164PhoneNumbers': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- E164PhoneNumbers (list) --
  - (string) --
- NextToken (string) --

GetVoiceConnectorTerminationHealth (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_termination_health(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'TerminationHealth': {
        'Timestamp': datetime(2015, 1, 1),
        'Source': 'string'
    }
}

Response Structure

(dict) --
- TerminationHealth (dict) --
  - Timestamp (datetime) --
  - Source (string) --

DeleteVoiceConnectorTerminationCredentials (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_termination_credentials(
    VoiceConnectorId='string',
    Usernames=[
        'string',
    ]
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type Usernames

list

param Usernames

[REQUIRED]

(string) --

returns

None

ListVoiceConnectors (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_voice_connectors(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

type MaxResults

integer

param MaxResults

rtype

dict

returns

Response Syntax

{
    'VoiceConnectors': [
        {
            'VoiceConnectorId': 'string',
            'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
            'Name': 'string',
            'OutboundHostName': 'string',
            'RequireEncryption': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'VoiceConnectorArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VoiceConnectors (list) --
  - (dict) --
    - VoiceConnectorId (string) --
    - AwsRegion (string) --
    - Name (string) --
    - OutboundHostName (string) --
    - RequireEncryption (boolean) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
    - VoiceConnectorArn (string) --
- NextToken (string) --

UpdateSipMediaApplicationCall (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_sip_media_application_call(
    SipMediaApplicationId='string',
    TransactionId='string',
    Arguments={
        'string': 'string'
    }
)

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

type TransactionId

string

param TransactionId

[REQUIRED]

type Arguments

dict

param Arguments

[REQUIRED]

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'SipMediaApplicationCall': {
        'TransactionId': 'string'
    }
}

Response Structure

(dict) --
- SipMediaApplicationCall (dict) --
  - TransactionId (string) --

ListVoiceConnectorGroups (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_voice_connector_groups(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

type MaxResults

integer

param MaxResults

rtype

dict

returns

Response Syntax

{
    'VoiceConnectorGroups': [
        {
            'VoiceConnectorGroupId': 'string',
            'Name': 'string',
            'VoiceConnectorItems': [
                {
                    'VoiceConnectorId': 'string',
                    'Priority': 123
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'VoiceConnectorGroupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VoiceConnectorGroups (list) --
  - (dict) --
    - VoiceConnectorGroupId (string) --
    - Name (string) --
    - VoiceConnectorItems (list) --
      - (dict) --
        
        VoiceConnectorId (string) --
        
        Priority (integer) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
    - VoiceConnectorGroupArn (string) --
- NextToken (string) --

GetPhoneNumberSettings (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_phone_number_settings()

rtype

dict

returns

Response Syntax

{
    'CallingName': 'string',
    'CallingNameUpdatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- CallingName (string) --
- CallingNameUpdatedTimestamp (datetime) --

GetPhoneNumber (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_phone_number(
    PhoneNumberId='string'
)

type PhoneNumberId

string

param PhoneNumberId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Country': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
        'Capabilities': {
            'InboundCall': True|False,
            'OutboundCall': True|False,
            'InboundSMS': True|False,
            'OutboundSMS': True|False,
            'InboundMMS': True|False,
            'OutboundMMS': True|False
        },
        'Associations': [
            {
                'Value': 'string',
                'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1),
        'OrderId': 'string'
    }
}

Response Structure

(dict) --
- PhoneNumber (dict) --
  - PhoneNumberId (string) --
  - E164PhoneNumber (string) --
  - Country (string) --
  - Type (string) --
  - ProductType (string) --
  - Status (string) --
  - Capabilities (dict) --
    - InboundCall (boolean) --
    - OutboundCall (boolean) --
    - InboundSMS (boolean) --
    - OutboundSMS (boolean) --
    - InboundMMS (boolean) --
    - OutboundMMS (boolean) --
  - Associations (list) --
    - (dict) --
      - Value (string) --
      - Name (string) --
      - AssociatedTimestamp (datetime) --
  - CallingName (string) --
  - CallingNameStatus (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - DeletionTimestamp (datetime) --
  - OrderId (string) --

ListPhoneNumberOrders (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_phone_number_orders(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

type MaxResults

integer

param MaxResults

rtype

dict

returns

Response Syntax

{
    'PhoneNumberOrders': [
        {
            'PhoneNumberOrderId': 'string',
            'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
            'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled',
            'OrderType': 'New'|'Porting',
            'OrderedPhoneNumbers': [
                {
                    'E164PhoneNumber': 'string',
                    'Status': 'Processing'|'Acquired'|'Failed'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- PhoneNumberOrders (list) --
  - (dict) --
    - PhoneNumberOrderId (string) --
    - ProductType (string) --
    - Status (string) --
    - OrderType (string) --
    - OrderedPhoneNumbers (list) --
      - (dict) --
        
        E164PhoneNumber (string) --
        
        Status (string) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
- NextToken (string) --

AssociatePhoneNumbersWithVoiceConnectorGroup (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.associate_phone_numbers_with_voice_connector_group(
    VoiceConnectorGroupId='string',
    E164PhoneNumbers=[
        'string',
    ],
    ForceAssociate=True|False
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

type E164PhoneNumbers

list

param E164PhoneNumbers

[REQUIRED]

(string) --

type ForceAssociate

boolean

param ForceAssociate

rtype

dict

returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- PhoneNumberErrors (list) --
  - (dict) --
    - PhoneNumberId (string) --
    - ErrorCode (string) --
    - ErrorMessage (string) --

PutSipMediaApplicationLoggingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_sip_media_application_logging_configuration(
    SipMediaApplicationId='string',
    SipMediaApplicationLoggingConfiguration={
        'EnableSipMediaApplicationMessageLogs': True|False
    }
)

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

type SipMediaApplicationLoggingConfiguration

dict

param SipMediaApplicationLoggingConfiguration

EnableSipMediaApplicationMessageLogs (boolean) --

rtype

dict

returns

Response Syntax

{
    'SipMediaApplicationLoggingConfiguration': {
        'EnableSipMediaApplicationMessageLogs': True|False
    }
}

Response Structure

(dict) --
- SipMediaApplicationLoggingConfiguration (dict) --
  - EnableSipMediaApplicationMessageLogs (boolean) --

ValidateE911Address (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.validate_e911_address(
    AwsAccountId='string',
    StreetNumber='string',
    StreetInfo='string',
    City='string',
    State='string',
    Country='string',
    PostalCode='string'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

type StreetNumber

string

param StreetNumber

[REQUIRED]

type StreetInfo

string

param StreetInfo

[REQUIRED]

type City

string

param City

[REQUIRED]

type State

string

param State

[REQUIRED]

type Country

string

param Country

[REQUIRED]

type PostalCode

string

param PostalCode

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'ValidationResult': 123,
    'AddressExternalId': 'string',
    'Address': {
        'streetName': 'string',
        'streetSuffix': 'string',
        'postDirectional': 'string',
        'preDirectional': 'string',
        'streetNumber': 'string',
        'city': 'string',
        'state': 'string',
        'postalCode': 'string',
        'postalCodePlus4': 'string',
        'country': 'string'
    },
    'CandidateAddressList': [
        {
            'streetInfo': 'string',
            'streetNumber': 'string',
            'city': 'string',
            'state': 'string',
            'postalCode': 'string',
            'postalCodePlus4': 'string',
            'country': 'string'
        },
    ]
}

Response Structure

(dict) --
- ValidationResult (integer) --
- AddressExternalId (string) --
- Address (dict) --
  - streetName (string) --
  - streetSuffix (string) --
  - postDirectional (string) --
  - preDirectional (string) --
  - streetNumber (string) --
  - city (string) --
  - state (string) --
  - postalCode (string) --
  - postalCodePlus4 (string) --
  - country (string) --
- CandidateAddressList (list) --
  - (dict) --
    - streetInfo (string) --
    - streetNumber (string) --
    - city (string) --
    - state (string) --
    - postalCode (string) --
    - postalCodePlus4 (string) --
    - country (string) --

DeletePhoneNumber (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_phone_number(
    PhoneNumberId='string'
)

type PhoneNumberId: string
param PhoneNumberId: [REQUIRED]
returns: None

ListSipRules (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_sip_rules(
    SipMediaApplicationId='string',
    MaxResults=123,
    NextToken='string'
)

type SipMediaApplicationId

string

param SipMediaApplicationId

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

rtype

dict

returns

Response Syntax

{
    'SipRules': [
        {
            'SipRuleId': 'string',
            'Name': 'string',
            'Disabled': True|False,
            'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
            'TriggerValue': 'string',
            'TargetApplications': [
                {
                    'SipMediaApplicationId': 'string',
                    'Priority': 123,
                    'AwsRegion': 'string'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SipRules (list) --
  - (dict) --
    - SipRuleId (string) --
    - Name (string) --
    - Disabled (boolean) --
    - TriggerType (string) --
    - TriggerValue (string) --
    - TargetApplications (list) --
      - (dict) --
        
        SipMediaApplicationId (string) --
        
        Priority (integer) --
        
        AwsRegion (string) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
- NextToken (string) --

DeleteVoiceConnectorProxy (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_proxy(
    VoiceConnectorId='string'
)

type VoiceConnectorId: string
param VoiceConnectorId: [REQUIRED]
returns: None

CreateProxySession (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.create_proxy_session(
    VoiceConnectorId='string',
    ParticipantPhoneNumbers=[
        'string',
    ],
    Name='string',
    ExpiryMinutes=123,
    Capabilities=[
        'Voice'|'SMS',
    ],
    NumberSelectionBehavior='PreferSticky'|'AvoidSticky',
    GeoMatchLevel='Country'|'AreaCode',
    GeoMatchParams={
        'Country': 'string',
        'AreaCode': 'string'
    }
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type ParticipantPhoneNumbers

list

param ParticipantPhoneNumbers

[REQUIRED]

(string) --

type Name

string

param Name

type ExpiryMinutes

integer

param ExpiryMinutes

type Capabilities

list

param Capabilities

[REQUIRED]

(string) --

type NumberSelectionBehavior

string

param NumberSelectionBehavior

type GeoMatchLevel

string

param GeoMatchLevel

type GeoMatchParams

dict

param GeoMatchParams

Country (string) -- [REQUIRED]
AreaCode (string) -- [REQUIRED]

rtype

dict

returns

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

(dict) --
- ProxySession (dict) --
  - VoiceConnectorId (string) --
  - ProxySessionId (string) --
  - Name (string) --
  - Status (string) --
  - ExpiryMinutes (integer) --
  - Capabilities (list) --
    - (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - EndedTimestamp (datetime) --
  - Participants (list) --
    - (dict) --
      - PhoneNumber (string) --
      - ProxyPhoneNumber (string) --
  - NumberSelectionBehavior (string) --
  - GeoMatchLevel (string) --
  - GeoMatchParams (dict) --
    - Country (string) --
    - AreaCode (string) --

UpdateGlobalSettings (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_global_settings(
    VoiceConnector={
        'CdrBucket': 'string'
    }
)

type VoiceConnector

dict

param VoiceConnector

CdrBucket (string) --

returns

None

ListSupportedPhoneNumberCountries (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_supported_phone_number_countries(
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn'
)

type ProductType

string

param ProductType

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'PhoneNumberCountries': [
        {
            'CountryCode': 'string',
            'SupportedPhoneNumberTypes': [
                'Local'|'TollFree',
            ]
        },
    ]
}

Response Structure

(dict) --
- PhoneNumberCountries (list) --
  - (dict) --
    - CountryCode (string) --
    - SupportedPhoneNumberTypes (list) --
      - (string) --

DeleteVoiceConnectorTermination (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_termination(
    VoiceConnectorId='string'
)

type VoiceConnectorId: string
param VoiceConnectorId: [REQUIRED]
returns: None

CreateVoiceConnectorGroup (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.create_voice_connector_group(
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ]
)

type Name

string

param Name

[REQUIRED]

type VoiceConnectorItems

list

param VoiceConnectorItems

(dict) --
- VoiceConnectorId (string) -- [REQUIRED]
- Priority (integer) -- [REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnectorGroup (dict) --
  - VoiceConnectorGroupId (string) --
  - Name (string) --
  - VoiceConnectorItems (list) --
    - (dict) --
      - VoiceConnectorId (string) --
      - Priority (integer) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - VoiceConnectorGroupArn (string) --

GetVoiceConnectorLoggingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_logging_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'LoggingConfiguration': {
        'EnableSIPLogs': True|False
    }
}

Response Structure

(dict) --
- LoggingConfiguration (dict) --
  - EnableSIPLogs (boolean) --

ListPhoneNumbers (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_phone_numbers(
    Status='string',
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    FilterName='VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
    FilterValue='string',
    MaxResults=123,
    NextToken='string'
)

type Status

string

param Status

type ProductType

string

param ProductType

type FilterName

string

param FilterName

type FilterValue

string

param FilterValue

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

rtype

dict

returns

Response Syntax

{
    'PhoneNumbers': [
        {
            'PhoneNumberId': 'string',
            'E164PhoneNumber': 'string',
            'Country': 'string',
            'Type': 'Local'|'TollFree',
            'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
            'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
            'Capabilities': {
                'InboundCall': True|False,
                'OutboundCall': True|False,
                'InboundSMS': True|False,
                'OutboundSMS': True|False,
                'InboundMMS': True|False,
                'OutboundMMS': True|False
            },
            'Associations': [
                {
                    'Value': 'string',
                    'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                    'AssociatedTimestamp': datetime(2015, 1, 1)
                },
            ],
            'CallingName': 'string',
            'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'DeletionTimestamp': datetime(2015, 1, 1),
            'OrderId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- PhoneNumbers (list) --
  - (dict) --
    - PhoneNumberId (string) --
    - E164PhoneNumber (string) --
    - Country (string) --
    - Type (string) --
    - ProductType (string) --
    - Status (string) --
    - Capabilities (dict) --
      - InboundCall (boolean) --
      - OutboundCall (boolean) --
      - InboundSMS (boolean) --
      - OutboundSMS (boolean) --
      - InboundMMS (boolean) --
      - OutboundMMS (boolean) --
    - Associations (list) --
      - (dict) --
        
        Value (string) --
        
        Name (string) --
        
        AssociatedTimestamp (datetime) --
    - CallingName (string) --
    - CallingNameStatus (string) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
    - DeletionTimestamp (datetime) --
    - OrderId (string) --
- NextToken (string) --

ListVoiceConnectorTerminationCredentials (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_voice_connector_termination_credentials(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'Usernames': [
        'string',
    ]
}

Response Structure

(dict) --
- Usernames (list) --
  - (string) --

PutVoiceConnectorLoggingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_logging_configuration(
    VoiceConnectorId='string',
    LoggingConfiguration={
        'EnableSIPLogs': True|False
    }
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type LoggingConfiguration

dict

param LoggingConfiguration

[REQUIRED]

EnableSIPLogs (boolean) --

rtype

dict

returns

Response Syntax

{
    'LoggingConfiguration': {
        'EnableSIPLogs': True|False
    }
}

Response Structure

(dict) --
- LoggingConfiguration (dict) --
  - EnableSIPLogs (boolean) --

RestorePhoneNumber (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.restore_phone_number(
    PhoneNumberId='string'
)

type PhoneNumberId

string

param PhoneNumberId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Country': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
        'Capabilities': {
            'InboundCall': True|False,
            'OutboundCall': True|False,
            'InboundSMS': True|False,
            'OutboundSMS': True|False,
            'InboundMMS': True|False,
            'OutboundMMS': True|False
        },
        'Associations': [
            {
                'Value': 'string',
                'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1),
        'OrderId': 'string'
    }
}

Response Structure

(dict) --
- PhoneNumber (dict) --
  - PhoneNumberId (string) --
  - E164PhoneNumber (string) --
  - Country (string) --
  - Type (string) --
  - ProductType (string) --
  - Status (string) --
  - Capabilities (dict) --
    - InboundCall (boolean) --
    - OutboundCall (boolean) --
    - InboundSMS (boolean) --
    - OutboundSMS (boolean) --
    - InboundMMS (boolean) --
    - OutboundMMS (boolean) --
  - Associations (list) --
    - (dict) --
      - Value (string) --
      - Name (string) --
      - AssociatedTimestamp (datetime) --
  - CallingName (string) --
  - CallingNameStatus (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - DeletionTimestamp (datetime) --
  - OrderId (string) --

GetProxySession (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type ProxySessionId

string

param ProxySessionId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

(dict) --
- ProxySession (dict) --
  - VoiceConnectorId (string) --
  - ProxySessionId (string) --
  - Name (string) --
  - Status (string) --
  - ExpiryMinutes (integer) --
  - Capabilities (list) --
    - (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - EndedTimestamp (datetime) --
  - Participants (list) --
    - (dict) --
      - PhoneNumber (string) --
      - ProxyPhoneNumber (string) --
  - NumberSelectionBehavior (string) --
  - GeoMatchLevel (string) --
  - GeoMatchParams (dict) --
    - Country (string) --
    - AreaCode (string) --

ListSipMediaApplications (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_sip_media_applications(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

rtype

dict

returns

Response Syntax

{
    'SipMediaApplications': [
        {
            'SipMediaApplicationId': 'string',
            'AwsRegion': 'string',
            'Name': 'string',
            'Endpoints': [
                {
                    'LambdaArn': 'string'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SipMediaApplications (list) --
  - (dict) --
    - SipMediaApplicationId (string) --
    - AwsRegion (string) --
    - Name (string) --
    - Endpoints (list) --
      - (dict) --
        
        LambdaArn (string) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
- NextToken (string) --

ListProxySessions (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_proxy_sessions(
    VoiceConnectorId='string',
    Status='Open'|'InProgress'|'Closed',
    NextToken='string',
    MaxResults=123
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type Status

string

param Status

type NextToken

string

param NextToken

type MaxResults

integer

param MaxResults

rtype

dict

returns

Response Syntax

{
    'ProxySessions': [
        {
            'VoiceConnectorId': 'string',
            'ProxySessionId': 'string',
            'Name': 'string',
            'Status': 'Open'|'InProgress'|'Closed',
            'ExpiryMinutes': 123,
            'Capabilities': [
                'Voice'|'SMS',
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'EndedTimestamp': datetime(2015, 1, 1),
            'Participants': [
                {
                    'PhoneNumber': 'string',
                    'ProxyPhoneNumber': 'string'
                },
            ],
            'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
            'GeoMatchLevel': 'Country'|'AreaCode',
            'GeoMatchParams': {
                'Country': 'string',
                'AreaCode': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ProxySessions (list) --
  - (dict) --
    - VoiceConnectorId (string) --
    - ProxySessionId (string) --
    - Name (string) --
    - Status (string) --
    - ExpiryMinutes (integer) --
    - Capabilities (list) --
      - (string) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
    - EndedTimestamp (datetime) --
    - Participants (list) --
      - (dict) --
        
        PhoneNumber (string) --
        
        ProxyPhoneNumber (string) --
    - NumberSelectionBehavior (string) --
    - GeoMatchLevel (string) --
    - GeoMatchParams (dict) --
      - Country (string) --
      - AreaCode (string) --
- NextToken (string) --

BatchUpdatePhoneNumber (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.batch_update_phone_number(
    UpdatePhoneNumberRequestItems=[
        {
            'PhoneNumberId': 'string',
            'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
            'CallingName': 'string'
        },
    ]
)

type UpdatePhoneNumberRequestItems

list

param UpdatePhoneNumberRequestItems

[REQUIRED]

(dict) --
- PhoneNumberId (string) -- [REQUIRED]
- ProductType (string) --
- CallingName (string) --

rtype

dict

returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- PhoneNumberErrors (list) --
  - (dict) --
    - PhoneNumberId (string) --
    - ErrorCode (string) --
    - ErrorMessage (string) --

ListAvailableVoiceConnectorRegions (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_available_voice_connector_regions()

rtype

dict

returns

Response Syntax

{
    'VoiceConnectorRegions': [
        'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
    ]
}

Response Structure

(dict) --
- VoiceConnectorRegions (list) --
  - (string) --

GetSipMediaApplicationLoggingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_sip_media_application_logging_configuration(
    SipMediaApplicationId='string'
)

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'SipMediaApplicationLoggingConfiguration': {
        'EnableSipMediaApplicationMessageLogs': True|False
    }
}

Response Structure

(dict) --
- SipMediaApplicationLoggingConfiguration (dict) --
  - EnableSipMediaApplicationMessageLogs (boolean) --

GetVoiceConnector (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  - VoiceConnectorId (string) --
  - AwsRegion (string) --
  - Name (string) --
  - OutboundHostName (string) --
  - RequireEncryption (boolean) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - VoiceConnectorArn (string) --

DeleteVoiceConnectorGroup (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_group(
    VoiceConnectorGroupId='string'
)

type VoiceConnectorGroupId: string
param VoiceConnectorGroupId: [REQUIRED]
returns: None

CreateVoiceConnector (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.create_voice_connector(
    Name='string',
    AwsRegion='us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
    RequireEncryption=True|False
)

type Name

string

param Name

[REQUIRED]

type AwsRegion

string

param AwsRegion

type RequireEncryption

boolean

param RequireEncryption

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  - VoiceConnectorId (string) --
  - AwsRegion (string) --
  - Name (string) --
  - OutboundHostName (string) --
  - RequireEncryption (boolean) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - VoiceConnectorArn (string) --

UpdateSipRule (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_sip_rule(
    SipRuleId='string',
    Name='string',
    Disabled=True|False,
    TargetApplications=[
        {
            'SipMediaApplicationId': 'string',
            'Priority': 123,
            'AwsRegion': 'string'
        },
    ]
)

type SipRuleId

string

param SipRuleId

[REQUIRED]

type Name

string

param Name

[REQUIRED]

type Disabled

boolean

param Disabled

type TargetApplications

list

param TargetApplications

(dict) --
- SipMediaApplicationId (string) --
- Priority (integer) --
- AwsRegion (string) --

rtype

dict

returns

Response Syntax

{
    'SipRule': {
        'SipRuleId': 'string',
        'Name': 'string',
        'Disabled': True|False,
        'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
        'TriggerValue': 'string',
        'TargetApplications': [
            {
                'SipMediaApplicationId': 'string',
                'Priority': 123,
                'AwsRegion': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- SipRule (dict) --
  - SipRuleId (string) --
  - Name (string) --
  - Disabled (boolean) --
  - TriggerType (string) --
  - TriggerValue (string) --
  - TargetApplications (list) --
    - (dict) --
      - SipMediaApplicationId (string) --
      - Priority (integer) --
      - AwsRegion (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

PutVoiceConnectorStreamingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_streaming_configuration(
    VoiceConnectorId='string',
    StreamingConfiguration={
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type StreamingConfiguration

dict

param StreamingConfiguration

[REQUIRED]

DataRetentionInHours (integer) -- [REQUIRED]
Disabled (boolean) -- [REQUIRED]
StreamingNotificationTargets (list) --
- (dict) --
  - NotificationTarget (string) --

rtype

dict

returns

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
}

Response Structure

(dict) --
- StreamingConfiguration (dict) --
  - DataRetentionInHours (integer) --
  - Disabled (boolean) --
  - StreamingNotificationTargets (list) --
    - (dict) --
      - NotificationTarget (string) --

DeleteVoiceConnectorOrigination (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_origination(
    VoiceConnectorId='string'
)

type VoiceConnectorId: string
param VoiceConnectorId: [REQUIRED]
returns: None

UpdatePhoneNumberSettings (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_phone_number_settings(
    CallingName='string'
)

type CallingName: string
param CallingName: [REQUIRED]
returns: None

CreateSipRule (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.create_sip_rule(
    Name='string',
    TriggerType='ToPhoneNumber'|'RequestUriHostname',
    TriggerValue='string',
    Disabled=True|False,
    TargetApplications=[
        {
            'SipMediaApplicationId': 'string',
            'Priority': 123,
            'AwsRegion': 'string'
        },
    ]
)

type Name

string

param Name

[REQUIRED]

type TriggerType

string

param TriggerType

[REQUIRED]

type TriggerValue

string

param TriggerValue

[REQUIRED]

type Disabled

boolean

param Disabled

type TargetApplications

list

param TargetApplications

(dict) --
- SipMediaApplicationId (string) --
- Priority (integer) --
- AwsRegion (string) --

rtype

dict

returns

Response Syntax

{
    'SipRule': {
        'SipRuleId': 'string',
        'Name': 'string',
        'Disabled': True|False,
        'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
        'TriggerValue': 'string',
        'TargetApplications': [
            {
                'SipMediaApplicationId': 'string',
                'Priority': 123,
                'AwsRegion': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- SipRule (dict) --
  - SipRuleId (string) --
  - Name (string) --
  - Disabled (boolean) --
  - TriggerType (string) --
  - TriggerValue (string) --
  - TargetApplications (list) --
    - (dict) --
      - SipMediaApplicationId (string) --
      - Priority (integer) --
      - AwsRegion (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

GetVoiceConnectorGroup (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_group(
    VoiceConnectorGroupId='string'
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnectorGroup (dict) --
  - VoiceConnectorGroupId (string) --
  - Name (string) --
  - VoiceConnectorItems (list) --
    - (dict) --
      - VoiceConnectorId (string) --
      - Priority (integer) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - VoiceConnectorGroupArn (string) --

PutVoiceConnectorEmergencyCallingConfiguration (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_emergency_calling_configuration(
    VoiceConnectorId='string',
    EmergencyCallingConfiguration={
        'DNIS': [
            {
                'EmergencyPhoneNumber': 'string',
                'TestPhoneNumber': 'string',
                'CallingCountry': 'string'
            },
        ]
    }
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type EmergencyCallingConfiguration

dict

param EmergencyCallingConfiguration

[REQUIRED]

DNIS (list) --
- (dict) --
  - EmergencyPhoneNumber (string) -- [REQUIRED]
  - TestPhoneNumber (string) --
  - CallingCountry (string) -- [REQUIRED]

rtype

dict

returns

Response Syntax

{
    'EmergencyCallingConfiguration': {
        'DNIS': [
            {
                'EmergencyPhoneNumber': 'string',
                'TestPhoneNumber': 'string',
                'CallingCountry': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- EmergencyCallingConfiguration (dict) --
  - DNIS (list) --
    - (dict) --
      - EmergencyPhoneNumber (string) --
      - TestPhoneNumber (string) --
      - CallingCountry (string) --

PutVoiceConnectorTerminationCredentials (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_termination_credentials(
    VoiceConnectorId='string',
    Credentials=[
        {
            'Username': 'string',
            'Password': 'string'
        },
    ]
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type Credentials

list

param Credentials

(dict) --
- Username (string) --
- Password (string) --

returns

None

GetVoiceConnectorOrigination (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_origination(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'Origination': {
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
}

Response Structure

(dict) --
- Origination (dict) --
  - Routes (list) --
    - (dict) --
      - Host (string) --
      - Port (integer) --
      - Protocol (string) --
      - Priority (integer) --
      - Weight (integer) --
  - Disabled (boolean) --

GetVoiceConnectorTermination (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_termination(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'Termination': {
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
}

Response Structure

(dict) --
- Termination (dict) --
  - CpsLimit (integer) --
  - DefaultPhoneNumber (string) --
  - CallingRegions (list) --
    - (string) --
  - CidrAllowedList (list) --
    - (string) --
  - Disabled (boolean) --

BatchDeletePhoneNumber (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.batch_delete_phone_number(
    PhoneNumberIds=[
        'string',
    ]
)

type PhoneNumberIds

list

param PhoneNumberIds

[REQUIRED]

(string) --

rtype

dict

returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- PhoneNumberErrors (list) --
  - (dict) --
    - PhoneNumberId (string) --
    - ErrorCode (string) --
    - ErrorMessage (string) --

GetVoiceConnectorProxy (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_proxy(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

(dict) --
- Proxy (dict) --
  - DefaultSessionExpiryMinutes (integer) --
  - Disabled (boolean) --
  - FallBackPhoneNumber (string) --
  - PhoneNumberCountries (list) --
    - (string) --

DisassociatePhoneNumbersFromVoiceConnector (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.disassociate_phone_numbers_from_voice_connector(
    VoiceConnectorId='string',
    E164PhoneNumbers=[
        'string',
    ]
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type E164PhoneNumbers

list

param E164PhoneNumbers

[REQUIRED]

(string) --

rtype

dict

returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- PhoneNumberErrors (list) --
  - (dict) --
    - PhoneNumberId (string) --
    - ErrorCode (string) --
    - ErrorMessage (string) --

UpdatePhoneNumber (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_phone_number(
    PhoneNumberId='string',
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    CallingName='string'
)

type PhoneNumberId

string

param PhoneNumberId

[REQUIRED]

type ProductType

string

param ProductType

type CallingName

string

param CallingName

rtype

dict

returns

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Country': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
        'Capabilities': {
            'InboundCall': True|False,
            'OutboundCall': True|False,
            'InboundSMS': True|False,
            'OutboundSMS': True|False,
            'InboundMMS': True|False,
            'OutboundMMS': True|False
        },
        'Associations': [
            {
                'Value': 'string',
                'Name': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1),
        'OrderId': 'string'
    }
}

Response Structure

(dict) --
- PhoneNumber (dict) --
  - PhoneNumberId (string) --
  - E164PhoneNumber (string) --
  - Country (string) --
  - Type (string) --
  - ProductType (string) --
  - Status (string) --
  - Capabilities (dict) --
    - InboundCall (boolean) --
    - OutboundCall (boolean) --
    - InboundSMS (boolean) --
    - OutboundSMS (boolean) --
    - InboundMMS (boolean) --
    - OutboundMMS (boolean) --
  - Associations (list) --
    - (dict) --
      - Value (string) --
      - Name (string) --
      - AssociatedTimestamp (datetime) --
  - CallingName (string) --
  - CallingNameStatus (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - DeletionTimestamp (datetime) --
  - OrderId (string) --