GetMessagingSessionEndpoint - Amazon Chime SDK

GetMessagingSessionEndpoint

The details of the endpoint for the messaging session.

Request Syntax

GET /endpoints/messaging-session?network-type=NetworkType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

NetworkType

The type of network for the messaging session endpoint. Either IPv4 only or dual-stack (IPv4 and IPv6).

Valid Values: IPV4_ONLY | DUAL_STACK

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Endpoint": { "Url": "string" } }

Response Elements

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

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

Endpoint

The endpoint returned in the response.

Type: MessagingSessionEndpoint object

Errors

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

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

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: