Chime / Client / create_sip_media_application_call

create_sip_media_application_call#

Chime.Client.create_sip_media_application_call(**kwargs)#

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.create_sip_media_application_call(
    FromPhoneNumber='string',
    ToPhoneNumber='string',
    SipMediaApplicationId='string',
    SipHeaders={
        'string': 'string'
    }
)
Parameters:

  • FromPhoneNumber (string) –

    [REQUIRED]

    The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.

  • ToPhoneNumber (string) –

    [REQUIRED]

    The phone number that the service should call.

  • SipMediaApplicationId (string) –

    [REQUIRED]

    The ID of the SIP media application.

  • SipHeaders (dict) –

    The SIP headers added to an outbound call leg.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'SipMediaApplicationCall': {
        'TransactionId': 'string'
    }
}

Response Structure

  • (dict) –

    • SipMediaApplicationCall (dict) –

      The actual call.

      • TransactionId (string) –

        The transaction ID of a call.

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