CreateSipMediaApplicationCall - Amazon Chime

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.

Request Syntax

POST /sip-media-applications/sipMediaApplicationId/calls HTTP/1.1 Content-type: application/json { "FromPhoneNumber": "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.

Type: String

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

Required: No

ToPhoneNumber

The phone number that the user dials in order to connect to a meeting.

Type: String

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

Required: No

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.

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: