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

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

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

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

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

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

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.

Parameter Syntax

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

Parameter Details

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

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

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

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

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

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

Result Syntax

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

Result 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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result 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.

CreateVoiceProfile

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

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

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result 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.

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

Result Syntax

[]

Result 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.

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

Result Syntax

[]

Result 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.

DeleteSipMediaApplication

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

Deletes a SIP media application.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result 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.

DeleteSipRule

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

Deletes a SIP rule.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result 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.

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

Result Syntax

[]

Result 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.

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

Result Syntax

[]

Result 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.

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

Result Syntax

[]

Result 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.

DeleteVoiceConnectorOrigination

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result 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.

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

Result Syntax

[]

Result 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.

DeleteVoiceConnectorStreamingConfiguration

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

Deletes a Voice Connector's streaming configuration.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result 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.

DeleteVoiceConnectorTermination

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result 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.

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

Result Syntax

[]

Result 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.

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

Result Syntax

[]

Result 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.

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

Result Syntax

[]

Result 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.

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

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

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

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

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

Result Syntax

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

Result 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.

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

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

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

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

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

Result Syntax

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

Result 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.

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

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

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

Result Syntax

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

Result 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.

GetSipMediaApplicationAlexaSkillConfiguration

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

Gets the Alexa Skill configuration for the SIP media application.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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.

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

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

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

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

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

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

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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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

Result Syntax

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

Result 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

Result Syntax

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

Result 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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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

Result Syntax

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

Result 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

Result Syntax

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

Result 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

Result Syntax

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

Result 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.

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

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

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

Result Syntax

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

Result 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.

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

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

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

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

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

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

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

Result Syntax

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

Result 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

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

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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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.

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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

Result Syntax

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

Result 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.

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

Result Syntax

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

Result 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.

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

Result Syntax

[]

Result 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.

RestorePhoneNumber

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

Restores a deleted phone number.

Parameter Syntax

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

Parameter Details

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

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.