Skip to content

create_meeting_dial_out async 

create_meeting_dial_out(
    meeting_id: GuidString,
    from_phone_number: E164PhoneNumber,
    to_phone_number: E164PhoneNumber,
    join_token: JoinTokenString,
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
) -> CreateMeetingDialOutResponse

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.

To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

This API is not available in a dedicated namespace.

Parameters:

  • meeting_id (GuidString) –

    The Amazon Chime SDK meeting ID.

  • from_phone_number (E164PhoneNumber) –

    Phone number used as the caller ID when the remote party receives a call.

  • to_phone_number (E164PhoneNumber) –

    Phone number called when inviting someone to a meeting.

  • join_token (JoinTokenString) –

    Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

Raises:

Source code in docs_src/capo_chime/_services/async_chime.py 
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
async def create_meeting_dial_out(
    self,
    meeting_id: "capo_chime.types.guid_string.GuidString",
    from_phone_number: "capo_chime.types.e164_phone_number.E164PhoneNumber",
    to_phone_number: "capo_chime.types.e164_phone_number.E164PhoneNumber",
    join_token: "capo_chime.types.join_token_string.JoinTokenString",
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
) -> (
    "capo_chime.types.create_meeting_dial_out_response.CreateMeetingDialOutResponse"
):
    """<p>Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.</p> <p>To play welcome audio or implement an interactive voice response (IVR), use the <code>CreateSipMediaApplicationCall</code> action with the corresponding SIP media application ID.</p> <important> <p> <b>This API is not available in a dedicated namespace.</b> </p> </important>

    Args:
        meeting_id: <p>The Amazon Chime SDK meeting ID.</p>
        from_phone_number: <p>Phone number used as the caller ID when the remote party receives a call.</p>
        to_phone_number: <p>Phone number called when inviting someone to a meeting.</p>
        join_token: <p>Token used by the Amazon Chime SDK attendee. Call the <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html">CreateAttendee</a> action to get a join token.</p>

    Raises:
        capo_chime.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to perform the requested operation.</p>
        capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</p>
        capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime.types.create_meeting_dial_out_request.CreateMeetingDialOutRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime.types.create_meeting_dial_out_response.CreateMeetingDialOutResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.create_meeting_dial_out

        (
            output,
            http_response,
        ) = await capo_chime._operations.uc_buzz_console_service.create_meeting_dial_out.async_create_meeting_dial_out(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime.types.create_meeting_dial_out_request.CreateMeetingDialOutRequest",
    ) -> dict[str, Any]:
        import capo_chime.types.create_meeting_dial_out_request

        return capo_chime.types.create_meeting_dial_out_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateMeetingDialOut", redact_input=_redact_input),
    )
    input_: capo_chime.types.create_meeting_dial_out_request.CreateMeetingDialOutRequest = {
        "meeting_id": meeting_id,
        "from_phone_number": from_phone_number,
        "to_phone_number": to_phone_number,
        "join_token": join_token,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output