POST

/sip-media-applications/{sipMediaApplicationId}/calls

http://service.chime.aws.amazon.com/sip-media-applications/{sipMediaApplicationId}/calls

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

Access Token Required: API Key

Path Parameters

sipMediaApplicationIdstringrequired

The ID of the SIP media application.

Body Params

SipHeadersobject

The SIP headers added to an outbound call leg.

ToPhoneNumberstringrequired

The phone number that the service should call.

FromPhoneNumberstringrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://service.chime.aws.amazon.com/sip-media-applications/{sipMediaApplicationId}/calls' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}