post https://api.heygen.com/v1/streaming.ice
This endpoint is used to send an ICE (Interactive Connectivity Establishment) candidate to the server.
Request Body
| Field | Type | Description |
|---|---|---|
session_id | string | The ID of the session to which the ICE candidate is to be sent. |
candidate | object | The ICE candidate information. |
candidate.candidate | string | The ICE candidate string. |
candidate.sdpMid | string | The media stream identification for the ICE candidate. |
candidate.sdpMLineIndex | integer | The index (starting at 0) of the m-line in the SDP. |
candidate.usernameFragment | string | The ICE username fragment. |
Response
| Field | Type | Description |
|---|---|---|
status | string | The status of the response. If the ICE candidate is successfully sent, it will return "success". |