AlmaConnect API Documentation
Create template
POST {{HOST}}/v2/templates
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Authorization
|
null |
RESPONSES
status
Curl
curl -X POST 'https://api.100ms.live/v2/templates' -H 'Authorization: ' -d '{"name":"new-template-$timestamp","default":false,"roles":{"guest":{"name":"guest","publishParams":{"allowed":["audio","video","screen"],"audio":{"bitRate":32,"codec":"opus"},"video":{"bitRate":300,"codec":"vp8","frameRate":30,"width":480,"height":360},"screen":{"codec":"vp8","frameRate":10,"width":1920,"height":1080}},"subscribeParams":{"subscribeToRoles":["host","guest"],"maxSubsBitRate":3200,"subscribeDegradation":{"packetLossThreshold":25,"degradeGracePeriodSeconds":1,"recoverGracePeriodSeconds":4}},"permissions":{"sendRoomState":false},"priority":1,"maxPeerCount":0},"host":{"name":"host","publishParams":{"allowed":["audio","video","screen"],"audio":{"bitRate":32,"codec":"opus"},"video":{"bitRate":300,"codec":"vp8","frameRate":30,"width":480,"height":360},"screen":{"codec":"vp8","frameRate":10,"width":1920,"height":1080}},"subscribeParams":{"subscribeToRoles":["guest","host"],"maxSubsBitRate":3200,"subscribeDegradation":{"packetLossThreshold":25,"degradeGracePeriodSeconds":1,"recoverGracePeriodSeconds":4}},"permissions":{"endRoom":true,"removeOthers":true,"mute":true,"unmute":true,"changeRole":true,"sendRoomState":false},"priority":1,"maxPeerCount":0}},"settings":{"region":"in","recording":{"enabled":true,"upload":{"type":"s3","location":"\u003cName of the AWS s3 bucket\u003e","prefix":"\u003cUpload prefix path\u003e","options":{"region":"\u003cregion of the s3 bucket\u003e"},"credentials":{"key":"\u003caccess key ID for the AWS account/S3 bucket\u003e","secretKey":"\u003csecret access key for the AWS account/S3 bucket\u003e"}}},"roomState":{"messageInterval":5,"sendPeerList":false,"stopRoomStateOnJoin":true,"enabled":false}}}'
ENDPOINTS