---
title: "POST /getSignalingChannelEndpoint"
method: POST
path: "/getSignalingChannelEndpoint"
---

# POST /getSignalingChannelEndpoint

`POST /getSignalingChannelEndpoint`

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the `SingleMasterChannelEndpointConfiguration` input parameter, which consists of the `Protocols` and `Role` properties.

`Protocols` is used to determine the communication mechanism. For example, if you specify `WSS` as the protocol, this API produces a secure websocket endpoint. If you specify `HTTPS` as the protocol, this API generates an HTTPS endpoint.

`Role` determines the messaging permissions. A `MASTER` role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A `VIEWER` role results in this API generating an endpoint that a client can use to communicate only with a `MASTER`.

## Request body

- object
  - `ChannelARN` string, required — The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.
  - `SingleMasterChannelEndpointConfiguration` object — An object that contains the endpoint configuration for the <code>SINGLE_MASTER</code> channel type.
    - `Protocols` ChannelProtocol[] — This property is used to determine the nature of communication over this <code>SINGLE_MASTER</code> signaling channel. If <code>WSS</code> is specified, this API returns a websocket endpoint. If <code>HTTPS</code> is specified, this API returns an <code>HTTPS</code> endpoint.
    - `Role` 'MASTER' | 'VIEWER' — This property is used to determine messaging permissions in this <code>SINGLE_MASTER</code> signaling channel. If <code>MASTER</code> is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If <code>VIEWER</code> is specified, this API returns an endpoint that a client can use only to send offers to another <code>MASTER</code> client on this signaling channel.

## Response `200`

Success

- GetSignalingChannelEndpointOutput
  - `ResourceEndpointList` ResourceEndpointListItem[] — A list of endpoints for the specified signaling channel.
    - `Protocol` 'WSS' | 'HTTPS' | 'WEBRTC' — The protocol of the signaling channel returned by the <code>GetSignalingChannelEndpoint</code> API.
    - `ResourceEndpoint` string — The endpoint of the signaling channel returned by the <code>GetSignalingChannelEndpoint</code> API.

## Other responses

- `480` — InvalidArgumentException
- `481` — ClientLimitExceededException
- `482` — ResourceNotFoundException
- `483` — ResourceInUseException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/kinesisvideo.md) · [All operations](https://skmtc.net/aws/apis/kinesisvideo/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/kinesisvideo/revisions/95357891934e/schema)