Client: Aws\PinpointSMSVoice\PinpointSMSVoiceClient

Service ID: sms-voice

Version: 2018-09-05

This page describes the parameters and results for the operations of the Amazon Pinpoint SMS and Voice Service (2018-09-05), and shows how to use the Aws\PinpointSMSVoice\PinpointSMSVoiceClient object to call the described operations. This documentation is specific to the 2018-09-05 API version of the service.

Operation Summary

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

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

CreateConfigurationSet ( array $params = [] )

Create a new configuration set.

CreateConfigurationSetEventDestination ( array $params = [] )

Create a new event destination in a configuration set.

DeleteConfigurationSet ( array $params = [] )

Deletes an existing configuration set.

DeleteConfigurationSetEventDestination ( array $params = [] )

Deletes an event destination in a configuration set.

GetConfigurationSetEventDestinations ( array $params = [] )

Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

ListConfigurationSets ( array $params = [] )

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

SendVoiceMessage ( array $params = [] )

Create a new voice message and send it to a recipient's phone number.

UpdateConfigurationSetEventDestination ( array $params = [] )

Update an event destination in a configuration set.

$result = $client->createConfigurationSet([/* ... */]);
$promise = $client->createConfigurationSetAsync([/* ... */]);

$result = $client->createConfigurationSet([
    'ConfigurationSetName' => '<string>',
]);

[]

$result = $client->createConfigurationSetEventDestination([/* ... */]);
$promise = $client->createConfigurationSetEventDestinationAsync([/* ... */]);

$result = $client->createConfigurationSetEventDestination([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'EventDestination' => [
        'CloudWatchLogsDestination' => [
            'IamRoleArn' => '<string>',
            'LogGroupArn' => '<string>',
        ],
        'Enabled' => true || false,
        'KinesisFirehoseDestination' => [
            'DeliveryStreamArn' => '<string>',
            'IamRoleArn' => '<string>',
        ],
        'MatchingEventTypes' => ['<string>', ...],
        'SnsDestination' => [
            'TopicArn' => '<string>',
        ],
    ],
    'EventDestinationName' => '<string>',
]);

[]

$result = $client->deleteConfigurationSet([/* ... */]);
$promise = $client->deleteConfigurationSetAsync([/* ... */]);

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

[]

$result = $client->deleteConfigurationSetEventDestination([/* ... */]);
$promise = $client->deleteConfigurationSetEventDestinationAsync([/* ... */]);

$result = $client->deleteConfigurationSetEventDestination([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'EventDestinationName' => '<string>', // REQUIRED
]);

[]

$result = $client->getConfigurationSetEventDestinations([/* ... */]);
$promise = $client->getConfigurationSetEventDestinationsAsync([/* ... */]);

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

[
    'EventDestinations' => [
        [
            'CloudWatchLogsDestination' => [
                'IamRoleArn' => '<string>',
                'LogGroupArn' => '<string>',
            ],
            'Enabled' => true || false,
            'KinesisFirehoseDestination' => [
                'DeliveryStreamArn' => '<string>',
                'IamRoleArn' => '<string>',
            ],
            'MatchingEventTypes' => ['<string>', ...],
            'Name' => '<string>',
            'SnsDestination' => [
                'TopicArn' => '<string>',
            ],
        ],
        // ...
    ],
]

$result = $client->listConfigurationSets([/* ... */]);
$promise = $client->listConfigurationSetsAsync([/* ... */]);

$result = $client->listConfigurationSets([
    'NextToken' => '<string>',
    'PageSize' => '<string>',
]);

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

$result = $client->sendVoiceMessage([/* ... */]);
$promise = $client->sendVoiceMessageAsync([/* ... */]);

$result = $client->sendVoiceMessage([
    'CallerId' => '<string>',
    'ConfigurationSetName' => '<string>',
    'Content' => [
        'CallInstructionsMessage' => [
            'Text' => '<string>',
        ],
        'PlainTextMessage' => [
            'LanguageCode' => '<string>',
            'Text' => '<string>',
            'VoiceId' => '<string>',
        ],
        'SSMLMessage' => [
            'LanguageCode' => '<string>',
            'Text' => '<string>',
            'VoiceId' => '<string>',
        ],
    ],
    'DestinationPhoneNumber' => '<string>',
    'OriginationPhoneNumber' => '<string>',
]);

[
    'MessageId' => '<string>',
]

$result = $client->updateConfigurationSetEventDestination([/* ... */]);
$promise = $client->updateConfigurationSetEventDestinationAsync([/* ... */]);

$result = $client->updateConfigurationSetEventDestination([
    'ConfigurationSetName' => '<string>', // REQUIRED
    'EventDestination' => [
        'CloudWatchLogsDestination' => [
            'IamRoleArn' => '<string>',
            'LogGroupArn' => '<string>',
        ],
        'Enabled' => true || false,
        'KinesisFirehoseDestination' => [
            'DeliveryStreamArn' => '<string>',
            'IamRoleArn' => '<string>',
        ],
        'MatchingEventTypes' => ['<string>', ...],
        'SnsDestination' => [
            'TopicArn' => '<string>',
        ],
    ],
    'EventDestinationName' => '<string>', // REQUIRED
]);

[]