start_outbound_voice_contact ¶

def start_outbound_voice_contact(
    self,
    destination_phone_number: "capo_connect.types.phone_number.PhoneNumber",
    contact_flow_id: "capo_connect.types.contact_flow_id.ContactFlowId",
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    name: Optional["capo_connect.types.name.Name"] = None,
    description: Optional["capo_connect.types.description.Description"] = None,
    references: Optional[
        "capo_connect.types.contact_references.ContactReferences"
    ] = None,
    related_contact_id: Optional["capo_connect.types.contact_id.ContactId"] = None,
    client_token: Optional["capo_connect.types.client_token.ClientToken"] = None,
    source_phone_number: Optional[
        "capo_connect.types.phone_number.PhoneNumber"
    ] = None,
    queue_id: Optional["capo_connect.types.queue_id.QueueId"] = None,
    attributes: Optional["capo_connect.types.attributes.Attributes"] = None,
    answer_machine_detection_config: Optional[
        "capo_connect.types.answer_machine_detection_config.AnswerMachineDetectionConfig"
    ] = None,
    campaign_id: Optional["capo_connect.types.campaign_id.CampaignId"] = None,
    traffic_type: Optional["capo_connect.types.traffic_type.TrafficType"] = None,
    outbound_strategy: Optional[
        "capo_connect.types.outbound_strategy.OutboundStrategy"
    ] = None,
    ring_timeout_in_seconds: Optional[
        "capo_connect.types.ring_timeout_in_seconds.RingTimeoutInSeconds"
    ] = None,
) -> "capo_connect.types.start_outbound_voice_contact_response.StartOutboundVoiceContactResponse":
    """<p>Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in <code>ContactFlowId</code>).</p> <p>Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.</p> <p>Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 60 seconds, it fails.</p> <note> <p>UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Connect Customer Service Quotas</a> in the <i>Connect Customer Administrator Guide</i>. </p> </note> <note> <p>Campaign calls are not allowed by default. Before you can make a call with <code>TrafficType</code> = <code>CAMPAIGN</code>, you must submit a service quota increase request to the quota <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas">Connect Customer campaigns</a>. </p> </note> <note> <p>For Preview dialing mode, only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API with OutboundStrategy. </p> </note>

    Args:
        name: <p>The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).</p>
        description: <p>A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information about CCP logs, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/download-ccp-logs.html">Download and review CCP logs</a> in the <i>Connect Customer Administrator Guide</i>.</p>
        references: <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during voice contact creation.</p>
        related_contact_id: <p>The <code>contactId</code> that is related to this contact. Linking voice, task, or chat by using <code>RelatedContactID</code> copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using <code>RelatedContactId</code>. </p>
        destination_phone_number: <p>The phone number of the customer, in E.164 format.</p>
        contact_flow_id: <p>The identifier of the flow for the outbound call. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. </p>
        source_phone_number: <p>The phone number associated with the Connect Customer instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.</p>
        queue_id: <p>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 flow is used. If you do not specify a queue, you must specify a source phone number.</p>
        attributes: <p>A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.</p> <p>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.</p>
        answer_machine_detection_config: <p>Configuration of the answering machine detection for this outbound call. </p>
        campaign_id: <p>The campaign identifier of the outbound communication.</p>
        traffic_type: <p>Denotes the class of traffic. Calls with different traffic types are handled differently by Connect Customer. The default value is <code>GENERAL</code>. Use <code>CAMPAIGN</code> if <code>EnableAnswerMachineDetection</code> is set to <code>true</code>. For all other cases, use <code>GENERAL</code>. </p>
        outbound_strategy: <p>Information about the outbound strategy.</p>
        ring_timeout_in_seconds: <p>The maximum time the outbound call will wait for the destination to answer the call, in seconds </p>

    Raises:
        capo_connect.errors.destination_not_allowed_exception.DestinationNotAllowedException: <p>Outbound calls to the destination number are not allowed.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.limit_exceeded_exception.LimitExceededException: <p>The allowed limit for the resource has been exceeded.</p>
        capo_connect.errors.outbound_contact_not_permitted_exception.OutboundContactNotPermittedException: <p>The contact is not permitted.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.start_outbound_voice_contact_request.StartOutboundVoiceContactRequest]",
    ) -> OperationResponse[
        "capo_connect.types.start_outbound_voice_contact_response.StartOutboundVoiceContactResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.start_outbound_voice_contact

        output, http_response = (
            capo_connect._operations.amazon_connect_service.start_outbound_voice_contact.start_outbound_voice_contact(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_connect.types.start_outbound_voice_contact_request.StartOutboundVoiceContactRequest",
    ) -> dict[str, Any]:
        import capo_connect.types.start_outbound_voice_contact_request

        return capo_connect.types.start_outbound_voice_contact_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("StartOutboundVoiceContact", redact_input=_redact_input),
    )
    input_: capo_connect.types.start_outbound_voice_contact_request.StartOutboundVoiceContactRequest = {
        "destination_phone_number": destination_phone_number,
        "contact_flow_id": contact_flow_id,
        "instance_id": instance_id,
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if references is not None:
        input_["references"] = references
    if related_contact_id is not None:
        input_["related_contact_id"] = related_contact_id
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if source_phone_number is not None:
        input_["source_phone_number"] = source_phone_number
    if queue_id is not None:
        input_["queue_id"] = queue_id
    if attributes is not None:
        input_["attributes"] = attributes
    if answer_machine_detection_config is not None:
        input_["answer_machine_detection_config"] = answer_machine_detection_config
    if campaign_id is not None:
        input_["campaign_id"] = campaign_id
    if traffic_type is not None:
        input_["traffic_type"] = traffic_type
    if outbound_strategy is not None:
        input_["outbound_strategy"] = outbound_strategy
    if ring_timeout_in_seconds is not None:
        input_["ring_timeout_in_seconds"] = ring_timeout_in_seconds

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output