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.
UpdateSipMediaApplicationCall
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.
Important
This API is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplicationCall, 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/transactionId
HTTP/1.1
Content-type: application/json
{
"Arguments": {
"string
" : "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- sipMediaApplicationId
-
The ID of the SIP media application handling the call.
Pattern:
.*\S.*
Required: Yes
- transactionId
-
The ID of the call transaction.
Pattern:
.*\S.*
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Arguments
-
Arguments made available to the Lambda function as part of the
CALL_UPDATE_REQUESTED
event. Can contain 0-20 key-value pairs.Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 20 items.
Required: Yes
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"SipMediaApplicationCall": {
"TransactionId": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- SipMediaApplicationCall
-
A
Call
instance for a SIP media application.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
- NotFoundException
-
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404
- 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: