Create a new session
Sessions are idempotent, so relevant parameters must be set in this function if desired
Request URL
POSThttps://api.webrtc.bandwidth.com/v1/accounts/{accountId}/sessions
Basic Authentication
Bandwidth WebRTC API leverages Basic Authentication with your Dashboard API Credentials. Read more about how Bandwidth secures endpoints in the Security & Credentials document.
Request Body Parameters
| Parameter | Description |
|---|---|
| tag | User defined tag to associate with the session |
Response Attributes
| Property | Description |
|---|---|
| id | Unique id of the session |
| participants | The list of participants associated with this session |
| tag | User defined tag to associate with the session |
Example: Create a new session
curl -X POST
--url 'https://api.webrtc.bandwidth.com/v1/accounts/{accountId}/sessions'
-u '{username}:{password}'
-H 'Content-type: application/json'
--data-raw '
{
"tag": "session1"
}'
Responds
{
"id" : "75c21163-e110-41bc-bd76-1bb428ec85d5",
"participants" : [
"c0c0dcfd-4ce4-4752-a8d9-b6ddeb72bead",
"320e2af6-13ec-498d-8b51-daba52c37853"
],
"tag" : "session1"
}
Potential Error Responses
HTTP/1.1 400 (Bad Request)
Content-Type: application/json
HTTP/1.1 401 (Unauthorized)
Content-Type: application/json
HTTP/1.1 403 (Access Denied)
Content-Type: application/json
HTTP/1.1 50x (Unexpected Error)
Content-Type: application/json