Chime / Client / create_meeting_dial_out

create_meeting_dial_out#

Chime.Client.create_meeting_dial_out(**kwargs)#

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.

Warning

This API is is not available in a dedicated namespace.

See also: AWS API Documentation

Request Syntax

response = client.create_meeting_dial_out(
    MeetingId='string',
    FromPhoneNumber='string',
    ToPhoneNumber='string',
    JoinToken='string'
)
Parameters:

  • MeetingId (string) –

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • FromPhoneNumber (string) –

    [REQUIRED]

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

  • ToPhoneNumber (string) –

    [REQUIRED]

    Phone number called when inviting someone to a meeting.

  • JoinToken (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'TransactionId': 'string'
}

Response Structure

  • (dict) –

    • TransactionId (string) –

      Unique ID that tracks API calls.

Exceptions

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.ResourceLimitExceededException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.AccessDeniedException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException