ChimeSDKVoice / Client / create_sip_media_application_call

create_sip_media_application_call

ChimeSDKVoice.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.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• FromPhoneNumber (string) –

  [REQUIRED]

  The phone number that a user calls from. This is a phone number in your Amazon Chime SDK 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) –

• ArgumentsMap (dict) –

  Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: "FirstName": "John", "LastName": "Doe"

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • SipMediaApplicationCall (dict) –

    The actual call.

    • TransactionId (string) –

      The call’s transaction ID.

Exceptions

• ChimeSDKVoice.Client.exceptions.BadRequestException

• ChimeSDKVoice.Client.exceptions.ForbiddenException

• ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException

• ChimeSDKVoice.Client.exceptions.ThrottledClientException

• ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

• ChimeSDKVoice.Client.exceptions.AccessDeniedException

• ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

• ChimeSDKVoice.Client.exceptions.ServiceFailureException