CreateSipMediaApplicationCall - Amazon Chime

The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.

CreateSipMediaApplicationCall

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.

Important

This API 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.

Request Syntax

POST /sip-media-applications/sipMediaApplicationId/calls HTTP/1.1 Content-type: application/json { "FromPhoneNumber": "string", "SipHeaders": { "string" : "string" }, "ToPhoneNumber": "string" }

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId

The ID of the SIP media application.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

FromPhoneNumber

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

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

SipHeaders

The SIP headers added to an outbound call leg.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Required: No

ToPhoneNumber

The phone number that the service should call.

Type: String

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "SipMediaApplicationCall": { "TransactionId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

SipMediaApplicationCall

The actual call.

Type: SipMediaApplicationCall object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: