StartOutboundVoiceContactRequest

import type { StartOutboundVoiceContactRequest } from "https://aws-api.deno.dev/v0.3/services/connect.ts?docs=full";

interface StartOutboundVoiceContactRequest {

AnswerMachineDetectionConfig?: AnswerMachineDetectionConfig | null;

Attributes?: {

[key: string]: string | null | undefined;

} | null;

CampaignId?: string | null;

ClientToken?: string | null;

ContactFlowId: string;

DestinationPhoneNumber: string;

InstanceId: string;

QueueId?: string | null;

SourcePhoneNumber?: string | null;

TrafficType?: TrafficType | null;

}

§Properties

AnswerMachineDetectionConfig?: AnswerMachineDetectionConfig | null

[src]

Configuration of the answering machine detection for this outbound call.

Attributes?: {

[key: string]: string | null | undefined;

} | null

[src]

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

CampaignId?: string | null

[src]

The campaign identifier of the outbound communication.

ClientToken?: string | null

[src]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

ContactFlowId: string

[src]

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

DestinationPhoneNumber: string

[src]

The phone number of the customer, in E.164 format.

InstanceId: string

[src]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

QueueId?: string | null

[src]

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

SourcePhoneNumber?: string | null

[src]

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

TrafficType?: TrafficType | null

[src]

Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.