SDK for PHP 3.x

Client: Aws\ChimeSDKVoice\ChimeSDKVoiceClient
Service ID: chime-sdk-voice
Version: 2022-08-03

This page describes the parameters and results for the operations of the Amazon Chime SDK Voice (2022-08-03), and shows how to use the Aws\ChimeSDKVoice\ChimeSDKVoiceClient object to call the described operations. This documentation is specific to the 2022-08-03 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociatePhoneNumbersWithVoiceConnector ( array $params = [] )
Associates phone numbers with the specified Amazon Chime SDK Voice Connector.
AssociatePhoneNumbersWithVoiceConnectorGroup ( array $params = [] )
Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.
BatchDeletePhoneNumber ( array $params = [] )
Moves phone numbers into the Deletion queue.
BatchUpdatePhoneNumber ( array $params = [] )
Updates phone number product types, calling names, or phone number names.
CreatePhoneNumberOrder ( array $params = [] )
Creates an order for phone numbers to be provisioned.
CreateProxySession ( array $params = [] )
Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.
CreateSipMediaApplication ( array $params = [] )
Creates a SIP media application.
CreateSipMediaApplicationCall ( array $params = [] )
Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.
CreateSipRule ( array $params = [] )
Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type.
CreateVoiceConnector ( array $params = [] )
Creates an Amazon Chime SDK Voice Connector.
CreateVoiceConnectorGroup ( array $params = [] )
Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account.
CreateVoiceProfile ( array $params = [] )
Creates a voice profile, which consists of an enrolled user and their latest voice print.
CreateVoiceProfileDomain ( array $params = [] )
Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.
DeletePhoneNumber ( array $params = [] )
Moves the specified phone number into the Deletion queue.
DeleteProxySession ( array $params = [] )
Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.
DeleteSipMediaApplication ( array $params = [] )
Deletes a SIP media application.
DeleteSipRule ( array $params = [] )
Deletes a SIP rule.
DeleteVoiceConnector ( array $params = [] )
Deletes an Amazon Chime SDK Voice Connector.
DeleteVoiceConnectorEmergencyCallingConfiguration ( array $params = [] )
Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.
DeleteVoiceConnectorGroup ( array $params = [] )
Deletes an Amazon Chime SDK Voice Connector group.
DeleteVoiceConnectorOrigination ( array $params = [] )
Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.
DeleteVoiceConnectorProxy ( array $params = [] )
Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.
DeleteVoiceConnectorStreamingConfiguration ( array $params = [] )
Deletes a Voice Connector's streaming configuration.
DeleteVoiceConnectorTermination ( array $params = [] )
Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.
DeleteVoiceConnectorTerminationCredentials ( array $params = [] )
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
DeleteVoiceProfile ( array $params = [] )
Deletes a voice profile, including its voice print and enrollment data.
DeleteVoiceProfileDomain ( array $params = [] )
Deletes all voice profiles in the domain.
DisassociatePhoneNumbersFromVoiceConnector ( array $params = [] )
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.
DisassociatePhoneNumbersFromVoiceConnectorGroup ( array $params = [] )
Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.
GetGlobalSettings ( array $params = [] )
Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
GetPhoneNumber ( array $params = [] )
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
GetPhoneNumberOrder ( array $params = [] )
Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.
GetPhoneNumberSettings ( array $params = [] )
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
GetProxySession ( array $params = [] )
Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.
GetSipMediaApplication ( array $params = [] )
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
GetSipMediaApplicationAlexaSkillConfiguration ( array $params = [] )
Gets the Alexa Skill configuration for the SIP media application.
GetSipMediaApplicationLoggingConfiguration ( array $params = [] )
Retrieves the logging configuration for the specified SIP media application.
GetSipRule ( array $params = [] )
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
GetSpeakerSearchTask ( array $params = [] )
Retrieves the details of the specified speaker search task.
GetVoiceConnector ( array $params = [] )
Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
GetVoiceConnectorEmergencyCallingConfiguration ( array $params = [] )
Retrieves the emergency calling configuration details for the specified Voice Connector.
GetVoiceConnectorGroup ( array $params = [] )
Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.
GetVoiceConnectorLoggingConfiguration ( array $params = [] )
Retrieves the logging configuration settings for the specified Voice Connector.
GetVoiceConnectorOrigination ( array $params = [] )
Retrieves the origination settings for the specified Voice Connector.
GetVoiceConnectorProxy ( array $params = [] )
Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.
GetVoiceConnectorStreamingConfiguration ( array $params = [] )
Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector.
GetVoiceConnectorTermination ( array $params = [] )
Retrieves the termination setting details for the specified Voice Connector.
GetVoiceConnectorTerminationHealth ( array $params = [] )
Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.
GetVoiceProfile ( array $params = [] )
Retrieves the details of the specified voice profile.
GetVoiceProfileDomain ( array $params = [] )
Retrieves the details of the specified voice profile domain.
GetVoiceToneAnalysisTask ( array $params = [] )
Retrieves the details of a voice tone analysis task.
ListAvailableVoiceConnectorRegions ( array $params = [] )
Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.
ListPhoneNumberOrders ( array $params = [] )
Lists the phone numbers for an administrator's Amazon Chime SDK account.
ListPhoneNumbers ( array $params = [] )
Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.
ListProxySessions ( array $params = [] )
Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.
ListSipMediaApplications ( array $params = [] )
Lists the SIP media applications under the administrator's AWS account.
ListSipRules ( array $params = [] )
Lists the SIP rules under the administrator's AWS account.
ListSupportedPhoneNumberCountries ( array $params = [] )
Lists the countries that you can order phone numbers from.
ListTagsForResource ( array $params = [] )
Returns a list of the tags in a given resource.
ListVoiceConnectorGroups ( array $params = [] )
Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.
ListVoiceConnectorTerminationCredentials ( array $params = [] )
Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.
ListVoiceConnectors ( array $params = [] )
Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.
ListVoiceProfileDomains ( array $params = [] )
Lists the specified voice profile domains in the administrator's AWS account.
ListVoiceProfiles ( array $params = [] )
Lists the voice profiles in a voice profile domain.
PutSipMediaApplicationAlexaSkillConfiguration ( array $params = [] )
Updates the Alexa Skill configuration for the SIP media application.
PutSipMediaApplicationLoggingConfiguration ( array $params = [] )
Updates the logging configuration for the specified SIP media application.
PutVoiceConnectorEmergencyCallingConfiguration ( array $params = [] )
Updates a Voice Connector's emergency calling configuration.
PutVoiceConnectorLoggingConfiguration ( array $params = [] )
Updates a Voice Connector's logging configuration.
PutVoiceConnectorOrigination ( array $params = [] )
Updates a Voice Connector's origination settings.
PutVoiceConnectorProxy ( array $params = [] )
Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.
PutVoiceConnectorStreamingConfiguration ( array $params = [] )
Updates a Voice Connector's streaming configuration settings.
PutVoiceConnectorTermination ( array $params = [] )
Updates a Voice Connector's termination settings.
PutVoiceConnectorTerminationCredentials ( array $params = [] )
Updates a Voice Connector's termination credentials.
RestorePhoneNumber ( array $params = [] )
Restores a deleted phone number.
SearchAvailablePhoneNumbers ( array $params = [] )
Searches the provisioned phone numbers in an organization.
StartSpeakerSearchTask ( array $params = [] )
Starts a speaker search task.
StartVoiceToneAnalysisTask ( array $params = [] )
Starts a voice tone analysis task.
StopSpeakerSearchTask ( array $params = [] )
Stops a speaker search task.
StopVoiceToneAnalysisTask ( array $params = [] )
Stops a voice tone analysis task.
TagResource ( array $params = [] )
Adds a tag to the specified resource.
UntagResource ( array $params = [] )
Removes tags from a resource.
UpdateGlobalSettings ( array $params = [] )
Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.
UpdatePhoneNumber ( array $params = [] )
Updates phone number details, such as product type, calling name, or phone number name for the specified phone number ID.
UpdatePhoneNumberSettings ( array $params = [] )
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
UpdateProxySession ( array $params = [] )
Updates the specified proxy session details, such as voice or SMS capabilities.
UpdateSipMediaApplication ( array $params = [] )
Updates the details of the specified SIP media application.
UpdateSipMediaApplicationCall ( array $params = [] )
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.
UpdateSipRule ( array $params = [] )
Updates the details of the specified SIP rule.
UpdateVoiceConnector ( array $params = [] )
Updates the details for the specified Amazon Chime SDK Voice Connector.
UpdateVoiceConnectorGroup ( array $params = [] )
Updates the settings for the specified Amazon Chime SDK Voice Connector group.
UpdateVoiceProfile ( array $params = [] )
Updates the specified voice profile’s voice print and refreshes its expiration timestamp.
UpdateVoiceProfileDomain ( array $params = [] )
Updates the settings for the specified voice profile domain.
ValidateE911Address ( array $params = [] )
Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListPhoneNumberOrders
ListPhoneNumbers
ListProxySessions
ListSipMediaApplications
ListSipRules
ListVoiceConnectorGroups
ListVoiceConnectors
ListVoiceProfileDomains
ListVoiceProfiles
SearchAvailablePhoneNumbers

Operations

AssociatePhoneNumbersWithVoiceConnector

$result = $client->associatePhoneNumbersWithVoiceConnector([/* ... */]);
$promise = $client->associatePhoneNumbersWithVoiceConnectorAsync([/* ... */]);

Associates phone numbers with the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->associatePhoneNumbersWithVoiceConnector([
    'E164PhoneNumbers' => ['<string>', ...], // REQUIRED
    'ForceAssociate' => true || false,
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
E164PhoneNumbers
Required: Yes
Type: Array of strings

List of phone numbers, in E.164 format.

ForceAssociate
Type: boolean

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'PhoneNumberErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist|Gone',
            'ErrorMessage' => '<string>',
            'PhoneNumberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
PhoneNumberErrors
Type: Array of PhoneNumberError structures

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

AccessDeniedException:

You don't have the permissions needed to run this action.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

AssociatePhoneNumbersWithVoiceConnectorGroup

$result = $client->associatePhoneNumbersWithVoiceConnectorGroup([/* ... */]);
$promise = $client->associatePhoneNumbersWithVoiceConnectorGroupAsync([/* ... */]);

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

Parameter Syntax

$result = $client->associatePhoneNumbersWithVoiceConnectorGroup([
    'E164PhoneNumbers' => ['<string>', ...], // REQUIRED
    'ForceAssociate' => true || false,
    'VoiceConnectorGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members
E164PhoneNumbers
Required: Yes
Type: Array of strings

List of phone numbers, in E.164 format.

ForceAssociate
Type: boolean

If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

VoiceConnectorGroupId
Required: Yes
Type: string

The Amazon Chime SDK Voice Connector group ID.

Result Syntax

[
    'PhoneNumberErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist|Gone',
            'ErrorMessage' => '<string>',
            'PhoneNumberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
PhoneNumberErrors
Type: Array of PhoneNumberError structures

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

AccessDeniedException:

You don't have the permissions needed to run this action.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchDeletePhoneNumber

$result = $client->batchDeletePhoneNumber([/* ... */]);
$promise = $client->batchDeletePhoneNumberAsync([/* ... */]);

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

Parameter Syntax

$result = $client->batchDeletePhoneNumber([
    'PhoneNumberIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
PhoneNumberIds
Required: Yes
Type: Array of strings

List of phone number IDs.

Result Syntax

[
    'PhoneNumberErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist|Gone',
            'ErrorMessage' => '<string>',
            'PhoneNumberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
PhoneNumberErrors
Type: Array of PhoneNumberError structures

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchUpdatePhoneNumber

$result = $client->batchUpdatePhoneNumber([/* ... */]);
$promise = $client->batchUpdatePhoneNumberAsync([/* ... */]);

Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name.

You cannot have a duplicate phoneNumberId in a request.

Parameter Syntax

$result = $client->batchUpdatePhoneNumber([
    'UpdatePhoneNumberRequestItems' => [ // REQUIRED
        [
            'CallingName' => '<string>',
            'Name' => '<string>',
            'PhoneNumberId' => '<string>', // REQUIRED
            'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
        ],
        // ...
    ],
]);

Parameter Details

Members
UpdatePhoneNumberRequestItems
Required: Yes
Type: Array of UpdatePhoneNumberRequestItem structures

Lists the phone numbers in the update request.

Result Syntax

[
    'PhoneNumberErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist|Gone',
            'ErrorMessage' => '<string>',
            'PhoneNumberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
PhoneNumberErrors
Type: Array of PhoneNumberError structures

A list of failed phone numbers and their error messages.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreatePhoneNumberOrder

$result = $client->createPhoneNumberOrder([/* ... */]);
$promise = $client->createPhoneNumberOrderAsync([/* ... */]);

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

Parameter Syntax

$result = $client->createPhoneNumberOrder([
    'E164PhoneNumbers' => ['<string>', ...], // REQUIRED
    'Name' => '<string>',
    'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn', // REQUIRED
]);

Parameter Details

Members
E164PhoneNumbers
Required: Yes
Type: Array of strings

List of phone numbers, in E.164 format.

Name
Type: string

Specifies the name assigned to one or more phone numbers.

ProductType
Required: Yes
Type: string

The phone number product type.

Result Syntax

[
    'PhoneNumberOrder' => [
        'CreatedTimestamp' => <DateTime>,
        'OrderType' => 'New|Porting',
        'OrderedPhoneNumbers' => [
            [
                'E164PhoneNumber' => '<string>',
                'Status' => 'Processing|Acquired|Failed',
            ],
            // ...
        ],
        'PhoneNumberOrderId' => '<string>',
        'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'Processing|Successful|Failed|Partial|PendingDocuments|Submitted|FOC|ChangeRequested|Exception|CancelRequested|Cancelled',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
PhoneNumberOrder
Type: PhoneNumberOrder structure

The phone number order details.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateProxySession

$result = $client->createProxySession([/* ... */]);
$promise = $client->createProxySessionAsync([/* ... */]);

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

Parameter Syntax

$result = $client->createProxySession([
    'Capabilities' => ['<string>', ...], // REQUIRED
    'ExpiryMinutes' => <integer>,
    'GeoMatchLevel' => 'Country|AreaCode',
    'GeoMatchParams' => [
        'AreaCode' => '<string>', // REQUIRED
        'Country' => '<string>', // REQUIRED
    ],
    'Name' => '<string>',
    'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky',
    'ParticipantPhoneNumbers' => ['<string>', ...], // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Capabilities
Required: Yes
Type: Array of strings

The proxy session's capabilities.

ExpiryMinutes
Type: int

The number of minutes allowed for the proxy session.

GeoMatchLevel
Type: string

The preference for matching the country or area code of the proxy phone number with that of the first participant.

GeoMatchParams
Type: GeoMatchParams structure

The country and area code for the proxy phone number.

Name
Type: string

The name of the proxy session.

NumberSelectionBehavior
Type: string

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

ParticipantPhoneNumbers
Required: Yes
Type: Array of strings

The participant phone numbers.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'ProxySession' => [
        'Capabilities' => ['<string>', ...],
        'CreatedTimestamp' => <DateTime>,
        'EndedTimestamp' => <DateTime>,
        'ExpiryMinutes' => <integer>,
        'GeoMatchLevel' => 'Country|AreaCode',
        'GeoMatchParams' => [
            'AreaCode' => '<string>',
            'Country' => '<string>',
        ],
        'Name' => '<string>',
        'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky',
        'Participants' => [
            [
                'PhoneNumber' => '<string>',
                'ProxyPhoneNumber' => '<string>',
            ],
            // ...
        ],
        'ProxySessionId' => '<string>',
        'Status' => 'Open|InProgress|Closed',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorId' => '<string>',
    ],
]

Result Details

Members
ProxySession
Type: ProxySession structure

The proxy session details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateSipMediaApplication

$result = $client->createSipMediaApplication([/* ... */]);
$promise = $client->createSipMediaApplicationAsync([/* ... */]);

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

Parameter Syntax

$result = $client->createSipMediaApplication([
    'AwsRegion' => '<string>', // REQUIRED
    'Endpoints' => [ // REQUIRED
        [
            'LambdaArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
AwsRegion
Required: Yes
Type: string

The AWS Region assigned to the SIP media application.

Endpoints
Required: Yes
Type: Array of SipMediaApplicationEndpoint structures

List of endpoints (Lambda ARNs) specified for the SIP media application.

Name
Required: Yes
Type: string

The SIP media application's name.

Tags
Type: Array of Tag structures

The tags assigned to the SIP media application.

Result Syntax

[
    'SipMediaApplication' => [
        'AwsRegion' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'Endpoints' => [
            [
                'LambdaArn' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'SipMediaApplicationArn' => '<string>',
        'SipMediaApplicationId' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SipMediaApplication
Type: SipMediaApplication structure

The SIP media application details.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ConflictException:

Multiple instances of the same request were made simultaneously.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateSipMediaApplicationCall

$result = $client->createSipMediaApplicationCall([/* ... */]);
$promise = $client->createSipMediaApplicationCallAsync([/* ... */]);

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

Parameter Syntax

$result = $client->createSipMediaApplicationCall([
    'ArgumentsMap' => ['<string>', ...],
    'FromPhoneNumber' => '<string>', // REQUIRED
    'SipHeaders' => ['<string>', ...],
    'SipMediaApplicationId' => '<string>', // REQUIRED
    'ToPhoneNumber' => '<string>', // REQUIRED
]);

Parameter Details

Members
ArgumentsMap
Type: Associative array of custom strings keys (SensitiveString) to strings

Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: "FirstName": "John", "LastName": "Doe"

FromPhoneNumber
Required: Yes
Type: string

The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.

SipHeaders
Type: Associative array of custom strings keys (SensitiveString) to strings

The SIP headers added to an outbound call leg.

SipMediaApplicationId
Required: Yes
Type: string

The ID of the SIP media application.

ToPhoneNumber
Required: Yes
Type: string

The phone number that the service should call.

Result Syntax

[
    'SipMediaApplicationCall' => [
        'TransactionId' => '<string>',
    ],
]

Result Details

Members
SipMediaApplicationCall
Type: SipMediaApplicationCall structure

The actual call.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

UnauthorizedClientException:

The client isn't authorized to request a resource.

AccessDeniedException:

You don't have the permissions needed to run this action.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateSipRule

$result = $client->createSipRule([/* ... */]);
$promise = $client->createSipRuleAsync([/* ... */]);

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

Parameter Syntax

$result = $client->createSipRule([
    'Disabled' => true || false,
    'Name' => '<string>', // REQUIRED
    'TargetApplications' => [
        [
            'AwsRegion' => '<string>',
            'Priority' => <integer>,
            'SipMediaApplicationId' => '<string>',
        ],
        // ...
    ],
    'TriggerType' => 'ToPhoneNumber|RequestUriHostname', // REQUIRED
    'TriggerValue' => '<string>', // REQUIRED
]);

Parameter Details

Members
Disabled
Type: boolean

Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

Name
Required: Yes
Type: string

The name of the SIP rule.

TargetApplications
Type: Array of SipRuleTargetApplication structures

List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

TriggerType
Required: Yes
Type: string

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

TriggerValue
Required: Yes
Type: string

If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

Result Syntax

[
    'SipRule' => [
        'CreatedTimestamp' => <DateTime>,
        'Disabled' => true || false,
        'Name' => '<string>',
        'SipRuleId' => '<string>',
        'TargetApplications' => [
            [
                'AwsRegion' => '<string>',
                'Priority' => <integer>,
                'SipMediaApplicationId' => '<string>',
            ],
            // ...
        ],
        'TriggerType' => 'ToPhoneNumber|RequestUriHostname',
        'TriggerValue' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SipRule
Type: SipRule structure

The SIP rule information, including the rule ID, triggers, and target applications.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ConflictException:

Multiple instances of the same request were made simultaneously.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateVoiceConnector

$result = $client->createVoiceConnector([/* ... */]);
$promise = $client->createVoiceConnectorAsync([/* ... */]);

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

Parameter Syntax

$result = $client->createVoiceConnector([
    '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>', // REQUIRED
    'RequireEncryption' => true || false, // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
AwsRegion
Type: string

The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .

Name
Required: Yes
Type: string

The name of the Voice Connector.

RequireEncryption
Required: Yes
Type: boolean

Enables or disables encryption for the Voice Connector.

Tags
Type: Array of Tag structures

The tags assigned to the Voice Connector.

Result Syntax

[
    'VoiceConnector' => [
        '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',
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'OutboundHostName' => '<string>',
        'RequireEncryption' => true || false,
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorArn' => '<string>',
        'VoiceConnectorId' => '<string>',
    ],
]

Result Details

Members
VoiceConnector
Type: VoiceConnector structure

The details of the Voice Connector.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateVoiceConnectorGroup

$result = $client->createVoiceConnectorGroup([/* ... */]);
$promise = $client->createVoiceConnectorGroupAsync([/* ... */]);

Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request.

You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

Parameter Syntax

$result = $client->createVoiceConnectorGroup([
    'Name' => '<string>', // REQUIRED
    'VoiceConnectorItems' => [
        [
            'Priority' => <integer>, // REQUIRED
            'VoiceConnectorId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the Voice Connector group.

VoiceConnectorItems
Type: Array of VoiceConnectorItem structures

Lists the Voice Connectors that inbound calls are routed to.

Result Syntax

[
    'VoiceConnectorGroup' => [
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorGroupArn' => '<string>',
        'VoiceConnectorGroupId' => '<string>',
        'VoiceConnectorItems' => [
            [
                'Priority' => <integer>,
                'VoiceConnectorId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
VoiceConnectorGroup
Type: VoiceConnectorGroup structure

The details of the Voice Connector group.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateVoiceProfile

$result = $client->createVoiceProfile([/* ... */]);
$promise = $client->createVoiceProfileAsync([/* ... */]);

Creates a voice profile, which consists of an enrolled user and their latest voice print.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

Parameter Syntax

$result = $client->createVoiceProfile([
    'SpeakerSearchTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SpeakerSearchTaskId
Required: Yes
Type: string

The ID of the speaker search task.

Result Syntax

[
    'VoiceProfile' => [
        'CreatedTimestamp' => <DateTime>,
        'ExpirationTimestamp' => <DateTime>,
        'UpdatedTimestamp' => <DateTime>,
        'VoiceProfileArn' => '<string>',
        'VoiceProfileDomainId' => '<string>',
        'VoiceProfileId' => '<string>',
    ],
]

Result Details

Members
VoiceProfile
Type: VoiceProfile structure

The requested voice profile.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ResourceLimitExceededException:

The request exceeds the resource limit.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

NotFoundException:

The requested resource couldn't be found.

ConflictException:

Multiple instances of the same request were made simultaneously.

GoneException:

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateVoiceProfileDomain

$result = $client->createVoiceProfileDomain([/* ... */]);
$promise = $client->createVoiceProfileDomainAsync([/* ... */]);

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

Parameter Syntax

$result = $client->createVoiceProfileDomain([
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'ServerSideEncryptionConfiguration' => [ // REQUIRED
        'KmsKeyArn' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

The unique identifier for the client request. Use a different token for different domain creation requests.

Description
Type: string

A description of the voice profile domain.

Name
Required: Yes
Type: string

The name of the voice profile domain.

ServerSideEncryptionConfiguration
Required: Yes
Type: ServerSideEncryptionConfiguration structure

The server-side encryption configuration for the request.

Tags
Type: Array of Tag structures

The tags assigned to the domain.

Result Syntax

[
    'VoiceProfileDomain' => [
        'CreatedTimestamp' => <DateTime>,
        'Description' => '<string>',
        'Name' => '<string>',
        'ServerSideEncryptionConfiguration' => [
            'KmsKeyArn' => '<string>',
        ],
        'UpdatedTimestamp' => <DateTime>,
        'VoiceProfileDomainArn' => '<string>',
        'VoiceProfileDomainId' => '<string>',
    ],
]

Result Details

Members
VoiceProfileDomain
Type: VoiceProfileDomain structure

The requested voice profile domain.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

ConflictException:

Multiple instances of the same request were made simultaneously.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeletePhoneNumber

$result = $client->deletePhoneNumber([/* ... */]);
$promise = $client->deletePhoneNumberAsync([/* ... */]);

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted permanently.

Parameter Syntax

$result = $client->deletePhoneNumber([
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members
PhoneNumberId
Required: Yes
Type: string

The phone number ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteProxySession

$result = $client->deleteProxySession([/* ... */]);
$promise = $client->deleteProxySessionAsync([/* ... */]);

Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->deleteProxySession([
    'ProxySessionId' => '<string>', // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ProxySessionId
Required: Yes
Type: string

The proxy session ID.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteSipMediaApplication

$result = $client->deleteSipMediaApplication([/* ... */]);
$promise = $client->deleteSipMediaApplicationAsync([/* ... */]);

Deletes a SIP media application.

Parameter Syntax

$result = $client->deleteSipMediaApplication([
    'SipMediaApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SipMediaApplicationId
Required: Yes
Type: string

The SIP media application ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteSipRule

$result = $client->deleteSipRule([/* ... */]);
$promise = $client->deleteSipRuleAsync([/* ... */]);

Deletes a SIP rule.

Parameter Syntax

$result = $client->deleteSipRule([
    'SipRuleId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SipRuleId
Required: Yes
Type: string

The SIP rule ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceConnector

$result = $client->deleteVoiceConnector([/* ... */]);
$promise = $client->deleteVoiceConnectorAsync([/* ... */]);

Deletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.

Parameter Syntax

$result = $client->deleteVoiceConnector([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceConnectorEmergencyCallingConfiguration

$result = $client->deleteVoiceConnectorEmergencyCallingConfiguration([/* ... */]);
$promise = $client->deleteVoiceConnectorEmergencyCallingConfigurationAsync([/* ... */]);

Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->deleteVoiceConnectorEmergencyCallingConfiguration([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceConnectorGroup

$result = $client->deleteVoiceConnectorGroup([/* ... */]);
$promise = $client->deleteVoiceConnectorGroupAsync([/* ... */]);

Deletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

Parameter Syntax

$result = $client->deleteVoiceConnectorGroup([
    'VoiceConnectorGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorGroupId
Required: Yes
Type: string

The Voice Connector Group ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceConnectorOrigination

$result = $client->deleteVoiceConnectorOrigination([/* ... */]);
$promise = $client->deleteVoiceConnectorOriginationAsync([/* ... */]);

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

Parameter Syntax

$result = $client->deleteVoiceConnectorOrigination([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceConnectorProxy

$result = $client->deleteVoiceConnectorProxy([/* ... */]);
$promise = $client->deleteVoiceConnectorProxyAsync([/* ... */]);

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->deleteVoiceConnectorProxy([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceConnectorStreamingConfiguration

$result = $client->deleteVoiceConnectorStreamingConfiguration([/* ... */]);
$promise = $client->deleteVoiceConnectorStreamingConfigurationAsync([/* ... */]);

Deletes a Voice Connector's streaming configuration.

Parameter Syntax

$result = $client->deleteVoiceConnectorStreamingConfiguration([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceConnectorTermination

$result = $client->deleteVoiceConnectorTermination([/* ... */]);
$promise = $client->deleteVoiceConnectorTerminationAsync([/* ... */]);

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.

If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

Parameter Syntax

$result = $client->deleteVoiceConnectorTermination([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceConnectorTerminationCredentials

$result = $client->deleteVoiceConnectorTerminationCredentials([/* ... */]);
$promise = $client->deleteVoiceConnectorTerminationCredentialsAsync([/* ... */]);

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

Parameter Syntax

$result = $client->deleteVoiceConnectorTerminationCredentials([
    'Usernames' => ['<string>', ...], // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Usernames
Required: Yes
Type: Array of strings

The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceProfile

$result = $client->deleteVoiceProfile([/* ... */]);
$promise = $client->deleteVoiceProfileAsync([/* ... */]);

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

Parameter Syntax

$result = $client->deleteVoiceProfile([
    'VoiceProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceProfileId
Required: Yes
Type: string

The voice profile ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

NotFoundException:

The requested resource couldn't be found.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteVoiceProfileDomain

$result = $client->deleteVoiceProfileDomain([/* ... */]);
$promise = $client->deleteVoiceProfileDomainAsync([/* ... */]);

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

Parameter Syntax

$result = $client->deleteVoiceProfileDomain([
    'VoiceProfileDomainId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceProfileDomainId
Required: Yes
Type: string

The voice profile domain ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DisassociatePhoneNumbersFromVoiceConnector

$result = $client->disassociatePhoneNumbersFromVoiceConnector([/* ... */]);
$promise = $client->disassociatePhoneNumbersFromVoiceConnectorAsync([/* ... */]);

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->disassociatePhoneNumbersFromVoiceConnector([
    'E164PhoneNumbers' => ['<string>', ...], // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
E164PhoneNumbers
Required: Yes
Type: Array of strings

List of phone numbers, in E.164 format.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'PhoneNumberErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist|Gone',
            'ErrorMessage' => '<string>',
            'PhoneNumberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
PhoneNumberErrors
Type: Array of PhoneNumberError structures

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DisassociatePhoneNumbersFromVoiceConnectorGroup

$result = $client->disassociatePhoneNumbersFromVoiceConnectorGroup([/* ... */]);
$promise = $client->disassociatePhoneNumbersFromVoiceConnectorGroupAsync([/* ... */]);

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

Parameter Syntax

$result = $client->disassociatePhoneNumbersFromVoiceConnectorGroup([
    'E164PhoneNumbers' => ['<string>', ...], // REQUIRED
    'VoiceConnectorGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members
E164PhoneNumbers
Required: Yes
Type: Array of strings

The list of phone numbers, in E.164 format.

VoiceConnectorGroupId
Required: Yes
Type: string

The Voice Connector group ID.

Result Syntax

[
    'PhoneNumberErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist|Gone',
            'ErrorMessage' => '<string>',
            'PhoneNumberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
PhoneNumberErrors
Type: Array of PhoneNumberError structures

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetGlobalSettings

$result = $client->getGlobalSettings([/* ... */]);
$promise = $client->getGlobalSettingsAsync([/* ... */]);

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Parameter Syntax

$result = $client->getGlobalSettings([
]);

Parameter Details

Members

Result Syntax

[
    'VoiceConnector' => [
        'CdrBucket' => '<string>',
    ],
]

Result Details

Members
VoiceConnector
Type: VoiceConnectorSettings structure

The Voice Connector settings.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetPhoneNumber

$result = $client->getPhoneNumber([/* ... */]);
$promise = $client->getPhoneNumberAsync([/* ... */]);

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Parameter Syntax

$result = $client->getPhoneNumber([
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members
PhoneNumberId
Required: Yes
Type: string

The phone number ID.

Result Syntax

[
    'PhoneNumber' => [
        'Associations' => [
            [
                'AssociatedTimestamp' => <DateTime>,
                'Name' => 'VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CallingName' => '<string>',
        'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed',
        'Capabilities' => [
            'InboundCall' => true || false,
            'InboundMMS' => true || false,
            'InboundSMS' => true || false,
            'OutboundCall' => true || false,
            'OutboundMMS' => true || false,
            'OutboundSMS' => true || false,
        ],
        'Country' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'DeletionTimestamp' => <DateTime>,
        'E164PhoneNumber' => '<string>',
        'Name' => '<string>',
        'OrderId' => '<string>',
        'PhoneNumberId' => '<string>',
        'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'Cancelled|PortinCancelRequested|PortinInProgress|AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed',
        'Type' => 'Local|TollFree',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
PhoneNumber
Type: PhoneNumber structure

The phone number details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetPhoneNumberOrder

$result = $client->getPhoneNumberOrder([/* ... */]);
$promise = $client->getPhoneNumberOrderAsync([/* ... */]);

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

Parameter Syntax

$result = $client->getPhoneNumberOrder([
    'PhoneNumberOrderId' => '<string>', // REQUIRED
]);

Parameter Details

Members
PhoneNumberOrderId
Required: Yes
Type: string

The ID of the phone number order .

Result Syntax

[
    'PhoneNumberOrder' => [
        'CreatedTimestamp' => <DateTime>,
        'OrderType' => 'New|Porting',
        'OrderedPhoneNumbers' => [
            [
                'E164PhoneNumber' => '<string>',
                'Status' => 'Processing|Acquired|Failed',
            ],
            // ...
        ],
        'PhoneNumberOrderId' => '<string>',
        'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'Processing|Successful|Failed|Partial|PendingDocuments|Submitted|FOC|ChangeRequested|Exception|CancelRequested|Cancelled',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
PhoneNumberOrder
Type: PhoneNumberOrder structure

The phone number order details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetPhoneNumberSettings

$result = $client->getPhoneNumberSettings([/* ... */]);
$promise = $client->getPhoneNumberSettingsAsync([/* ... */]);

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Parameter Syntax

$result = $client->getPhoneNumberSettings([
]);

Parameter Details

Members

Result Syntax

[
    'CallingName' => '<string>',
    'CallingNameUpdatedTimestamp' => <DateTime>,
]

Result Details

Members
CallingName
Type: string

The default outbound calling name for the account.

CallingNameUpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The updated outbound calling name timestamp, in ISO 8601 format.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetProxySession

$result = $client->getProxySession([/* ... */]);
$promise = $client->getProxySessionAsync([/* ... */]);

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->getProxySession([
    'ProxySessionId' => '<string>', // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ProxySessionId
Required: Yes
Type: string

The proxy session ID.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'ProxySession' => [
        'Capabilities' => ['<string>', ...],
        'CreatedTimestamp' => <DateTime>,
        'EndedTimestamp' => <DateTime>,
        'ExpiryMinutes' => <integer>,
        'GeoMatchLevel' => 'Country|AreaCode',
        'GeoMatchParams' => [
            'AreaCode' => '<string>',
            'Country' => '<string>',
        ],
        'Name' => '<string>',
        'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky',
        'Participants' => [
            [
                'PhoneNumber' => '<string>',
                'ProxyPhoneNumber' => '<string>',
            ],
            // ...
        ],
        'ProxySessionId' => '<string>',
        'Status' => 'Open|InProgress|Closed',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorId' => '<string>',
    ],
]

Result Details

Members
ProxySession
Type: ProxySession structure

The proxy session details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetSipMediaApplication

$result = $client->getSipMediaApplication([/* ... */]);
$promise = $client->getSipMediaApplicationAsync([/* ... */]);

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

Parameter Syntax

$result = $client->getSipMediaApplication([
    'SipMediaApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SipMediaApplicationId
Required: Yes
Type: string

The SIP media application ID .

Result Syntax

[
    'SipMediaApplication' => [
        'AwsRegion' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'Endpoints' => [
            [
                'LambdaArn' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'SipMediaApplicationArn' => '<string>',
        'SipMediaApplicationId' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SipMediaApplication
Type: SipMediaApplication structure

The details of the SIP media application.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetSipMediaApplicationAlexaSkillConfiguration

$result = $client->getSipMediaApplicationAlexaSkillConfiguration([/* ... */]);
$promise = $client->getSipMediaApplicationAlexaSkillConfigurationAsync([/* ... */]);

Gets the Alexa Skill configuration for the SIP media application.

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.

Parameter Syntax

$result = $client->getSipMediaApplicationAlexaSkillConfiguration([
    'SipMediaApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SipMediaApplicationId
Required: Yes
Type: string

The SIP media application ID.

Result Syntax

[
    'SipMediaApplicationAlexaSkillConfiguration' => [
        'AlexaSkillIds' => ['<string>', ...],
        'AlexaSkillStatus' => 'ACTIVE|INACTIVE',
    ],
]

Result Details

Members
SipMediaApplicationAlexaSkillConfiguration

Returns the Alexa Skill configuration.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetSipMediaApplicationLoggingConfiguration

$result = $client->getSipMediaApplicationLoggingConfiguration([/* ... */]);
$promise = $client->getSipMediaApplicationLoggingConfigurationAsync([/* ... */]);

Retrieves the logging configuration for the specified SIP media application.

Parameter Syntax

$result = $client->getSipMediaApplicationLoggingConfiguration([
    'SipMediaApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SipMediaApplicationId
Required: Yes
Type: string

The SIP media application ID.

Result Syntax

[
    'SipMediaApplicationLoggingConfiguration' => [
        'EnableSipMediaApplicationMessageLogs' => true || false,
    ],
]

Result Details

Members
SipMediaApplicationLoggingConfiguration

The actual logging configuration.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetSipRule

$result = $client->getSipRule([/* ... */]);
$promise = $client->getSipRuleAsync([/* ... */]);

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Parameter Syntax

$result = $client->getSipRule([
    'SipRuleId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SipRuleId
Required: Yes
Type: string

The SIP rule ID.

Result Syntax

[
    'SipRule' => [
        'CreatedTimestamp' => <DateTime>,
        'Disabled' => true || false,
        'Name' => '<string>',
        'SipRuleId' => '<string>',
        'TargetApplications' => [
            [
                'AwsRegion' => '<string>',
                'Priority' => <integer>,
                'SipMediaApplicationId' => '<string>',
            ],
            // ...
        ],
        'TriggerType' => 'ToPhoneNumber|RequestUriHostname',
        'TriggerValue' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SipRule
Type: SipRule structure

The SIP rule details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetSpeakerSearchTask

$result = $client->getSpeakerSearchTask([/* ... */]);
$promise = $client->getSpeakerSearchTaskAsync([/* ... */]);

Retrieves the details of the specified speaker search task.

Parameter Syntax

$result = $client->getSpeakerSearchTask([
    'SpeakerSearchTaskId' => '<string>', // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SpeakerSearchTaskId
Required: Yes
Type: string

The ID of the speaker search task.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'SpeakerSearchTask' => [
        'CallDetails' => [
            'IsCaller' => true || false,
            'TransactionId' => '<string>',
            'VoiceConnectorId' => '<string>',
        ],
        'CreatedTimestamp' => <DateTime>,
        'SpeakerSearchDetails' => [
            'Results' => [
                [
                    'ConfidenceScore' => <float>,
                    'VoiceProfileId' => '<string>',
                ],
                // ...
            ],
            'VoiceprintGenerationStatus' => '<string>',
        ],
        'SpeakerSearchTaskId' => '<string>',
        'SpeakerSearchTaskStatus' => '<string>',
        'StartedTimestamp' => <DateTime>,
        'StatusMessage' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SpeakerSearchTask
Type: SpeakerSearchTask structure

The details of the speaker search task.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

The requested resource couldn't be found.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

AccessDeniedException:

You don't have the permissions needed to run this action.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ServiceFailureException:

The service encountered an unexpected error.

ServiceUnavailableException:

The service is currently unavailable.

GetVoiceConnector

$result = $client->getVoiceConnector([/* ... */]);
$promise = $client->getVoiceConnectorAsync([/* ... */]);

Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

Parameter Syntax

$result = $client->getVoiceConnector([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'VoiceConnector' => [
        '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',
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'OutboundHostName' => '<string>',
        'RequireEncryption' => true || false,
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorArn' => '<string>',
        'VoiceConnectorId' => '<string>',
    ],
]

Result Details

Members
VoiceConnector
Type: VoiceConnector structure

The Voice Connector details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceConnectorEmergencyCallingConfiguration

$result = $client->getVoiceConnectorEmergencyCallingConfiguration([/* ... */]);
$promise = $client->getVoiceConnectorEmergencyCallingConfigurationAsync([/* ... */]);

Retrieves the emergency calling configuration details for the specified Voice Connector.

Parameter Syntax

$result = $client->getVoiceConnectorEmergencyCallingConfiguration([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'EmergencyCallingConfiguration' => [
        'DNIS' => [
            [
                'CallingCountry' => '<string>',
                'EmergencyPhoneNumber' => '<string>',
                'TestPhoneNumber' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
EmergencyCallingConfiguration

The details of the emergency calling configuration.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceConnectorGroup

$result = $client->getVoiceConnectorGroup([/* ... */]);
$promise = $client->getVoiceConnectorGroupAsync([/* ... */]);

Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

Parameter Syntax

$result = $client->getVoiceConnectorGroup([
    'VoiceConnectorGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorGroupId
Required: Yes
Type: string

The Voice Connector group ID.

Result Syntax

[
    'VoiceConnectorGroup' => [
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorGroupArn' => '<string>',
        'VoiceConnectorGroupId' => '<string>',
        'VoiceConnectorItems' => [
            [
                'Priority' => <integer>,
                'VoiceConnectorId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
VoiceConnectorGroup
Type: VoiceConnectorGroup structure

The details of the Voice Connector group.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceConnectorLoggingConfiguration

$result = $client->getVoiceConnectorLoggingConfiguration([/* ... */]);
$promise = $client->getVoiceConnectorLoggingConfigurationAsync([/* ... */]);

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Parameter Syntax

$result = $client->getVoiceConnectorLoggingConfiguration([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'LoggingConfiguration' => [
        'EnableMediaMetricLogs' => true || false,
        'EnableSIPLogs' => true || false,
    ],
]

Result Details

Members
LoggingConfiguration
Type: LoggingConfiguration structure

The logging configuration details .

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceConnectorOrigination

$result = $client->getVoiceConnectorOrigination([/* ... */]);
$promise = $client->getVoiceConnectorOriginationAsync([/* ... */]);

Retrieves the origination settings for the specified Voice Connector.

Parameter Syntax

$result = $client->getVoiceConnectorOrigination([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'Origination' => [
        'Disabled' => true || false,
        'Routes' => [
            [
                'Host' => '<string>',
                'Port' => <integer>,
                'Priority' => <integer>,
                'Protocol' => 'TCP|UDP',
                'Weight' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members
Origination
Type: Origination structure

The origination setting details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceConnectorProxy

$result = $client->getVoiceConnectorProxy([/* ... */]);
$promise = $client->getVoiceConnectorProxyAsync([/* ... */]);

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->getVoiceConnectorProxy([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'Proxy' => [
        'DefaultSessionExpiryMinutes' => <integer>,
        'Disabled' => true || false,
        'FallBackPhoneNumber' => '<string>',
        'PhoneNumberCountries' => ['<string>', ...],
    ],
]

Result Details

Members
Proxy
Type: Proxy structure

The proxy configuration details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceConnectorStreamingConfiguration

$result = $client->getVoiceConnectorStreamingConfiguration([/* ... */]);
$promise = $client->getVoiceConnectorStreamingConfigurationAsync([/* ... */]);

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Parameter Syntax

$result = $client->getVoiceConnectorStreamingConfiguration([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'StreamingConfiguration' => [
        'DataRetentionInHours' => <integer>,
        'Disabled' => true || false,
        'MediaInsightsConfiguration' => [
            'ConfigurationArn' => '<string>',
            'Disabled' => true || false,
        ],
        'StreamingNotificationTargets' => [
            [
                'NotificationTarget' => 'EventBridge|SNS|SQS',
            ],
            // ...
        ],
    ],
]

Result Details

Members
StreamingConfiguration
Type: StreamingConfiguration structure

The details of the streaming configuration.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceConnectorTermination

$result = $client->getVoiceConnectorTermination([/* ... */]);
$promise = $client->getVoiceConnectorTerminationAsync([/* ... */]);

Retrieves the termination setting details for the specified Voice Connector.

Parameter Syntax

$result = $client->getVoiceConnectorTermination([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'Termination' => [
        'CallingRegions' => ['<string>', ...],
        'CidrAllowedList' => ['<string>', ...],
        'CpsLimit' => <integer>,
        'DefaultPhoneNumber' => '<string>',
        'Disabled' => true || false,
    ],
]

Result Details

Members
Termination
Type: Termination structure

The termination setting details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceConnectorTerminationHealth

$result = $client->getVoiceConnectorTerminationHealth([/* ... */]);
$promise = $client->getVoiceConnectorTerminationHealthAsync([/* ... */]);

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->getVoiceConnectorTerminationHealth([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'TerminationHealth' => [
        'Source' => '<string>',
        'Timestamp' => <DateTime>,
    ],
]

Result Details

Members
TerminationHealth
Type: TerminationHealth structure

The termination health details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceProfile

$result = $client->getVoiceProfile([/* ... */]);
$promise = $client->getVoiceProfileAsync([/* ... */]);

Retrieves the details of the specified voice profile.

Parameter Syntax

$result = $client->getVoiceProfile([
    'VoiceProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceProfileId
Required: Yes
Type: string

The voice profile ID.

Result Syntax

[
    'VoiceProfile' => [
        'CreatedTimestamp' => <DateTime>,
        'ExpirationTimestamp' => <DateTime>,
        'UpdatedTimestamp' => <DateTime>,
        'VoiceProfileArn' => '<string>',
        'VoiceProfileDomainId' => '<string>',
        'VoiceProfileId' => '<string>',
    ],
]

Result Details

Members
VoiceProfile
Type: VoiceProfile structure

The voice profile details.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

NotFoundException:

The requested resource couldn't be found.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceProfileDomain

$result = $client->getVoiceProfileDomain([/* ... */]);
$promise = $client->getVoiceProfileDomainAsync([/* ... */]);

Retrieves the details of the specified voice profile domain.

Parameter Syntax

$result = $client->getVoiceProfileDomain([
    'VoiceProfileDomainId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceProfileDomainId
Required: Yes
Type: string

The voice profile domain ID.

Result Syntax

[
    'VoiceProfileDomain' => [
        'CreatedTimestamp' => <DateTime>,
        'Description' => '<string>',
        'Name' => '<string>',
        'ServerSideEncryptionConfiguration' => [
            'KmsKeyArn' => '<string>',
        ],
        'UpdatedTimestamp' => <DateTime>,
        'VoiceProfileDomainArn' => '<string>',
        'VoiceProfileDomainId' => '<string>',
    ],
]

Result Details

Members
VoiceProfileDomain
Type: VoiceProfileDomain structure

The details of the voice profile domain.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceToneAnalysisTask

$result = $client->getVoiceToneAnalysisTask([/* ... */]);
$promise = $client->getVoiceToneAnalysisTaskAsync([/* ... */]);

Retrieves the details of a voice tone analysis task.

Parameter Syntax

$result = $client->getVoiceToneAnalysisTask([
    'IsCaller' => true || false, // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
    'VoiceToneAnalysisTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
IsCaller
Required: Yes
Type: boolean

Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

VoiceToneAnalysisTaskId
Required: Yes
Type: string

The ID of the voice tone analysis task.

Result Syntax

[
    'VoiceToneAnalysisTask' => [
        'CallDetails' => [
            'IsCaller' => true || false,
            'TransactionId' => '<string>',
            'VoiceConnectorId' => '<string>',
        ],
        'CreatedTimestamp' => <DateTime>,
        'StartedTimestamp' => <DateTime>,
        'StatusMessage' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceToneAnalysisTaskId' => '<string>',
        'VoiceToneAnalysisTaskStatus' => '<string>',
    ],
]

Result Details

Members
VoiceToneAnalysisTask
Type: VoiceToneAnalysisTask structure

The details of the voice tone analysis task.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

The requested resource couldn't be found.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

AccessDeniedException:

You don't have the permissions needed to run this action.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ServiceFailureException:

The service encountered an unexpected error.

ServiceUnavailableException:

The service is currently unavailable.

ListAvailableVoiceConnectorRegions

$result = $client->listAvailableVoiceConnectorRegions([/* ... */]);
$promise = $client->listAvailableVoiceConnectorRegionsAsync([/* ... */]);

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->listAvailableVoiceConnectorRegions([
]);

Parameter Details

Members

Result Syntax

[
    'VoiceConnectorRegions' => ['<string>', ...],
]

Result Details

Members
VoiceConnectorRegions
Type: Array of strings

The list of AWS Regions.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListPhoneNumberOrders

$result = $client->listPhoneNumberOrders([/* ... */]);
$promise = $client->listPhoneNumberOrdersAsync([/* ... */]);

Lists the phone numbers for an administrator's Amazon Chime SDK account.

Parameter Syntax

$result = $client->listPhoneNumberOrders([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

The token used to retrieve the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'PhoneNumberOrders' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'OrderType' => 'New|Porting',
            'OrderedPhoneNumbers' => [
                [
                    'E164PhoneNumber' => '<string>',
                    'Status' => 'Processing|Acquired|Failed',
                ],
                // ...
            ],
            'PhoneNumberOrderId' => '<string>',
            'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
            'Status' => 'Processing|Successful|Failed|Partial|PendingDocuments|Submitted|FOC|ChangeRequested|Exception|CancelRequested|Cancelled',
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token used to retrieve the next page of results.

PhoneNumberOrders
Type: Array of PhoneNumberOrder structures

The phone number order details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListPhoneNumbers

$result = $client->listPhoneNumbers([/* ... */]);
$promise = $client->listPhoneNumbersAsync([/* ... */]);

Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.

Parameter Syntax

$result = $client->listPhoneNumbers([
    'FilterName' => 'VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
    'FilterValue' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
    'Status' => '<string>',
]);

Parameter Details

Members
FilterName
Type: string

The filter to limit the number of results.

FilterValue
Type: string

The filter value.

MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

The token used to return the next page of results.

ProductType
Type: string

The phone number product types.

Status
Type: string

The status of your organization's phone numbers.

Result Syntax

[
    'NextToken' => '<string>',
    'PhoneNumbers' => [
        [
            'Associations' => [
                [
                    'AssociatedTimestamp' => <DateTime>,
                    'Name' => 'VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'CallingName' => '<string>',
            'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed',
            'Capabilities' => [
                'InboundCall' => true || false,
                'InboundMMS' => true || false,
                'InboundSMS' => true || false,
                'OutboundCall' => true || false,
                'OutboundMMS' => true || false,
                'OutboundSMS' => true || false,
            ],
            'Country' => '<string>',
            'CreatedTimestamp' => <DateTime>,
            'DeletionTimestamp' => <DateTime>,
            'E164PhoneNumber' => '<string>',
            'Name' => '<string>',
            'OrderId' => '<string>',
            'PhoneNumberId' => '<string>',
            'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
            'Status' => 'Cancelled|PortinCancelRequested|PortinInProgress|AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed',
            'Type' => 'Local|TollFree',
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token used to return the next page of results.

PhoneNumbers
Type: Array of PhoneNumber structures

The phone number details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

NotFoundException:

The requested resource couldn't be found.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListProxySessions

$result = $client->listProxySessions([/* ... */]);
$promise = $client->listProxySessionsAsync([/* ... */]);

Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->listProxySessions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'Open|InProgress|Closed',
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

The token used to retrieve the next page of results.

Status
Type: string

The proxy session status.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'NextToken' => '<string>',
    'ProxySessions' => [
        [
            'Capabilities' => ['<string>', ...],
            'CreatedTimestamp' => <DateTime>,
            'EndedTimestamp' => <DateTime>,
            'ExpiryMinutes' => <integer>,
            'GeoMatchLevel' => 'Country|AreaCode',
            'GeoMatchParams' => [
                'AreaCode' => '<string>',
                'Country' => '<string>',
            ],
            'Name' => '<string>',
            'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky',
            'Participants' => [
                [
                    'PhoneNumber' => '<string>',
                    'ProxyPhoneNumber' => '<string>',
                ],
                // ...
            ],
            'ProxySessionId' => '<string>',
            'Status' => 'Open|InProgress|Closed',
            'UpdatedTimestamp' => <DateTime>,
            'VoiceConnectorId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token used to retrieve the next page of results.

ProxySessions
Type: Array of ProxySession structures

The proxy sessions' details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListSipMediaApplications

$result = $client->listSipMediaApplications([/* ... */]);
$promise = $client->listSipMediaApplicationsAsync([/* ... */]);

Lists the SIP media applications under the administrator's AWS account.

Parameter Syntax

$result = $client->listSipMediaApplications([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call. Defaults to 100.

NextToken
Type: string

The token used to return the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'SipMediaApplications' => [
        [
            'AwsRegion' => '<string>',
            'CreatedTimestamp' => <DateTime>,
            'Endpoints' => [
                [
                    'LambdaArn' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
            'SipMediaApplicationArn' => '<string>',
            'SipMediaApplicationId' => '<string>',
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token used to return the next page of results.

SipMediaApplications
Type: Array of SipMediaApplication structures

The list of SIP media applications and application details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListSipRules

$result = $client->listSipRules([/* ... */]);
$promise = $client->listSipRulesAsync([/* ... */]);

Lists the SIP rules under the administrator's AWS account.

Parameter Syntax

$result = $client->listSipRules([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SipMediaApplicationId' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call. Defaults to 100.

NextToken
Type: string

The token used to return the next page of results.

SipMediaApplicationId
Type: string

The SIP media application ID.

Result Syntax

[
    'NextToken' => '<string>',
    'SipRules' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'Disabled' => true || false,
            'Name' => '<string>',
            'SipRuleId' => '<string>',
            'TargetApplications' => [
                [
                    'AwsRegion' => '<string>',
                    'Priority' => <integer>,
                    'SipMediaApplicationId' => '<string>',
                ],
                // ...
            ],
            'TriggerType' => 'ToPhoneNumber|RequestUriHostname',
            'TriggerValue' => '<string>',
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token used to return the next page of results.

SipRules
Type: Array of SipRule structures

The list of SIP rules and details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListSupportedPhoneNumberCountries

$result = $client->listSupportedPhoneNumberCountries([/* ... */]);
$promise = $client->listSupportedPhoneNumberCountriesAsync([/* ... */]);

Lists the countries that you can order phone numbers from.

Parameter Syntax

$result = $client->listSupportedPhoneNumberCountries([
    'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn', // REQUIRED
]);

Parameter Details

Members
ProductType
Required: Yes
Type: string

The phone number product type.

Result Syntax

[
    'PhoneNumberCountries' => [
        [
            'CountryCode' => '<string>',
            'SupportedPhoneNumberTypes' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
PhoneNumberCountries
Type: Array of PhoneNumberCountry structures

The supported phone number countries.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of the tags in a given resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The resource ARN.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

The tags in the list.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

The requested resource couldn't be found.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListVoiceConnectorGroups

$result = $client->listVoiceConnectorGroups([/* ... */]);
$promise = $client->listVoiceConnectorGroupsAsync([/* ... */]);

Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.

Parameter Syntax

$result = $client->listVoiceConnectorGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

The token used to return the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'VoiceConnectorGroups' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'Name' => '<string>',
            'UpdatedTimestamp' => <DateTime>,
            'VoiceConnectorGroupArn' => '<string>',
            'VoiceConnectorGroupId' => '<string>',
            'VoiceConnectorItems' => [
                [
                    'Priority' => <integer>,
                    'VoiceConnectorId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token used to return the next page of results.

VoiceConnectorGroups
Type: Array of VoiceConnectorGroup structures

The details of the Voice Connector groups.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListVoiceConnectorTerminationCredentials

$result = $client->listVoiceConnectorTerminationCredentials([/* ... */]);
$promise = $client->listVoiceConnectorTerminationCredentialsAsync([/* ... */]);

Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->listVoiceConnectorTerminationCredentials([
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'Usernames' => ['<string>', ...],
]

Result Details

Members
Usernames
Type: Array of strings

A list of user names.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListVoiceConnectors

$result = $client->listVoiceConnectors([/* ... */]);
$promise = $client->listVoiceConnectorsAsync([/* ... */]);

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

Parameter Syntax

$result = $client->listVoiceConnectors([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

The token used to return the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'VoiceConnectors' => [
        [
            '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',
            'CreatedTimestamp' => <DateTime>,
            'Name' => '<string>',
            'OutboundHostName' => '<string>',
            'RequireEncryption' => true || false,
            'UpdatedTimestamp' => <DateTime>,
            'VoiceConnectorArn' => '<string>',
            'VoiceConnectorId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token used to return the next page of results.

VoiceConnectors
Type: Array of VoiceConnector structures

The details of the Voice Connectors.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListVoiceProfileDomains

$result = $client->listVoiceProfileDomains([/* ... */]);
$promise = $client->listVoiceProfileDomainsAsync([/* ... */]);

Lists the specified voice profile domains in the administrator's AWS account.

Parameter Syntax

$result = $client->listVoiceProfileDomains([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

The token used to return the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'VoiceProfileDomains' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'Description' => '<string>',
            'Name' => '<string>',
            'UpdatedTimestamp' => <DateTime>,
            'VoiceProfileDomainArn' => '<string>',
            'VoiceProfileDomainId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token used to return the next page of results.

VoiceProfileDomains
Type: Array of VoiceProfileDomainSummary structures

The list of voice profile domains.

Errors

NotFoundException:

The requested resource couldn't be found.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListVoiceProfiles

$result = $client->listVoiceProfiles([/* ... */]);
$promise = $client->listVoiceProfilesAsync([/* ... */]);

Lists the voice profiles in a voice profile domain.

Parameter Syntax

$result = $client->listVoiceProfiles([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'VoiceProfileDomainId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results in the request.

NextToken
Type: string

The token used to retrieve the next page of results.

VoiceProfileDomainId
Required: Yes
Type: string

The ID of the voice profile domain.

Result Syntax

[
    'NextToken' => '<string>',
    'VoiceProfiles' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'ExpirationTimestamp' => <DateTime>,
            'UpdatedTimestamp' => <DateTime>,
            'VoiceProfileArn' => '<string>',
            'VoiceProfileDomainId' => '<string>',
            'VoiceProfileId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The token used to retrieve the next page of results.

VoiceProfiles
Type: Array of VoiceProfileSummary structures

The list of voice profiles.

Errors

NotFoundException:

The requested resource couldn't be found.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutSipMediaApplicationAlexaSkillConfiguration

$result = $client->putSipMediaApplicationAlexaSkillConfiguration([/* ... */]);
$promise = $client->putSipMediaApplicationAlexaSkillConfigurationAsync([/* ... */]);

Updates the Alexa Skill configuration for the SIP media application.

Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.

Parameter Syntax

$result = $client->putSipMediaApplicationAlexaSkillConfiguration([
    'SipMediaApplicationAlexaSkillConfiguration' => [
        'AlexaSkillIds' => ['<string>', ...], // REQUIRED
        'AlexaSkillStatus' => 'ACTIVE|INACTIVE', // REQUIRED
    ],
    'SipMediaApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SipMediaApplicationAlexaSkillConfiguration

The Alexa Skill configuration.

SipMediaApplicationId
Required: Yes
Type: string

The SIP media application ID.

Result Syntax

[
    'SipMediaApplicationAlexaSkillConfiguration' => [
        'AlexaSkillIds' => ['<string>', ...],
        'AlexaSkillStatus' => 'ACTIVE|INACTIVE',
    ],
]

Result Details

Members
SipMediaApplicationAlexaSkillConfiguration

Returns the Alexa Skill configuration.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutSipMediaApplicationLoggingConfiguration

$result = $client->putSipMediaApplicationLoggingConfiguration([/* ... */]);
$promise = $client->putSipMediaApplicationLoggingConfigurationAsync([/* ... */]);

Updates the logging configuration for the specified SIP media application.

Parameter Syntax

$result = $client->putSipMediaApplicationLoggingConfiguration([
    'SipMediaApplicationId' => '<string>', // REQUIRED
    'SipMediaApplicationLoggingConfiguration' => [
        'EnableSipMediaApplicationMessageLogs' => true || false,
    ],
]);

Parameter Details

Members
SipMediaApplicationId
Required: Yes
Type: string

The SIP media application ID.

SipMediaApplicationLoggingConfiguration

The logging configuration for the specified SIP media application.

Result Syntax

[
    'SipMediaApplicationLoggingConfiguration' => [
        'EnableSipMediaApplicationMessageLogs' => true || false,
    ],
]

Result Details

Members
SipMediaApplicationLoggingConfiguration

The updated logging configuration for the specified SIP media application.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutVoiceConnectorEmergencyCallingConfiguration

$result = $client->putVoiceConnectorEmergencyCallingConfiguration([/* ... */]);
$promise = $client->putVoiceConnectorEmergencyCallingConfigurationAsync([/* ... */]);

Updates a Voice Connector's emergency calling configuration.

Parameter Syntax

$result = $client->putVoiceConnectorEmergencyCallingConfiguration([
    'EmergencyCallingConfiguration' => [ // REQUIRED
        'DNIS' => [
            [
                'CallingCountry' => '<string>', // REQUIRED
                'EmergencyPhoneNumber' => '<string>', // REQUIRED
                'TestPhoneNumber' => '<string>',
            ],
            // ...
        ],
    ],
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
EmergencyCallingConfiguration
Required: Yes
Type: EmergencyCallingConfiguration structure

The configuration being updated.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'EmergencyCallingConfiguration' => [
        'DNIS' => [
            [
                'CallingCountry' => '<string>',
                'EmergencyPhoneNumber' => '<string>',
                'TestPhoneNumber' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
EmergencyCallingConfiguration

The updated configuration.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutVoiceConnectorLoggingConfiguration

$result = $client->putVoiceConnectorLoggingConfiguration([/* ... */]);
$promise = $client->putVoiceConnectorLoggingConfigurationAsync([/* ... */]);

Updates a Voice Connector's logging configuration.

Parameter Syntax

$result = $client->putVoiceConnectorLoggingConfiguration([
    'LoggingConfiguration' => [ // REQUIRED
        'EnableMediaMetricLogs' => true || false,
        'EnableSIPLogs' => true || false,
    ],
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
LoggingConfiguration
Required: Yes
Type: LoggingConfiguration structure

The logging configuration being updated.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'LoggingConfiguration' => [
        'EnableMediaMetricLogs' => true || false,
        'EnableSIPLogs' => true || false,
    ],
]

Result Details

Members
LoggingConfiguration
Type: LoggingConfiguration structure

The updated logging configuration.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutVoiceConnectorOrigination

$result = $client->putVoiceConnectorOrigination([/* ... */]);
$promise = $client->putVoiceConnectorOriginationAsync([/* ... */]);

Updates a Voice Connector's origination settings.

Parameter Syntax

$result = $client->putVoiceConnectorOrigination([
    'Origination' => [ // REQUIRED
        'Disabled' => true || false,
        'Routes' => [
            [
                'Host' => '<string>',
                'Port' => <integer>,
                'Priority' => <integer>,
                'Protocol' => 'TCP|UDP',
                'Weight' => <integer>,
            ],
            // ...
        ],
    ],
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Origination
Required: Yes
Type: Origination structure

The origination settings being updated.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'Origination' => [
        'Disabled' => true || false,
        'Routes' => [
            [
                'Host' => '<string>',
                'Port' => <integer>,
                'Priority' => <integer>,
                'Protocol' => 'TCP|UDP',
                'Weight' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members
Origination
Type: Origination structure

The updated origination settings.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutVoiceConnectorProxy

$result = $client->putVoiceConnectorProxy([/* ... */]);
$promise = $client->putVoiceConnectorProxyAsync([/* ... */]);

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->putVoiceConnectorProxy([
    'DefaultSessionExpiryMinutes' => <integer>, // REQUIRED
    'Disabled' => true || false,
    'FallBackPhoneNumber' => '<string>',
    'PhoneNumberPoolCountries' => ['<string>', ...], // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DefaultSessionExpiryMinutes
Required: Yes
Type: int

The default number of minutes allowed for proxy session.

Disabled
Type: boolean

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

FallBackPhoneNumber
Type: string

The phone number to route calls to after a proxy session expires.

PhoneNumberPoolCountries
Required: Yes
Type: Array of strings

The countries for proxy phone numbers to be selected from.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'Proxy' => [
        'DefaultSessionExpiryMinutes' => <integer>,
        'Disabled' => true || false,
        'FallBackPhoneNumber' => '<string>',
        'PhoneNumberCountries' => ['<string>', ...],
    ],
]

Result Details

Members
Proxy
Type: Proxy structure

The proxy configuration details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

AccessDeniedException:

You don't have the permissions needed to run this action.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutVoiceConnectorStreamingConfiguration

$result = $client->putVoiceConnectorStreamingConfiguration([/* ... */]);
$promise = $client->putVoiceConnectorStreamingConfigurationAsync([/* ... */]);

Updates a Voice Connector's streaming configuration settings.

Parameter Syntax

$result = $client->putVoiceConnectorStreamingConfiguration([
    'StreamingConfiguration' => [ // REQUIRED
        'DataRetentionInHours' => <integer>, // REQUIRED
        'Disabled' => true || false, // REQUIRED
        'MediaInsightsConfiguration' => [
            'ConfigurationArn' => '<string>',
            'Disabled' => true || false,
        ],
        'StreamingNotificationTargets' => [
            [
                'NotificationTarget' => 'EventBridge|SNS|SQS',
            ],
            // ...
        ],
    ],
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
StreamingConfiguration
Required: Yes
Type: StreamingConfiguration structure

The streaming settings being updated.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'StreamingConfiguration' => [
        'DataRetentionInHours' => <integer>,
        'Disabled' => true || false,
        'MediaInsightsConfiguration' => [
            'ConfigurationArn' => '<string>',
            'Disabled' => true || false,
        ],
        'StreamingNotificationTargets' => [
            [
                'NotificationTarget' => 'EventBridge|SNS|SQS',
            ],
            // ...
        ],
    ],
]

Result Details

Members
StreamingConfiguration
Type: StreamingConfiguration structure

The updated streaming settings.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutVoiceConnectorTermination

$result = $client->putVoiceConnectorTermination([/* ... */]);
$promise = $client->putVoiceConnectorTerminationAsync([/* ... */]);

Updates a Voice Connector's termination settings.

Parameter Syntax

$result = $client->putVoiceConnectorTermination([
    'Termination' => [ // REQUIRED
        'CallingRegions' => ['<string>', ...],
        'CidrAllowedList' => ['<string>', ...],
        'CpsLimit' => <integer>,
        'DefaultPhoneNumber' => '<string>',
        'Disabled' => true || false,
    ],
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Termination
Required: Yes
Type: Termination structure

The termination settings to be updated.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'Termination' => [
        'CallingRegions' => ['<string>', ...],
        'CidrAllowedList' => ['<string>', ...],
        'CpsLimit' => <integer>,
        'DefaultPhoneNumber' => '<string>',
        'Disabled' => true || false,
    ],
]

Result Details

Members
Termination
Type: Termination structure

The updated termination settings.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

AccessDeniedException:

You don't have the permissions needed to run this action.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutVoiceConnectorTerminationCredentials

$result = $client->putVoiceConnectorTerminationCredentials([/* ... */]);
$promise = $client->putVoiceConnectorTerminationCredentialsAsync([/* ... */]);

Updates a Voice Connector's termination credentials.

Parameter Syntax

$result = $client->putVoiceConnectorTerminationCredentials([
    'Credentials' => [
        [
            'Password' => '<string>',
            'Username' => '<string>',
        ],
        // ...
    ],
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Credentials
Type: Array of Credential structures

The termination credentials being updated.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

RestorePhoneNumber

$result = $client->restorePhoneNumber([/* ... */]);
$promise = $client->restorePhoneNumberAsync([/* ... */]);

Restores a deleted phone number.

Parameter Syntax

$result = $client->restorePhoneNumber([
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members
PhoneNumberId
Required: Yes
Type: string

The ID of the phone number being restored.

Result Syntax

[
    'PhoneNumber' => [
        'Associations' => [
            [
                'AssociatedTimestamp' => <DateTime>,
                'Name' => 'VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CallingName' => '<string>',
        'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed',
        'Capabilities' => [
            'InboundCall' => true || false,
            'InboundMMS' => true || false,
            'InboundSMS' => true || false,
            'OutboundCall' => true || false,
            'OutboundMMS' => true || false,
            'OutboundSMS' => true || false,
        ],
        'Country' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'DeletionTimestamp' => <DateTime>,
        'E164PhoneNumber' => '<string>',
        'Name' => '<string>',
        'OrderId' => '<string>',
        'PhoneNumberId' => '<string>',
        'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'Cancelled|PortinCancelRequested|PortinInProgress|AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed',
        'Type' => 'Local|TollFree',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
PhoneNumber
Type: PhoneNumber structure

The restored phone number.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

SearchAvailablePhoneNumbers

$result = $client->searchAvailablePhoneNumbers([/* ... */]);
$promise = $client->searchAvailablePhoneNumbersAsync([/* ... */]);

Searches the provisioned phone numbers in an organization.

Parameter Syntax

$result = $client->searchAvailablePhoneNumbers([
    'AreaCode' => '<string>',
    'City' => '<string>',
    'Country' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PhoneNumberType' => 'Local|TollFree',
    'State' => '<string>',
    'TollFreePrefix' => '<string>',
]);

Parameter Details

Members
AreaCode
Type: string

Confines a search to just the phone numbers associated with the specified area code.

City
Type: string

Confines a search to just the phone numbers associated with the specified city.

Country
Type: string

Confines a search to just the phone numbers associated with the specified country.

MaxResults
Type: int

The maximum number of results to return.

NextToken
Type: string

The token used to return the next page of results.

PhoneNumberType
Type: string

Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

State
Type: string

Confines a search to just the phone numbers associated with the specified state.

TollFreePrefix
Type: string

Confines a search to just the phone numbers associated with the specified toll-free prefix.

Result Syntax

[
    'E164PhoneNumbers' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
E164PhoneNumbers
Type: Array of strings

Confines a search to just the phone numbers in the E.164 format.

NextToken
Type: string

The token used to return the next page of results.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

StartSpeakerSearchTask

$result = $client->startSpeakerSearchTask([/* ... */]);
$promise = $client->startSpeakerSearchTaskAsync([/* ... */]);

Starts a speaker search task.

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

Parameter Syntax

$result = $client->startSpeakerSearchTask([
    'CallLeg' => 'Caller|Callee',
    'ClientRequestToken' => '<string>',
    'TransactionId' => '<string>', // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
    'VoiceProfileDomainId' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallLeg
Type: string

Specifies which call leg to stream for speaker search.

ClientRequestToken
Type: string

The unique identifier for the client request. Use a different token for different speaker search tasks.

TransactionId
Required: Yes
Type: string

The transaction ID of the call being analyzed.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

VoiceProfileDomainId
Required: Yes
Type: string

The ID of the voice profile domain that will store the voice profile.

Result Syntax

[
    'SpeakerSearchTask' => [
        'CallDetails' => [
            'IsCaller' => true || false,
            'TransactionId' => '<string>',
            'VoiceConnectorId' => '<string>',
        ],
        'CreatedTimestamp' => <DateTime>,
        'SpeakerSearchDetails' => [
            'Results' => [
                [
                    'ConfidenceScore' => <float>,
                    'VoiceProfileId' => '<string>',
                ],
                // ...
            ],
            'VoiceprintGenerationStatus' => '<string>',
        ],
        'SpeakerSearchTaskId' => '<string>',
        'SpeakerSearchTaskStatus' => '<string>',
        'StartedTimestamp' => <DateTime>,
        'StatusMessage' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SpeakerSearchTask
Type: SpeakerSearchTask structure

The details of the speaker search task.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ResourceLimitExceededException:

The request exceeds the resource limit.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

NotFoundException:

The requested resource couldn't be found.

ConflictException:

Multiple instances of the same request were made simultaneously.

GoneException:

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

UnprocessableEntityException:

A well-formed request couldn't be followed due to semantic errors.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

StartVoiceToneAnalysisTask

$result = $client->startVoiceToneAnalysisTask([/* ... */]);
$promise = $client->startVoiceToneAnalysisTaskAsync([/* ... */]);

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

Parameter Syntax

$result = $client->startVoiceToneAnalysisTask([
    'ClientRequestToken' => '<string>',
    'LanguageCode' => 'en-US', // REQUIRED
    'TransactionId' => '<string>', // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

LanguageCode
Required: Yes
Type: string

The language code.

TransactionId
Required: Yes
Type: string

The transaction ID.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'VoiceToneAnalysisTask' => [
        'CallDetails' => [
            'IsCaller' => true || false,
            'TransactionId' => '<string>',
            'VoiceConnectorId' => '<string>',
        ],
        'CreatedTimestamp' => <DateTime>,
        'StartedTimestamp' => <DateTime>,
        'StatusMessage' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceToneAnalysisTaskId' => '<string>',
        'VoiceToneAnalysisTaskStatus' => '<string>',
    ],
]

Result Details

Members
VoiceToneAnalysisTask
Type: VoiceToneAnalysisTask structure

The details of the voice tone analysis task.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ResourceLimitExceededException:

The request exceeds the resource limit.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

NotFoundException:

The requested resource couldn't be found.

ConflictException:

Multiple instances of the same request were made simultaneously.

GoneException:

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

UnprocessableEntityException:

A well-formed request couldn't be followed due to semantic errors.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

StopSpeakerSearchTask

$result = $client->stopSpeakerSearchTask([/* ... */]);
$promise = $client->stopSpeakerSearchTaskAsync([/* ... */]);

Stops a speaker search task.

Parameter Syntax

$result = $client->stopSpeakerSearchTask([
    'SpeakerSearchTaskId' => '<string>', // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SpeakerSearchTaskId
Required: Yes
Type: string

The speaker search task ID.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

NotFoundException:

The requested resource couldn't be found.

ConflictException:

Multiple instances of the same request were made simultaneously.

UnprocessableEntityException:

A well-formed request couldn't be followed due to semantic errors.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

StopVoiceToneAnalysisTask

$result = $client->stopVoiceToneAnalysisTask([/* ... */]);
$promise = $client->stopVoiceToneAnalysisTaskAsync([/* ... */]);

Stops a voice tone analysis task.

Parameter Syntax

$result = $client->stopVoiceToneAnalysisTask([
    'VoiceConnectorId' => '<string>', // REQUIRED
    'VoiceToneAnalysisTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

VoiceToneAnalysisTaskId
Required: Yes
Type: string

The ID of the voice tone analysis task.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

NotFoundException:

The requested resource couldn't be found.

ConflictException:

Multiple instances of the same request were made simultaneously.

UnprocessableEntityException:

A well-formed request couldn't be followed due to semantic errors.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds a tag to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the resource being tagged.

Tags
Required: Yes
Type: Array of Tag structures

A list of the tags being added to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

The requested resource couldn't be found.

ResourceLimitExceededException:

The request exceeds the resource limit.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the resource having its tags removed.

TagKeys
Required: Yes
Type: Array of strings

The keys of the tags being removed from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

The requested resource couldn't be found.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateGlobalSettings

$result = $client->updateGlobalSettings([/* ... */]);
$promise = $client->updateGlobalSettingsAsync([/* ... */]);

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Parameter Syntax

$result = $client->updateGlobalSettings([
    'VoiceConnector' => [
        'CdrBucket' => '<string>',
    ],
]);

Parameter Details

Members
VoiceConnector
Type: VoiceConnectorSettings structure

The Voice Connector settings.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdatePhoneNumber

$result = $client->updatePhoneNumber([/* ... */]);
$promise = $client->updatePhoneNumberAsync([/* ... */]);

Updates phone number details, such as product type, calling name, or phone number name for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type, calling name, or phone number name in one action.

For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Parameter Syntax

$result = $client->updatePhoneNumber([
    'CallingName' => '<string>',
    'Name' => '<string>',
    'PhoneNumberId' => '<string>', // REQUIRED
    'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
]);

Parameter Details

Members
CallingName
Type: string

The outbound calling name associated with the phone number.

Name
Type: string

Specifies the updated name assigned to one or more phone numbers.

PhoneNumberId
Required: Yes
Type: string

The phone number ID.

ProductType
Type: string

The product type.

Result Syntax

[
    'PhoneNumber' => [
        'Associations' => [
            [
                'AssociatedTimestamp' => <DateTime>,
                'Name' => 'VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CallingName' => '<string>',
        'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed',
        'Capabilities' => [
            'InboundCall' => true || false,
            'InboundMMS' => true || false,
            'InboundSMS' => true || false,
            'OutboundCall' => true || false,
            'OutboundMMS' => true || false,
            'OutboundSMS' => true || false,
        ],
        'Country' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'DeletionTimestamp' => <DateTime>,
        'E164PhoneNumber' => '<string>',
        'Name' => '<string>',
        'OrderId' => '<string>',
        'PhoneNumberId' => '<string>',
        'ProductType' => 'VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'Cancelled|PortinCancelRequested|PortinInProgress|AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed',
        'Type' => 'Local|TollFree',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
PhoneNumber
Type: PhoneNumber structure

The updated phone number details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ConflictException:

Multiple instances of the same request were made simultaneously.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdatePhoneNumberSettings

$result = $client->updatePhoneNumberSettings([/* ... */]);
$promise = $client->updatePhoneNumberSettingsAsync([/* ... */]);

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

Parameter Syntax

$result = $client->updatePhoneNumberSettings([
    'CallingName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallingName
Required: Yes
Type: string

The default outbound calling name for the account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateProxySession

$result = $client->updateProxySession([/* ... */]);
$promise = $client->updateProxySessionAsync([/* ... */]);

Updates the specified proxy session details, such as voice or SMS capabilities.

Parameter Syntax

$result = $client->updateProxySession([
    'Capabilities' => ['<string>', ...], // REQUIRED
    'ExpiryMinutes' => <integer>,
    'ProxySessionId' => '<string>', // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Capabilities
Required: Yes
Type: Array of strings

The proxy session capabilities.

ExpiryMinutes
Type: int

The number of minutes allowed for the proxy session.

ProxySessionId
Required: Yes
Type: string

The proxy session ID.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'ProxySession' => [
        'Capabilities' => ['<string>', ...],
        'CreatedTimestamp' => <DateTime>,
        'EndedTimestamp' => <DateTime>,
        'ExpiryMinutes' => <integer>,
        'GeoMatchLevel' => 'Country|AreaCode',
        'GeoMatchParams' => [
            'AreaCode' => '<string>',
            'Country' => '<string>',
        ],
        'Name' => '<string>',
        'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky',
        'Participants' => [
            [
                'PhoneNumber' => '<string>',
                'ProxyPhoneNumber' => '<string>',
            ],
            // ...
        ],
        'ProxySessionId' => '<string>',
        'Status' => 'Open|InProgress|Closed',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorId' => '<string>',
    ],
]

Result Details

Members
ProxySession
Type: ProxySession structure

The updated proxy session details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateSipMediaApplication

$result = $client->updateSipMediaApplication([/* ... */]);
$promise = $client->updateSipMediaApplicationAsync([/* ... */]);

Updates the details of the specified SIP media application.

Parameter Syntax

$result = $client->updateSipMediaApplication([
    'Endpoints' => [
        [
            'LambdaArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
    'SipMediaApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Endpoints
Type: Array of SipMediaApplicationEndpoint structures

The new set of endpoints for the specified SIP media application.

Name
Type: string

The new name for the specified SIP media application.

SipMediaApplicationId
Required: Yes
Type: string

The SIP media application ID.

Result Syntax

[
    'SipMediaApplication' => [
        'AwsRegion' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'Endpoints' => [
            [
                'LambdaArn' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'SipMediaApplicationArn' => '<string>',
        'SipMediaApplicationId' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SipMediaApplication
Type: SipMediaApplication structure

The updated SIP media application’s details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateSipMediaApplicationCall

$result = $client->updateSipMediaApplicationCall([/* ... */]);
$promise = $client->updateSipMediaApplicationCallAsync([/* ... */]);

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

Parameter Syntax

$result = $client->updateSipMediaApplicationCall([
    'Arguments' => ['<string>', ...], // REQUIRED
    'SipMediaApplicationId' => '<string>', // REQUIRED
    'TransactionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Arguments
Required: Yes
Type: Associative array of custom strings keys (SensitiveString) to strings

Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

SipMediaApplicationId
Required: Yes
Type: string

The ID of the SIP media application handling the call.

TransactionId
Required: Yes
Type: string

The ID of the call transaction.

Result Syntax

[
    'SipMediaApplicationCall' => [
        'TransactionId' => '<string>',
    ],
]

Result Details

Members
SipMediaApplicationCall
Type: SipMediaApplicationCall structure

A Call instance for a SIP media application.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateSipRule

$result = $client->updateSipRule([/* ... */]);
$promise = $client->updateSipRuleAsync([/* ... */]);

Updates the details of the specified SIP rule.

Parameter Syntax

$result = $client->updateSipRule([
    'Disabled' => true || false,
    'Name' => '<string>', // REQUIRED
    'SipRuleId' => '<string>', // REQUIRED
    'TargetApplications' => [
        [
            'AwsRegion' => '<string>',
            'Priority' => <integer>,
            'SipMediaApplicationId' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
Disabled
Type: boolean

The new value that indicates whether the rule is disabled.

Name
Required: Yes
Type: string

The new name for the specified SIP rule.

SipRuleId
Required: Yes
Type: string

The SIP rule ID.

TargetApplications
Type: Array of SipRuleTargetApplication structures

The new list of target applications.

Result Syntax

[
    'SipRule' => [
        'CreatedTimestamp' => <DateTime>,
        'Disabled' => true || false,
        'Name' => '<string>',
        'SipRuleId' => '<string>',
        'TargetApplications' => [
            [
                'AwsRegion' => '<string>',
                'Priority' => <integer>,
                'SipMediaApplicationId' => '<string>',
            ],
            // ...
        ],
        'TriggerType' => 'ToPhoneNumber|RequestUriHostname',
        'TriggerValue' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SipRule
Type: SipRule structure

The updated SIP rule details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateVoiceConnector

$result = $client->updateVoiceConnector([/* ... */]);
$promise = $client->updateVoiceConnectorAsync([/* ... */]);

Updates the details for the specified Amazon Chime SDK Voice Connector.

Parameter Syntax

$result = $client->updateVoiceConnector([
    'Name' => '<string>', // REQUIRED
    'RequireEncryption' => true || false, // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the Voice Connector.

RequireEncryption
Required: Yes
Type: boolean

When enabled, requires encryption for the Voice Connector.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

Result Syntax

[
    'VoiceConnector' => [
        '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',
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'OutboundHostName' => '<string>',
        'RequireEncryption' => true || false,
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorArn' => '<string>',
        'VoiceConnectorId' => '<string>',
    ],
]

Result Details

Members
VoiceConnector
Type: VoiceConnector structure

The updated Voice Connector details.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateVoiceConnectorGroup

$result = $client->updateVoiceConnectorGroup([/* ... */]);
$promise = $client->updateVoiceConnectorGroupAsync([/* ... */]);

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

Parameter Syntax

$result = $client->updateVoiceConnectorGroup([
    'Name' => '<string>', // REQUIRED
    'VoiceConnectorGroupId' => '<string>', // REQUIRED
    'VoiceConnectorItems' => [ // REQUIRED
        [
            'Priority' => <integer>, // REQUIRED
            'VoiceConnectorId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Name
Required: Yes
Type: string

The name of the Voice Connector group.

VoiceConnectorGroupId
Required: Yes
Type: string

The Voice Connector ID.

VoiceConnectorItems
Required: Yes
Type: Array of VoiceConnectorItem structures

The VoiceConnectorItems to associate with the Voice Connector group.

Result Syntax

[
    'VoiceConnectorGroup' => [
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorGroupArn' => '<string>',
        'VoiceConnectorGroupId' => '<string>',
        'VoiceConnectorItems' => [
            [
                'Priority' => <integer>,
                'VoiceConnectorId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
VoiceConnectorGroup
Type: VoiceConnectorGroup structure

The updated Voice Connector group.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ConflictException:

Multiple instances of the same request were made simultaneously.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateVoiceProfile

$result = $client->updateVoiceProfile([/* ... */]);
$promise = $client->updateVoiceProfileAsync([/* ... */]);

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws.

You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

Parameter Syntax

$result = $client->updateVoiceProfile([
    'SpeakerSearchTaskId' => '<string>', // REQUIRED
    'VoiceProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SpeakerSearchTaskId
Required: Yes
Type: string

The ID of the speaker search task.

VoiceProfileId
Required: Yes
Type: string

The profile ID.

Result Syntax

[
    'VoiceProfile' => [
        'CreatedTimestamp' => <DateTime>,
        'ExpirationTimestamp' => <DateTime>,
        'UpdatedTimestamp' => <DateTime>,
        'VoiceProfileArn' => '<string>',
        'VoiceProfileDomainId' => '<string>',
        'VoiceProfileId' => '<string>',
    ],
]

Result Details

Members
VoiceProfile
Type: VoiceProfile structure

The updated voice profile settings.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client isn't authorized to request a resource.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

NotFoundException:

The requested resource couldn't be found.

ConflictException:

Multiple instances of the same request were made simultaneously.

GoneException:

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateVoiceProfileDomain

$result = $client->updateVoiceProfileDomain([/* ... */]);
$promise = $client->updateVoiceProfileDomainAsync([/* ... */]);

Updates the settings for the specified voice profile domain.

Parameter Syntax

$result = $client->updateVoiceProfileDomain([
    'Description' => '<string>',
    'Name' => '<string>',
    'VoiceProfileDomainId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
Type: string

The description of the voice profile domain.

Name
Type: string

The name of the voice profile domain.

VoiceProfileDomainId
Required: Yes
Type: string

The domain ID.

Result Syntax

[
    'VoiceProfileDomain' => [
        'CreatedTimestamp' => <DateTime>,
        'Description' => '<string>',
        'Name' => '<string>',
        'ServerSideEncryptionConfiguration' => [
            'KmsKeyArn' => '<string>',
        ],
        'UpdatedTimestamp' => <DateTime>,
        'VoiceProfileDomainArn' => '<string>',
        'VoiceProfileDomainId' => '<string>',
    ],
]

Result Details

Members
VoiceProfileDomain
Type: VoiceProfileDomain structure

The updated details of the voice profile domain.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have the permissions needed to run this action.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ValidateE911Address

$result = $client->validateE911Address([/* ... */]);
$promise = $client->validateE911AddressAsync([/* ... */]);

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

Parameter Syntax

$result = $client->validateE911Address([
    'AwsAccountId' => '<string>', // REQUIRED
    'City' => '<string>', // REQUIRED
    'Country' => '<string>', // REQUIRED
    'PostalCode' => '<string>', // REQUIRED
    'State' => '<string>', // REQUIRED
    'StreetInfo' => '<string>', // REQUIRED
    'StreetNumber' => '<string>', // REQUIRED
]);

Parameter Details

Members
AwsAccountId
Required: Yes
Type: string

The AWS account ID.

City
Required: Yes
Type: string

The address city, such as Portland.

Country
Required: Yes
Type: string

The country in the address being validated as two-letter country code in ISO 3166-1 alpha-2 format, such as US. For more information, see ISO 3166-1 alpha-2 in Wikipedia.

PostalCode
Required: Yes
Type: string

The dress postal code, such 04352.

State
Required: Yes
Type: string

The address state, such as ME.

StreetInfo
Required: Yes
Type: string

The address street information, such as 8th Avenue.

StreetNumber
Required: Yes
Type: string

The address street number, such as 200 or 2121.

Result Syntax

[
    'Address' => [
        'city' => '<string>',
        'country' => '<string>',
        'postDirectional' => '<string>',
        'postalCode' => '<string>',
        'postalCodePlus4' => '<string>',
        'preDirectional' => '<string>',
        'state' => '<string>',
        'streetName' => '<string>',
        'streetNumber' => '<string>',
        'streetSuffix' => '<string>',
    ],
    'AddressExternalId' => '<string>',
    'CandidateAddressList' => [
        [
            'city' => '<string>',
            'country' => '<string>',
            'postalCode' => '<string>',
            'postalCodePlus4' => '<string>',
            'state' => '<string>',
            'streetInfo' => '<string>',
            'streetNumber' => '<string>',
        ],
        // ...
    ],
    'ValidationResult' => <integer>,
]

Result Details

Members
Address
Type: Address structure

The validated address.

AddressExternalId
Type: string

The ID that represents the address.

CandidateAddressList
Type: Array of CandidateAddress structures

The list of address suggestions..

ValidationResult
Type: int

Number indicating the result of address validation.

Each possible result is defined as follows:

  • 0 - Address validation succeeded.

  • 1 - Address validation succeeded. The address was a close enough match and has been corrected as part of the address object.

  • 2 - Address validation failed. You should re-submit the validation request with candidates from the CandidateAddressList result, if it's a close match.

Errors

UnauthorizedClientException:

The client isn't authorized to request a resource.

NotFoundException:

The requested resource couldn't be found.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The number of customer requests exceeds the request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

Shapes

AccessDeniedException

Description

You don't have the permissions needed to run this action.

Members

Address

Description

A validated address.

Members
city
Type: string

The city of an address.

country
Type: string

The country of an address.

postDirectional
Type: string

An address suffix location, such as the S. Unit A in Central Park S. Unit A.

postalCode
Type: string

The postal code of an address.

postalCodePlus4
Type: string

The zip + 4 or postal code + 4 of an address.

preDirectional
Type: string

An address prefix location, such as the N in N. Third St.

state
Type: string

The state of an address.

streetName
Type: string

The address street, such as 8th Avenue.

streetNumber
Type: string

The numeric portion of an address.

streetSuffix
Type: string

The address suffix, such as the N in 8th Avenue N.

BadRequestException

Description

The input parameters don't match the service's restrictions.

Members

CallDetails

Description

The details of an Amazon Chime SDK Voice Connector call.

Members
IsCaller
Type: boolean

Identifies a person as the caller or the callee.

TransactionId
Type: string

The transaction ID of a Voice Connector call.

VoiceConnectorId
Type: string

The Voice Connector ID.

CandidateAddress

Description

A suggested address.

Members
city
Type: string

The city of the candidate address.

country
Type: string

The country of the candidate address.

postalCode
Type: string

The postal code of the candidate address.

postalCodePlus4
Type: string

The zip + 4 or postal code +4 of the candidate address.

state
Type: string

The state of the candidate address.

streetInfo
Type: string

The street information of the candidate address.

streetNumber
Type: string

The numeric portion of the candidate address.

ConflictException

Description

Multiple instances of the same request were made simultaneously.

Members

Credential

Description

The SIP credentials used to authenticate requests to an Amazon Chime SDK Voice Connector.

Members
Password
Type: string

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

Username
Type: string

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

DNISEmergencyCallingConfiguration

Description

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime SDK Voice Connector's emergency calling configuration.

Members
CallingCountry
Required: Yes
Type: string

The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

EmergencyPhoneNumber
Required: Yes
Type: string

The DNIS phone number that you route emergency calls to, in E.164 format.

TestPhoneNumber
Type: string

The DNIS phone number for routing test emergency calls to, in E.164 format.

EmergencyCallingConfiguration

Description

The emergency calling configuration details associated with an Amazon Chime SDK Voice Connector.

Members
DNIS
Type: Array of DNISEmergencyCallingConfiguration structures

The Dialed Number Identification Service (DNIS) emergency calling configuration details.

ForbiddenException

Description

The client is permanently forbidden from making the request.

Members

GeoMatchParams

Description

The country and area code for a proxy phone number in a proxy phone session.

Members
AreaCode
Required: Yes
Type: string

The area code.

Country
Required: Yes
Type: string

The country.

GoneException

Description

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

Members

LoggingConfiguration

Description

The logging configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether SIP message logs can be sent to Amazon CloudWatch Logs.

Members
EnableMediaMetricLogs
Type: boolean

Enables or disables media metrics logging.

EnableSIPLogs
Type: boolean

Boolean that enables sending SIP message logs to Amazon CloudWatch.

MediaInsightsConfiguration

Description

The configuration for a call analytics task.

Members
ConfigurationArn
Type: string

The configuration's ARN.

Disabled
Type: boolean

Denotes the configuration as enabled or disabled.

NotFoundException

Description

The requested resource couldn't be found.

Members

OrderedPhoneNumber

Description

A phone number for which an order has been placed.

Members
E164PhoneNumber
Type: string

The phone number, in E.164 format.

Status
Type: string

The phone number status.

Origination

Description

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime SDK Voice Connector.

The parameters listed below are not required, but you must use at least one.

Members
Disabled
Type: boolean

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

Routes
Type: Array of OriginationRoute structures

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.

OriginationRoute

Description

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.

The parameters listed below are not required, but you must use at least one.

Members
Host
Type: string

The FQDN or IP address to contact for origination traffic.

Port
Type: int

The designated origination route port. Defaults to 5060.

Priority
Type: int

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

Protocol
Type: string

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

Weight
Type: int

The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

Participant

Description

The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session.

Members
PhoneNumber
Type: string

The participant's phone number.

ProxyPhoneNumber
Type: string

The participant's proxy phone number.

PhoneNumber

Description

A phone number used to call an Amazon Chime SDK Voice Connector.

Members
Associations
Type: Array of PhoneNumberAssociation structures

The phone number's associations.

CallingName
Type: string

The outbound calling name associated with the phone number.

CallingNameStatus
Type: string

The outbound calling name status.

Capabilities
Type: PhoneNumberCapabilities structure

The phone number's capabilities.

Country
Type: string

The phone number's country. Format: ISO 3166-1 alpha-2.

CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The phone number creation timestamp, in ISO 8601 format.

DeletionTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The deleted phone number timestamp, in ISO 8601 format.

E164PhoneNumber
Type: string

The phone number, in E.164 format.

Name
Type: string

The name of the phone number.

OrderId
Type: string

The phone number's order ID.

PhoneNumberId
Type: string

The phone number's ID.

ProductType
Type: string

The phone number's product type.

Status
Type: string

The phone number's status.

Type
Type: string

The phone number's type.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The updated phone number timestamp, in ISO 8601 format.

PhoneNumberAssociation

Description

The phone number associations, such as an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

Members
AssociatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the phone number association, in ISO 8601 format.

Name
Type: string

Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

Value
Type: string

Contains the ID for the entity specified in Name.

PhoneNumberCapabilities

Description

The phone number capabilities for Amazon Chime SDK phone numbers, such as enabled inbound and outbound calling, and text messaging.

Members
InboundCall
Type: boolean

Allows or denies inbound calling for the specified phone number.

InboundMMS
Type: boolean

Allows or denies inbound MMS messaging for the specified phone number.

InboundSMS
Type: boolean

Allows or denies inbound SMS messaging for the specified phone number.

OutboundCall
Type: boolean

Allows or denies outbound calling for the specified phone number.

OutboundMMS
Type: boolean

Allows or denies inbound MMS messaging for the specified phone number.

OutboundSMS
Type: boolean

Allows or denies outbound SMS messaging for the specified phone number.

PhoneNumberCountry

Description

The phone number's country.

Members
CountryCode
Type: string

The phone number country code. Format: ISO 3166-1 alpha-2.

SupportedPhoneNumberTypes
Type: Array of strings

The supported phone number types.

PhoneNumberError

Description

If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages.

Members
ErrorCode
Type: string

The error code.

ErrorMessage
Type: string

The error message.

PhoneNumberId
Type: string

The phone number ID for which the action failed.

PhoneNumberOrder

Description

The details of an Amazon Chime SDK phone number order.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The phone number order creation time stamp, in ISO 8601 format.

OrderType
Type: string

The type of phone number being ordered, local or toll-free.

OrderedPhoneNumbers
Type: Array of OrderedPhoneNumber structures

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

PhoneNumberOrderId
Type: string

The ID of the phone order.

ProductType
Type: string

The phone number order product type.

Status
Type: string

The status of the phone number order.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The updated phone number order time stamp, in ISO 8601 format.

Proxy

Description

The proxy configuration for an Amazon Chime SDK Voice Connector.

Members
DefaultSessionExpiryMinutes
Type: int

The default number of minutes allowed for proxy sessions.

Disabled
Type: boolean

When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

FallBackPhoneNumber
Type: string

The phone number to route calls to after a proxy session expires.

PhoneNumberCountries
Type: Array of strings

The countries for proxy phone numbers to be selected from.

ProxySession

Description

The proxy session for an Amazon Chime SDK Voice Connector.

Members
Capabilities
Type: Array of strings

The proxy session capabilities.

CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The created time stamp, in ISO 8601 format.

EndedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The ended time stamp, in ISO 8601 format.

ExpiryMinutes
Type: int

The number of minutes allowed for the proxy session.

GeoMatchLevel
Type: string

The preference for matching the country or area code of the proxy phone number with that of the first participant.

GeoMatchParams
Type: GeoMatchParams structure

The country and area code for the proxy phone number.

Name
Type: string

The proxy session name.

NumberSelectionBehavior
Type: string

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

Participants
Type: Array of Participant structures

The proxy session participants.

ProxySessionId
Type: string

The proxy session ID.

Status
Type: string

The proxy session status.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The updated time stamp, in ISO 8601 format.

VoiceConnectorId
Type: string

The Voice Connector ID.

ResourceLimitExceededException

Description

The request exceeds the resource limit.

Members

ServerSideEncryptionConfiguration

Description

A structure that contains the configuration settings for server-side encryption.

We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.

Members
KmsKeyArn
Required: Yes
Type: string

The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

ServiceFailureException

Description

The service encountered an unexpected error.

Members

ServiceUnavailableException

Description

The service is currently unavailable.

Members

SipMediaApplication

Description

The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.

Members
AwsRegion
Type: string

The AWS Region in which the SIP media application is created.

CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The SIP media application creation timestamp, in ISO 8601 format.

Endpoints
Type: Array of SipMediaApplicationEndpoint structures

List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.

Name
Type: string

The SIP media application's name.

SipMediaApplicationArn
Type: string

The ARN of the SIP media application.

SipMediaApplicationId
Type: string

A SIP media application's ID.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the SIP media application was updated.

SipMediaApplicationAlexaSkillConfiguration

Description

The Alexa Skill configuration of a SIP media application.

Due to changes made by the Amazon Alexa service, this data type is no longer available for use. For more information, refer to the Alexa Smart Properties page.

Members
AlexaSkillIds
Required: Yes
Type: Array of strings

The ID of the Alexa Skill configuration.

AlexaSkillStatus
Required: Yes
Type: string

The status of the Alexa Skill configuration.

SipMediaApplicationCall

Description

A Call instance for a SIP media application.

Members
TransactionId
Type: string

The call's transaction ID.

SipMediaApplicationEndpoint

Description

The endpoint assigned to a SIP media application.

Members
LambdaArn
Type: string

Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

SipMediaApplicationLoggingConfiguration

Description

The logging configuration of a SIP media application.

Members
EnableSipMediaApplicationMessageLogs
Type: boolean

Enables message logging for the specified SIP media application.

SipRule

Description

The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the SIP rule was created, in ISO 8601 format.

Disabled
Type: boolean

Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

Name
Type: string

A SIP rule's name.

SipRuleId
Type: string

A SIP rule's ID.

TargetApplications
Type: Array of SipRuleTargetApplication structures

The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

TriggerType
Type: string

The type of trigger set for a SIP rule, either a phone number or a URI request host name.

TriggerValue
Type: string

The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the SIP rule was updated, in ISO 8601 format.

SipRuleTargetApplication

Description

A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

Members
AwsRegion
Type: string

The AWS Region of a rule's target SIP media application.

Priority
Type: int

The priority setting of a rule's target SIP media application.

SipMediaApplicationId
Type: string

The ID of a rule's target SIP media application.

SpeakerSearchDetails

Description

The details of a speaker search task.

Members
Results
Type: Array of SpeakerSearchResult structures

The result value in the speaker search details.

VoiceprintGenerationStatus
Type: string

The status of a voice print generation operation, VoiceprintGenerationSuccess or VoiceprintGenerationFailure..

SpeakerSearchResult

Description

The result of a speaker search analysis.

Members
ConfidenceScore
Type: float

The confidence score in the speaker search analysis.

VoiceProfileId
Type: string

The voice profile ID.

SpeakerSearchTask

Description

A representation of an asynchronous request to perform speaker search analysis on a Voice Connector call.

Members
CallDetails
Type: CallDetails structure

The call details of a speaker search task.

CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a speaker search task was created.

SpeakerSearchDetails
Type: SpeakerSearchDetails structure

The details of a speaker search task.

SpeakerSearchTaskId
Type: string

The speaker search task ID.

SpeakerSearchTaskStatus
Type: string

The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.

StartedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the speaker search task began.

StatusMessage
Type: string

A detailed message about the status of a speaker search.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a speaker search task was updated.

StreamingConfiguration

Description

The streaming configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.

Members
DataRetentionInHours
Required: Yes
Type: int

The amount of time, in hours, to the Kinesis data.

Disabled
Required: Yes
Type: boolean

When true, streaming to Kinesis is off.

MediaInsightsConfiguration
Type: MediaInsightsConfiguration structure

The call analytics configuration.

StreamingNotificationTargets
Type: Array of StreamingNotificationTarget structures

The streaming notification targets.

StreamingNotificationTarget

Description

The target recipient for a streaming configuration notification.

Members
NotificationTarget
Type: string

The streaming notification target.

Tag

Description

Describes a tag applied to a resource.

Members
Key
Required: Yes
Type: string

The tag's key.

Value
Required: Yes
Type: string

The tag's value.

Termination

Description

Termination settings enable SIP hosts to make outbound calls using an Amazon Chime SDK Voice Connector.

Members
CallingRegions
Type: Array of strings

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

CidrAllowedList
Type: Array of strings

The IP addresses allowed to make calls, in CIDR format.

CpsLimit
Type: int

The limit on calls per second. Max value based on account service quota. Default value of 1.

DefaultPhoneNumber
Type: string

The default outbound calling number.

Disabled
Type: boolean

When termination is disabled, outbound calls cannot be made.

TerminationHealth

Description

The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.

Members
Source
Type: string

The source IP address.

Timestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in ISO 8601 format.

ThrottledClientException

Description

The number of customer requests exceeds the request rate limit.

Members

UnauthorizedClientException

Description

The client isn't authorized to request a resource.

Members

UnprocessableEntityException

Description

A well-formed request couldn't be followed due to semantic errors.

Members

UpdatePhoneNumberRequestItem

Description

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

Members
CallingName
Type: string

The outbound calling name to update.

Name
Type: string

The name of the phone number.

PhoneNumberId
Required: Yes
Type: string

The phone number ID to update.

ProductType
Type: string

The product type to update.

VoiceConnector

Description

The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption settings.

Members
AwsRegion
Type: string

The AWS Region in which the Voice Connector is created. Default: us-east-1.

CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Voice Connector's creation timestamp, in ISO 8601 format.

Name
Type: string

The Voice Connector's name.

OutboundHostName
Type: string

The outbound host name for the Voice Connector.

RequireEncryption
Type: boolean

Enables or disables encryption for the Voice Connector.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Voice Connector's updated timestamp, in ISO 8601 format.

VoiceConnectorArn
Type: string

The ARN of the Voice Connector.

VoiceConnectorId
Type: string

The Voice Connector's ID.

VoiceConnectorGroup

Description

The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors. You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant mechanism for fallback in case of availability events.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Voice Connector group's creation time stamp, in ISO 8601 format.

Name
Type: string

The name of a Voice Connector group.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Voice Connector group's creation time stamp, in ISO 8601 format.

VoiceConnectorGroupArn
Type: string

The ARN of the Voice Connector group.

VoiceConnectorGroupId
Type: string

The ID of a Voice Connector group.

VoiceConnectorItems
Type: Array of VoiceConnectorItem structures

The Voice Connectors to which you route inbound calls.

VoiceConnectorItem

Description

For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice Connectors to which you route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Voice Connector group.

Members
Priority
Required: Yes
Type: int

The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

VoiceConnectorId
Required: Yes
Type: string

The Voice Connector ID.

VoiceConnectorSettings

Description

The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.

Members
CdrBucket
Type: string

The S3 bucket that stores the Voice Connector's call detail records.

VoiceProfile

Description

The combination of a voice print and caller ID.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the voice profile was created and enrolled.

ExpirationTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the voice profile was last updated.

VoiceProfileArn
Type: string

The ARN of the voice profile.

VoiceProfileDomainId
Type: string

The ID of the domain that contains the voice profile.

VoiceProfileId
Type: string

The ID of the voice profile.

VoiceProfileDomain

Description

A collection of voice profiles.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the voice profile domain was created.

Description
Type: string

The description of the voice profile domain.

Name
Type: string

The name of the voice profile domain.

ServerSideEncryptionConfiguration

A structure that contains the configuration settings for server-side encryption.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the voice profile was last updated.

VoiceProfileDomainArn
Type: string

The voice profile domain's Amazon Resource Number (ARN).

VoiceProfileDomainId
Type: string

The ID of the voice profile domain.

VoiceProfileDomainSummary

Description

A high-level overview of a voice profile domain.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the voice profile domain summary was created.

Description
Type: string

Describes the voice profile domain summary.

Name
Type: string

The name of the voice profile domain summary.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the voice profile domain summary was last updated.

VoiceProfileDomainArn
Type: string

The ARN of a voice profile in a voice profile domain summary.

VoiceProfileDomainId
Type: string

The ID of the voice profile domain summary.

VoiceProfileSummary

Description

A high-level summary of a voice profile.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a voice profile summary was created.

ExpirationTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh an existing voice profile's voice print and extend the life of the summary.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a voice profile summary was last updated.

VoiceProfileArn
Type: string

The ARN of the voice profile in a voice profile summary.

VoiceProfileDomainId
Type: string

The ID of the voice profile domain in a voice profile summary.

VoiceProfileId
Type: string

The ID of the voice profile in a voice profile summary.

VoiceToneAnalysisTask

Description

A representation of an asynchronous request to perform voice tone analysis on a Voice Connector call.

Members
CallDetails
Type: CallDetails structure

The call details of a voice tone analysis task.

CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a voice tone analysis task was created.

StartedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a voice tone analysis task started.

StatusMessage
Type: string

The status of a voice tone analysis task.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a voice tone analysis task was updated.

VoiceToneAnalysisTaskId
Type: string

The ID of the voice tone analysis task.

VoiceToneAnalysisTaskStatus
Type: string

The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.