![](\"https://miro.medium.com/max/3200/1*ok4R5IgAfVKtkcRomdbZlA.png\")
This is a collection of example requests for all of Agora's products that have RESTful APIs.
\nThis includes:
\nRTC Channel Management
\nConsole APIs
\nCloud Recording
\nSignaling
\nInteractive Whiteboard
\nFlexible Classroom
\nMedia Services
\nPaid Products
\nBeta Products
\nIf you are looking for example requests for AgoraChat RESTful APIs, please see our AgoraChat Postman Collection.
\nHave fun!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6319646","collectionId":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","publishedId":"SVSLr9AM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"099DFD"},"publishDate":"2024-08-09T06:20:58.000Z"},"item":[{"name":"Channel Management","item":[{"name":"Banning user privileges","item":[{"name":"Create","event":[{"listen":"test","script":{"id":"04f49423-cccb-482b-b1ff-4269cb0d5326","exec":["var jsonData = JSON.parse(responseBody);","var id = jsonData.id;","console.log(id);","pm.collectionVariables.set(\"id\", id);"],"type":"text/javascript","packages":{}}}],"id":"cb2fe3df-76be-4e1c-9297-09eceacd341a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"appid\": \"{{APPID}}\",\n \"cname\": \"{{AccessChannel}}\", //optional\n \"uid\": {{cmUID}}, //optional\n \"ip\": \"{{IP}}\", //optional\n \"time\": {{time}},\n \"time_in_seconds\": {{timeInSeconds}}, //choose time or time_in_seconds\n \"privileges\": [\n \"join_channel\",\n \"publish_audio\",\n \"publish_video\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/dev/v1/kicking-rule","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64","id":"1f1b290c-cc09-4952-b901-f4271390be64","name":"Channel Management","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","kicking-rule"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb2fe3df-76be-4e1c-9297-09eceacd341a"},{"name":"Get","event":[{"listen":"test","script":{"id":"04f49423-cccb-482b-b1ff-4269cb0d5326","exec":[""],"type":"text/javascript"}}],"id":"0640d215-02df-4185-abba-456fd233a7d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/dev/v1/kicking-rule?appid={{APPID}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64","id":"1f1b290c-cc09-4952-b901-f4271390be64","name":"Channel Management","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","kicking-rule"],"host":["api","agora","io"],"query":[{"key":"appid","value":"{{APPID}}"}],"variable":[]}},"response":[],"_postman_id":"0640d215-02df-4185-abba-456fd233a7d8"},{"name":"Update","event":[{"listen":"test","script":{"id":"04f49423-cccb-482b-b1ff-4269cb0d5326","exec":["var jsonData = JSON.parse(responseBody);","var id = jsonData.id;","console.log(id);","pm.collectionVariables.set(\"id\", id);"],"type":"text/javascript","packages":{}}}],"id":"ed57bf68-671c-4a1d-93ed-e545d9901745","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"appid\": \"{{APPID}}\",\n \"id\": {{id}},\n \"time\": {{time}},\n \"time_in_seconds\": {{timeInSeconds}} //choose time or time_in_seconds\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/dev/v1/kicking-rule","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64","id":"1f1b290c-cc09-4952-b901-f4271390be64","name":"Channel Management","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","kicking-rule"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed57bf68-671c-4a1d-93ed-e545d9901745"},{"name":"Delete","event":[{"listen":"test","script":{"id":"04f49423-cccb-482b-b1ff-4269cb0d5326","exec":[""],"type":"text/javascript"}}],"id":"af1b1648-86b5-4d15-9fba-fcc1394e30e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n\t\"appid\":\"{{APPID}}\",\n \"id\":{{id}}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/dev/v1/kicking-rule","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64","id":"1f1b290c-cc09-4952-b901-f4271390be64","name":"Channel Management","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","kicking-rule"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"af1b1648-86b5-4d15-9fba-fcc1394e30e5"}],"id":"cc9db95a-1412-485f-97fe-36e4b3163ac6","_postman_id":"cc9db95a-1412-485f-97fe-36e4b3163ac6","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64","id":"1f1b290c-cc09-4952-b901-f4271390be64","name":"Channel Management","type":"folder"}}},{"name":"Online Channel Statistics","item":[{"name":"Get channel list","event":[{"listen":"test","script":{"id":"04f49423-cccb-482b-b1ff-4269cb0d5326","exec":[""],"type":"text/javascript"}}],"id":"080ffa91-0c31-42ab-9177-7942f8691ea2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/dev/v1/channel/{{APPID}}/","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64","id":"1f1b290c-cc09-4952-b901-f4271390be64","name":"Channel Management","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","channel","{{APPID}}",""],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"080ffa91-0c31-42ab-9177-7942f8691ea2"},{"name":"Get user list","event":[{"listen":"test","script":{"id":"04f49423-cccb-482b-b1ff-4269cb0d5326","exec":["var jsonData = JSON.parse(responseBody);","var id = jsonData.id;","console.log(id);","pm.collectionVariables.set(\"id\", id);"],"type":"text/javascript","packages":{}}}],"id":"85067b69-dbde-4dca-bd54-2413221844cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/dev/v1/channel/user/{{APPID}}/{channelName}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64","id":"1f1b290c-cc09-4952-b901-f4271390be64","name":"Channel Management","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","channel","user","{{APPID}}","{channelName}"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"85067b69-dbde-4dca-bd54-2413221844cf"},{"name":"Get user status","event":[{"listen":"test","script":{"id":"04f49423-cccb-482b-b1ff-4269cb0d5326","exec":[""],"type":"text/javascript"}}],"id":"6d8e52b7-3273-4dd5-94ee-389448429d96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/dev/v1/channel/user/property/{{APPID}}/{{cmUID}}/{{AccessChannel}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64","id":"1f1b290c-cc09-4952-b901-f4271390be64","name":"Channel Management","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","channel","user","property","{{APPID}}","{{cmUID}}","{{AccessChannel}}"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d8e52b7-3273-4dd5-94ee-389448429d96"}],"id":"d766c86f-2b18-4ca3-880d-53d56429f08b","_postman_id":"d766c86f-2b18-4ca3-880d-53d56429f08b","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64","id":"1f1b290c-cc09-4952-b901-f4271390be64","name":"Channel Management","type":"folder"}}}],"id":"1f1b290c-cc09-4952-b901-f4271390be64","description":"In addition to the Voice/Video SDK integrated into the app client, Agora provides RESTful APIs for channel management, with which you can manage users in the channel and query channel statistics at the app server.
\nThis page provides detailed help for the Agora Channel Management RESTful APIs.
\nThis section provides basic information about the Agora Channel Management RESTful APIs.
\nAll requests are sent to the domain name: api.agora.io.
The Content-Type field in all HTTP request headers is application/json. All requests and responses are in JSON format. All request URLs and request bodies are case-sensitive.
The Agora Channel Management RESTful APIs only support HTTPS. Before sending HTTP requests, you must generate a Base64-encoded credential with the Customer ID and Customer Secret provided by Agora, and pass the credential to the Authorization field in the HTTP request header. See HTTP authentication.
For each Agora account (not each App ID), the call frequency of each online channel statistics query API is no more than 20 queries per second, and the call frequency of each other API is no more than 10 queries per second. If you are frequency limited when calling the APIs, please see How can I avoid being frequency limited when calling Agora Server RESTful APIs to optimize API call frequency.
\nCreates a rule of banning specified user privileges.
\nThe user privileges (privileges) that can be banned include the following:
join_channel: Joining a channel.publish_audio: Publishing audio.publish_video: Publishing video.The banning rule works based on the following three fields: cname, uid, and ip.
When you set privileges as join_channel, the rule works as follows:
ip, but not cname or uid, then all users with this ip cannot join any channel in the app.Using ip as a filter field may incorrectly block users who should not be blocked, for example, in a scenario where multiple users share an IP address.cname, but not uid or ip, then no one can join the channel specified by the cname field.Using cname as a filter field directly blocks the channel with the cname.uid, but not cname or ip, then the user with the user ID cannot join any channel in the app.cname and uid, but not ip, then the user with the user ID cannot join the channel specified by the cname field.When you set privileges as publish_audio or publish_video, the rule works as follows:
ip, but not cname or uid, then the users with this ip cannot publish audio or video in any channel of the app.cname, but not uid or ip, then no one can publish audio or video in the channel specified bythe cname field.uid, but not cname or ip, then the user with the user ID cannot publish audio or video inany channel of the app.cname and uid, but not ip, then the user with the user ID cannot publish audio or video inthe channel specified by the cname field.A user who is kicked out of a channel (that is when you set privileges as join_channel) receives one of the following callbacks based on their platform:
onConnectionStateChanged callback reports CONNECTION_CHANGED_BANNED_BY_SERVER(3).connectionChangedToState callback reports AgoraConnectionChangedBannedByServer(3).Client.on(\"client-banned\") callback.Client.on(\"connection-state-change\") callback.onConnectionStateChanged callback reports CONNECTION_CHANGED_BANNED_BY_SERVER(3).AgoraRtcEngine.on(\"connectionStateChanged\") callback reports 3.OnConnectionStateChangedHandler callback reports CONNECTION_CHANGED_BANNED_BY_SERVER(3).ConnectionStateChanged callback reports BannedByServer(3).ConnectionStateChanged callback reports BannedByServer(3).onConnectionStateChanged callback reports CONNECTION_CHANGED_BANNED_BY_SERVER(3).POSThttps://api.agora.io/dev/v1/kicking-ruleRequest body parameters
\nPass in the following parameters in the request body:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 200, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"status\": \"success\",\n \"id\": 1953\n}\n\nGets the list of all banning rules.
\nGEThttps://api.agora.io/dev/v1/kicking-ruleQuery parameters
\nPass the following query parameters in the request URL:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 200, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"status\": \"success\",\n \"rules\": [\n {\n \"id\": 1953,\n \"appid\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"uid\": 589517928,\n \"opid\": 1406,\n \"cname\": \"11\",\n \"ip\": \"192.168.0.1\",\n \"ts\": \"2018-01-09T07:23:06.000Z\",\n \"privileges\": [\n \"join_channel\"\n ],\n \"createAt\": \"2018-01-09T06:23:06.000Z\",\n \"updateAt\": \"2018-01-09T14:23:06.000Z\"\n }\n ]\n}\n\nUpdates the expiration time of a specified banning rule.
\nPUThttps://api.agora.io/dev/v1/kicking-ruleRequest body parameters
\nPass in the following parameters in the request body:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 200, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"status\": \"success\",\n \"result\": {\n \"id\": 1953,\n \"ts\": \"2018-01-09T08:45:54.545Z\"\n }\n}\n\nDeletes a specified banning rule.
\nDELETEhttps://api.agora.io/dev/v1/kicking-ruleRequest body parameters
\nThe following parameters are required in the request body:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 200, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"status\": \"success\",\n \"id\": 1953\n}\n\nGets the status of a specified user.
\nThis method checks if a specified user is in a specified channel, and if yes, the role of this user in the channel.
\nGEThttps://api.agora.io/dev/v1/channel/user/property/{appid}/{uid}/{channelName}Path parameters
\nPass the following path parameters in the request URL:
\nRequest URL
\n1https://api.agora.io/dev/v1/channel/user/property/12sfegxxxxxxxxxxxx365/2845863044/test
For details about possible response status codes, see the Response status codes table.
\nIf the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 200, the request succeeds, and the response body includes the following parameters:
join: Number. The Unix timestamp in seconds of when the user joins the channel.role: Number. The role of the user in the channel:0: Unknown user role.1: User, in a communication channel.2: Host, in an interactive live streaming channel.3: Audience, in an interactive live streaming channel.platform: Number. The platform of the user's device. Common return values include:1: Android2：iOS5: Windows6: Linux7: Web8: macOS0: OthersThe following is a response example for a successful request:
\n{\n \"success\": true,\n \"data\": {\n \"join\": 1640330382,\n \"uid\": 2845863044,\n \"in_channel\": true,\n \"platform\": 7,\n \"role\": 2\n }\n}\n\nGets the list of all users in a specified channel.
\nThe return list differs with the channel profile as follows:
\nCOMMUNICATION profile, this API returns the list of all users in the channel.LIVE_BROADCASTING profile, this API returns the list of all hosts and audience members in the channel.GEThttps://api.agora.io/dev/v1/channel/user/{appid}/{channelName}Path parameters
\nPass the following path parameters in the request URL:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 200, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\nIn COMMUNICATION profile
{\n \"success\": true,\n \"data\": {\n \"channel_exist\": true,\n \"mode\": 1,\n \"total\": 1,\n \"users\": [\n 906218805\n ]\n }\n}\n\nIn LIVE_BROADCASTING profile
{\n \"success\": true,\n \"data\": {\n \"channel_exist\": true,\n \"mode\": 2,\n \"broadcasters\": [\n 2206227541,\n 2845863044\n ],\n \"audience\": [\n 906219905\n ],\n \"audience_total\": 1\n }\n}\n\nGets the list of all channels under a specified project.
\nThis API gets the channel list by page. In the request URL, you can specify the page number and the number of channels shown on the page. A successful request returns the channel list of the specified page according to the set page_size.
If the number of users in a channel changes frequently, the query results may be inaccurate. The following situations may occur:
\nGEThttps://api.agora.io/dev/v1/channel/{appid}Path parameters
\nPass the following path parameters in the request URL:
\nQuery parameters
\nPass the following query parameters in the request URL:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 200, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"success\": true,\n \"data\": {\n \"channels\": [\n {\n \"channel_name\": \"lkj144\",\n \"user_count\": 3\n }\n ],\n \"total_size\": 1\n }\n}\n\nhttps://docs.agora.io/en/video-calling/reference/channel-management-rest-api?platform=android
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d3dc6308-2370-4d19-907a-bccaa6fff287","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d49bc5ab-a1af-4545-8dbf-bdc2c05fc7b5","type":"text/javascript","exec":[""]}}],"_postman_id":"1f1b290c-cc09-4952-b901-f4271390be64"},{"name":"Console API","item":[{"name":"Create","id":"a9b72b7f-311e-4a4a-bb0e-eae772679bda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"enterProjectName\",\n \"enable_sign_key\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/dev/v1/project","description":"Pass in the following parameters in the request body:
\nView More
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"17e4196c-5e11-4bb0-a447-bdf1b3896799","id":"17e4196c-5e11-4bb0-a447-bdf1b3896799","name":"Console API","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","project"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9b72b7f-311e-4a4a-bb0e-eae772679bda"},{"name":"Usage","id":"00717fd9-473e-4a7e-8ef3-c5a195c9abcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.agora.io/dev/v3/usage?from_date={{fromDate}}&to_date={{toDate}}&project_id={{projectId}}&business={{business}}","urlObject":{"protocol":"https","path":["dev","v3","usage"],"host":["api","agora","io"],"query":[{"key":"from_date","value":"{{fromDate}}"},{"key":"to_date","value":"{{toDate}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"business","value":"{{business}}"}],"variable":[]}},"response":[],"_postman_id":"00717fd9-473e-4a7e-8ef3-c5a195c9abcb"},{"name":"Projects","event":[{"listen":"test","script":{"id":"ffdedd69-3ad6-4729-9f57-4741db4740cc","exec":["var jsonData = JSON.parse(responseBody).projects[0];","//grabs the first project in the array to send for Project Details. Change projects[0] to number for specific app id","var id = jsonData.id;","console.log(id);","pm.collectionVariables.set(\"id\", id);","var name = jsonData.name;","console.log(name);","pm.collectionVariables.set(\"name\", name);"],"type":"text/javascript","packages":{}}}],"id":"9286cac4-9f5f-4c0b-b28b-8ea2ef50186c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.agora.io/dev/v1/projects/","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"17e4196c-5e11-4bb0-a447-bdf1b3896799","id":"17e4196c-5e11-4bb0-a447-bdf1b3896799","name":"Console API","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","projects",""],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"9286cac4-9f5f-4c0b-b28b-8ea2ef50186c"},{"name":"Project Details","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"f4b4a008-78d6-4fd7-bc44-a8be9f0b6c9a"}}],"id":"aa683527-4dba-479c-a371-3555d8c5ad67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.agora.io/dev/v1/project?id={{id}}&name={{name}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"17e4196c-5e11-4bb0-a447-bdf1b3896799","id":"17e4196c-5e11-4bb0-a447-bdf1b3896799","name":"Console API","type":"folder"}},"urlObject":{"protocol":"https","path":["dev","v1","project"],"host":["api","agora","io"],"query":[{"key":"id","value":"{{id}}"},{"key":"name","value":"{{name}}"}],"variable":[]}},"response":[],"_postman_id":"aa683527-4dba-479c-a371-3555d8c5ad67"},{"name":"ChannelList","id":"cd43186e-bef8-4f74-8ec4-ccabaa8f2101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.agora.io/dev/v1/channel/{{APPID}}","urlObject":{"protocol":"https","path":["dev","v1","channel","{{APPID}}"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd43186e-bef8-4f74-8ec4-ccabaa8f2101"}],"id":"17e4196c-5e11-4bb0-a447-bdf1b3896799","description":"When you need to create and manage Agora projects or check usage, besides using the graphic user interface at Agora Console, you can also call the Agora Console RESTful API.
\nThis page provides detailed help for the Agora Console RESTful APIs.
\nThis section provides basic information about the Agora Console RESTful APIs.
\nAll requests are sent to the host: api.agora.io.
The Content-Type field in all HTTP request headers is application/json. All requests and responses are in JSON format. All request URLs and request bodies are case-sensitive.
The Agora Console RESTful APIs only support HTTPS. Before sending HTTP requests, you must generate a Base64-encoded credential with the Customer ID and Customer Secret provided by Agora, and pass the credential to the Authorization field in the HTTP request header.
For each Agora account (not each App ID), the call frequency of each API on this page is no more than 10 queries per second.
\nCreates an Agora project.
\nPOSThttps://api.agora.io/dev/v1/projectRequest body parameters
\nPass in the following parameters in the request body:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 201, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 201, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"project\": {\n \"id\": \"xxxx\",\n \"name\": \"project1\",\n \"vendor_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"sign_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"recording_server\": null,\n \"status\": 1,\n \"created\": 1464165672\n }\n}\n\nGets the information on a specified project.
\nGEThttps://api.agora.io/dev/v1/projectQuery parameters
\nPass in the following query parameters in the request URL:
\nRequest URL
\nhttps://api.agora.io/dev/v1/project?id=7sdnf3xRH&name=project1
For details about possible response status codes, see the Response status codes table.
\nIf the status code is not 201, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 201, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"projects\": [\n {\n \"id\": \"xxxx\",\n \"name\": \"project1\",\n \"sign_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"vendor_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"recording_server\": null,\n \"status\": 1,\n \"created\": 1464165672\n }\n ]\n}\n\nGets the information on all your Agora projects.
\nGEThttps://api.agora.io/dev/v1/projectsRequest URL
\nhttps://api.agora.io/dev/v1/projects
For details about possible response status codes, see the Response status codes table.
\nIf the status code is not 201, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 201, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"projects\": [\n {\n \"id\": \"xxxx\",\n \"name\": \"project1\",\n \"sign_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"vendor_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"recording_server\": null,\n \"status\": 1,\n \"created\": 1464165672\n },\n {\n \"id\": \"xxxx\",\n \"name\": \"project1\",\n \"sign_key\": \"2c01da6d6f6741df88ec47005f08572b\",\n \"vendor_key\": \"eb00cd2b222a4eeaa24fc6046d90b227\",\n \"recording_server\": null,\n \"status\": 1,\n \"created\": 1637153755\n }\n ]\n}\n\nDisables or enables a specified Agora project.
\nPOSThttps://api.agora.io/dev/v1/project_statusRequest body parameters
\nPass in the following parameters in the request body:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 201, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 201, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"project\": {\n \"id\": \"xxxx\",\n \"name\": \"project1\",\n \"vendor_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"sign_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"recording_server\": null,\n \"status\": 1,\n \"created\": 1464165672\n }\n}\n\nSets the IP of the recording server for a specified project.
\nPOSThttps://api.agora.io/dev/v1/recording_configRequest body parameters
\nPass in the following parameters in the request body:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 201, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 201, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"project\": {\n \"id\": \"xxxx\",\n \"name\": \"project1\",\n \"vendor_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"sign_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"recording_server\": null,\n \"status\": 1,\n \"created\": 1464165672\n }\n}\n\nEnables or disables the primary app certificate for a specified project.
\nPOSThttps://api.agora.io/dev/v1/signkeyRequest body parameters
\nThe following parameters are required in the request body:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 201, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 201, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"project\": {\n \"id\": \"xxxx\",\n \"name\": \"project1\",\n \"vendor_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"sign_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"recording_server\": null,\n \"status\": 1,\n \"created\": 1464165672\n }\n}\n\nResets the primary app certificate for a specified project.
\nPOSThttps://api.agora.io/dev/v1/reset_signkeyRequest body parameter
\nPass in the following parameter in the request body:
\nFor details about possible response status codes, see the Response status codes table.
\nIf the status code is not 201, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 201, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"project\": {\n \"id\": \"xxxx\",\n \"name\": \"project1\",\n \"vendor_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"sign_key\": \"4855xxxxxxxxxxxxxxxxxxxxxxxxeae2\",\n \"recording_server\": null,\n \"status\": 1,\n \"created\": 1464165672\n }\n}\n\nGets the usage data of a specified project.
\nGEThttps://api.agora.io/dev/v3/usageQuery parameters
\nPass the following query parameters in the request path:
\nRequest path
\nhttps://api.agora.io/dev/v3/usage?project_id=rxxxxxxj5u&from_date=2021-10-12&to_date=2021-12-14&business=default
For details about possible response status codes, see the Response status codes table.
\nIf the status code is not 200, the request fails. See the message field in the response body for the reason for this failure.
If the status code is 200, the request succeeds, and the response body includes the following parameters:
The following is a response example for a successful request:
\n{\n \"meta\": {\n \"durationAudioAll\": {\n \"en\": \"Total Audio Duration\",\n \"unit\": \"second\"\n },\n \"durationVideo1080P\": {\n \"en\": \"Full HD Video Duration（including Recording)\",\n \"unit\": \"second\"\n },\n \"durationVideo2K\": {\n \"en\": \"2K Video Duration（including Recording)\",\n \"unit\": \"second\"\n },\n \"durationVideo4K\": {\n \"en\": \"4K Video Duration（including Recording)\",\n \"unit\": \"second\"\n },\n \"durationVideoHd\": {\n \"en\": \"HD Video Duration（including Recording）\",\n \"unit\": \"second\"\n },\n \"durationVideoHdp\": {\n \"en\": \"HDP Video Duration（including Recording)\",\n \"unit\": \"second\"\n }\n },\n \"usages\": [\n {\n \"date\": \"2021-10-12T00:00:00.000Z\",\n \"usage\": {\n \"durationAudioAll\": 0,\n \"durationVideo1080P\": 0,\n \"durationVideo2K\": 0,\n \"durationVideo4K\": 0,\n \"durationVideoHd\": 0,\n \"durationVideoHdp\": 0\n }\n },\n {\n \"date\": \"2021-10-13T00:00:00.000Z\",\n \"usage\": {\n \"durationAudioAll\": 779,\n \"durationVideo1080P\": 0,\n \"durationVideo2K\": 0,\n \"durationVideo4K\": 0,\n \"durationVideoHd\": 60,\n \"durationVideoHdp\": 0\n }\n },\n {\n \"date\": \"2021-10-14T00:00:00.000Z\",\n \"usage\": {\n \"durationAudioAll\": 0,\n \"durationVideo1080P\": 0,\n \"durationVideo2K\": 0,\n \"durationVideo4K\": 0,\n \"durationVideoHd\": 0,\n \"durationVideoHdp\": 0\n }\n }\n ]\n}\n\nThe following table shows the possible response status codes.
\n200 or 201, the request succeeds.200 nor 201, the request fails. See the message field in the response body for the reason for this failure.https://docs.agora.io/en/video-calling/reference/agora-console-rest-api?platform=android
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":false},"_postman_id":"17e4196c-5e11-4bb0-a447-bdf1b3896799"},{"name":"Cloud Recording Composite","item":[{"name":"acquire","event":[{"listen":"test","script":{"id":"36757890-b6a6-4e8e-9e65-b3b7607547a3","exec":["var jsonData = JSON.parse(responseBody);","var resourceId = jsonData.resourceId;","console.log(resourceId);","pm.collectionVariables.set(\"resourceId\", resourceId);"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"2f94744a-4cfe-409c-bf25-a4a2965a7dd2","exec":[""],"type":"text/javascript","packages":{}}}],"id":"6e47859b-5ab5-47b0-8095-5a3ec3dba54c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cname\": \"{{AccessChannel}}\",\n \"uid\": \"{{RecordingUID}}\",\n \"clientRequest\": {}\n}"},"url":"https://api.agora.io/v1/apps/{{APPID}}/cloud_recording/acquire","description":"The RESTful API requires basic HTTP authentication. You need to set the Authorization parameter in every HTTP request header.
\n\n\nAuthorization header is not visible in Postman Web View, use Run In Postman button above to view full example snippet
\n
Use the Acquire endpoint to receive the reqwuired token (resourceId) needed for use with each of the other Agora.io Cloud Recording endpoints.
If this method call succeeds, you will receive a resource ID (resourceId) from the HTTP response body. The resource ID is valid for five minutes, so you need to start recording with this resource ID within five minutes.
Call the start method within five minutes after getting the resource ID to join a channel and start the recording.
\nIf this method call succeeds, you get a recording ID (sid) from the HTTP response body.
\n\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","mode","{{mode-type}}","start"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"18a8b41e-5f28-4bc7-b179-1ca9713c4dee"},{"name":"stop","event":[{"listen":"test","script":{"id":"1b095f44-a58f-4e02-b8f8-d96007cc1c12","exec":["// var jsonData = JSON.parse(responseBody);","// var serverResponse = jsonData.serverResponse","// console.log(serverResponse);","// postman.setEnvironmentVariable(\"uploadingStatus\", serverResponse.uploadingStatus);"],"type":"text/javascript"}}],"id":"a3b4129a-61e0-4d84-ae24-0a889c37dda4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json;charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cname\": \"{{AccessChannel}}\",\n \"uid\": \"{{RecordingUID}}\",\n \"clientRequest\": {}\n}"},"url":"https://api.agora.io/v1/apps/{{APPID}}/cloud_recording/resourceid//sid/{{sid}}/mode/{{mode-type}}/stop","description":"Note: Agora Cloud Recording does not support string usernames (User Accounts). Ensure that every user in the channel has an integer UID. When you call the start method, ensure that the UID in the quotation marks is an integer UID, too.
\n
Call the stop method to stop the recording.
\nIf this method call succeeds, you get the M3U8 filename and the current uploading status from the HTTP response body.
\n\n\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","sid","{{sid}}","mode","{{mode-type}}","stop"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3b4129a-61e0-4d84-ae24-0a889c37dda4"},{"name":"updateLayout","event":[{"listen":"test","script":{"id":"2446ecc8-23de-4bad-9045-17a5cc4f6fa1","exec":[""],"type":"text/javascript"}}],"id":"b210ff9b-a378-4c98-8593-7d02b8456436","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cname\": \"{{AccessChannel}}\",\n \"uid\": \"{{RecordingUID}}\",\n \"clientRequest\": {\n \"mixedVideoLayout\": 3,\n \"backgroundColor\": \"#FF0000\",\n \"layoutConfig\": [\n {\n \"uid\": \"1\",\n \"x_axis\": 0.1,\n \"y_axis\": 0.1,\n \"width\": 0.1,\n \"height\": 0.1,\n \"alpha\": 1.0,\n \"render_mode\": 1\n },\n {\n \"uid\": \"2\",\n \"x_axis\": 0.2,\n \"y_axis\": 0.2,\n \"width\": 0.1,\n \"height\": 0.1,\n \"alpha\": 1.0,\n \"render_mode\": 1\n }\n ]\n }\n}"},"url":"https://api.agora.io/v1/apps/{{APPID}}/cloud_recording/resourceid//sid/{{sid}}/mode/{{mode-type}}/updateLayout","description":"Agora Cloud Recording automatically leaves the channel and stops recording when no user is in the channel for more than 30 seconds by default.
\n
During a recording, you can call this method to update the video mixing layout multiple times.
\nThis method call overrides the existing layout configurations.
\nFor example, if you set the backgroundColor parameter as \"#FF0000\" (red) when starting a recording and call this method to update the layout without setting the backgroundColor parameter, the background color changes back to black (the default value).
\nThe following parameters are required in the URL.
\nappid String The App ID used in the channel to be recorded.resourceid String The resource ID requested by the acquire method.sid String The recording ID created by the start method.mode String The recording mode. Supports individual mode (individual) and composite mode (mix).The following parameters are required in the request body.
cname String Name of the channel to be recorded.uid String The UID of the recording client. A 32-bit unsigned integer ranging from 1 to (232-1) that is unique in the channel, for example \"527841\". Do not set it as \"0\"clientRequest JSON Object A specific client request. See full details below.clientRequest requires the following parameters:
maxResolutionUid (Optional) String. When the layoutType parameter is set as 2 (vertical layout), you can specify the UID of the large video window by this parameter.mixedVideoLayout (Optional) Number. Sets the video mixing layout. 0, 1, and 2 are the predefined layouts. If you set this parameter as 3, you need to set the layout by the layoutConfig parameter.0 (Default) Floating layout: The first user in the channel occupies the full canvas. The other users occupy the small regions on top of the canvas, starting from the bottom left corner. The small regions are arranged in the order of the users joining the channel. This layout supports one full-size region and up to four rows of small regions on top with four regions per row, comprising 17 users.1 Best fit layout: This is a grid layout. The number of columns and rows and the grid size vary depending on the number of users in the channel. This layout supports up to 17 users.2 Vertical layout: One large region is displayed on the left edge of the canvas, and several smaller regions are displayed along the right edge of the canvas. The space on the right supports up to 2 columns of small regions with 8 regions per column. This layout supports up to 17 users.3 Customized layout: Set the layoutConfig parameter to customize the layout.backgroundColor (Optional) String. The background color of the canvas (the display window or screen) in RGB hex value. The string starts with a \"#\". The default value is \"#000000\", the black color.layoutConfig (Optional) JSONArray. An array of the configuration of each user's region. Supports 17 users at most. Each user's region configuration is a JSON object with the following parameters:uid (Optional) String. The string contains the UID of the user displaying the video in the region. If this parameter is not specified, the configurations apply in the order of the users joining the channel.x_axis (Mandatory) Float. Relative horizontal position of the top-left corner of the region. The value is between 0.0 (leftmost) and 1.0 (rightmost). x_axis can also be an integer 0 or 1.y_axis (Mandatory) Float. Relative vertical position of the top-left corner of the region. The value is between 0.0 (top) and 1.0 (bottom). y_axis can also be an integer 0 or 1.width (Mandatory) Float. Relative width of the region. The value is between 0.0 and 1.0. width can also be an integer 0 or 1.height (Mandatory) Float. Relative height of the region. The value is between 0.0 and 1.0. height can also be an integer 0 or 1.alpha (Optional) Float. The transparency of the image. The value is between 0.0 (transparent) and 1.0 (opaque). The default value is 1.0.render_mode (Optional) Number. The video display mode:0 (Default) Cropped mode: Uniformly scales the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.1 Fit mode: Uniformly scales the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio will be filled with black.During the recording, you can call the query method to check the recording status multiple times.
\nIf this method call succeeds, you get the M3U8 filename and the current recording status from the HTTP response body.
\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","sid","{{sid}}","mode","{{mode-type}}","query"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7ff0d1e-d641-4311-8e24-55b4d579502b"},{"name":"get-ncs-ip","id":"767310bf-efdb-46cf-bb7d-1583eb041aca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.agora.io/v1/ncs/ip","urlObject":{"protocol":"https","path":["v1","ncs","ip"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"767310bf-efdb-46cf-bb7d-1583eb041aca"}],"id":"f1e01a23-d164-47b0-b155-eb1bd78fcde7","description":"A collection of the Cloud Recording API requests. With the Agora Cloud Recording RESTful API, you can send requests to do the following things:
\nAgora Cloud Recording API - official documentation
\n\n\nNote: due to limitation with the Web view of this collection, certain elements are not visibile within the web version of this documentation use the Run In Postman button above to view full examples of each snippet
\n
The variables below are used throughout this documentation. Use the Run In Postman button above to open the collection within Postman and set up an environment with the variables below.
\n![](\"https://miro.medium.com/max/3200/1\\\\\\*ok4R5IgAfVKtkcRomdbZlA.png\")
\n\n\n\nAgora Cloud Recording does not support string usernames (User Accounts). Ensure that every user in the channel has an integer UID. When you call the start method, ensure that the UID in the quotation marks is an integer UID, too.
\n
The recording ID is the unique identification of a recording. Each cloud recording session has a unique recording ID.
\nAfter starting the recording with the start request, you can get the recording ID from its response. You can also get the recording ID from any of the callbacks.
\n\n\nOne resource ID can only be used for one recording session.
\n
In individual recording mode, if you choose to record audio or video only, each recording session generates one M3U8 file; if you record both audio and video, each recording session generates two M3U8 files. The M3U8 file is a playlist pointing to all the split TS/WebM files of the recording. You can use the M3U8 file to play and manage the recorded files. For detailed information about the naming conventions of the M3U8 and TS/WebM files in individual recording mode, see Manage Recorded Files.
\nIn composite recording mode, each recording session generates one M3U8 file. The name of the M3U8 file is sid_cname.m3u8, which consists of the recording ID and the channel name.
If you want to receive the M3U8, the ts files, and a mp4, please add this config to your start request.
\n \"recordingFileConfig\": {\n \"avFileType\": [\n \"hls\",\n \"mp4\"\n ]\n }\n\nThe Agora Cloud Recording RESTful API provides a callback service. After enabling the callback service, you can receive notifications about cloud recording events.
\n\n\nThe Agora server automatically uploads the recorded files. Pay attention to the following callbacks.
\n
During the recording, the SDK triggers the following callback once every minute:
\nuploading_progress Reports the upload progress (%) of the recorded files.uploaded Occurs when all the recorded files are uploaded to the third-party cloud storage.backuped Occurs when some of the recorded files fail to upload to the third-party cloud storage and upload to Agora Cloud Backup instead. Agora Cloud Backup automatically uploads these files to your cloud storage.\n\nIf you cannot play the recorded files after five minutes, contact Agora technical support.
\n
\n\nIf uploading takes a long time, the stop response returns the
\nHTTP 206status code, indicating that the recording stops but the uploading status isunknown. You need to get the uploading status from the callback events.
\n\nThe Agora.io Cloud Recording automatically leaves the channel and stops recording when no user is in the channel for more than 30 seconds by default.
\n
acquire to get a resource ID before calling startquery after calling stopThe following are some common errors:
\nacquire ➡ start ➡ startHTTP 201 status code and error code: 7acquire ➡ start ➡ acquire ➡ startacquire and start requests with the same parameters returns the HTTP 400 status code and error code: 53acquire ➡ start ➡ Recording stops ➡ queryquery after the recording stops returns the HTTP 404 status code and error code: 404stop.transcodingConfig or storageConfig in the start request are invalid.acquire ➡ start ➡ stop & querystop together with query affects the response of stop: The HTTP 206 status code and the response does not have the fileList field.The RESTful API requires basic HTTP authentication. You need to set the Authorization parameter in every HTTP request header.
\n\n\nAuthorization header is not visible in Postman Web View, use Run In Postman button above to view full example snippet
\n
Use the Acquire endpoint to receive the reqwuired token (resourceId) needed for use with each of the other Agora.io Cloud Recording endpoints.
If this method call succeeds, you will receive a resource ID (resourceId) from the HTTP response body. The resource ID is valid for five minutes, so you need to start recording with this resource ID within five minutes.
Call the start method within five minutes after getting the resource ID to join a channel and start the recording.
\nIf this method call succeeds, you get a recording ID (sid) from the HTTP response body.
\n\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","mode","{{mode-type}}","start"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"4825854b-b3c3-4501-899b-4a4993e4bb87"},{"name":"stop","event":[{"listen":"test","script":{"id":"1313a971-41b3-4b4a-a466-97e451a3b13d","exec":["// var jsonData = JSON.parse(responseBody);","// var serverResponse = jsonData.serverResponse","// console.log(serverResponse);","// postman.setEnvironmentVariable(\"uploadingStatus\", serverResponse.uploadingStatus);"],"type":"text/javascript"}}],"id":"3d965878-cc1e-4351-b4d1-d82e6ea764de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json;charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cname\": \"{{AccessChannel}}\",\n \"uid\": \"{{RecordingUID}}\",\n \"clientRequest\": {}\n}"},"url":"https://api.agora.io/v1/apps/{{APPID}}/cloud_recording/resourceid//sid/{{sid}}/mode/{{mode-type}}/stop","description":"Note: Agora Cloud Recording does not support string usernames (User Accounts). Ensure that every user in the channel has an integer UID. When you call the start method, ensure that the UID in the quotation marks is an integer UID, too.
\n
Call the stop method to stop the recording.
\nIf this method call succeeds, you get the M3U8 filename and the current uploading status from the HTTP response body.
\n\n\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","sid","{{sid}}","mode","{{mode-type}}","stop"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d965878-cc1e-4351-b4d1-d82e6ea764de"},{"name":"query","event":[{"listen":"test","script":{"exec":["// var jsonData = JSON.parse(responseBody);","// var serverResponse = jsonData.serverResponse","// console.log(serverResponse);","// postman.setEnvironmentVariable(\"serverResponseFileList\", serverResponse.fileList);","// postman.setEnvironmentVariable(\"serverResponseStatus\", serverResponse.status);"],"type":"text/javascript","id":"d9074bf0-d534-42d6-a55c-71297c690ad0"}}],"id":"439967bc-95a9-41b8-a7db-d07a5e694615","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.agora.io/v1/apps/{{APPID}}/cloud_recording/resourceid//sid/{{sid}}/mode/{{mode-type}}/query","description":"Agora Cloud Recording automatically leaves the channel and stops recording when no user is in the channel for more than 30 seconds by default.
\n
During the recording, you can call the query method to check the recording status multiple times.
\nIf this method call succeeds, you get the M3U8 filename and the current recording status from the HTTP response body.
\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","sid","{{sid}}","mode","{{mode-type}}","query"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"439967bc-95a9-41b8-a7db-d07a5e694615"}],"id":"d3952ff0-9cd7-4a82-abec-29b63735cb4f","description":"A collection of the Cloud Recording API requests. With the Agora.io Cloud Recording RESTful API, you can send requests to do the following things:
\nAgora.io Cloud Recording API - official documentation
\n\n\nNote: due to limitation with the Web view of this collection, certain elements are not visibile within the web version of this documentation use the Run In Postman button above to view full examples of each snippet
\n
The variables below are used throughout this documentation. Use the Run In Postman button above to open the collection within Postman and set up an environment with the variables below.
\nAPPID
\nCustomerID
\nCustomerSecret
\nresourceId
\nAccessChannel
\nRecordingUID
\nStorageVendor
\nStorageRegion
\nBucket
\nAccessKey
\nSecretKey
\nsid
\n![](\"https://miro.medium.com/max/3200/1\\*ok4R5IgAfVKtkcRomdbZlA.png\")
\n\n\n\nAgora Cloud Recording does not support string usernames (User Accounts). Ensure that every user in the channel has an integer UID. When you call the start method, ensure that the UID in the quotation marks is an integer UID, too.
\n
The recording ID is the unique identification of a recording. Each cloud recording session has a unique recording ID.
\nAfter starting the recording with the start request, you can get the recording ID from its response. You can also get the recording ID from any of the callbacks.
\n\n\nOne resource ID can only be used for one recording session.
\n
In individual recording mode, if you choose to record audio or video only, each recording session generates one M3U8 file; if you record both audio and video, each recording session generates two M3U8 files. The M3U8 file is a playlist pointing to all the split TS/WebM files of the recording. You can use the M3U8 file to play and manage the recorded files. For detailed information about the naming conventions of the M3U8 and TS/WebM files in individual recording mode, see Manage Recorded Files.
\nIn composite recording mode, each recording session generates one M3U8 file. The name of the M3U8 file is sid_cname.m3u8, which consists of the recording ID and the channel name.
The Agora Cloud Recording RESTful API provides a callback service. After enabling the callback service, you can receive notifications about cloud recording events.
\n\n\nThe Agora server automatically uploads the recorded files. Pay attention to the following callbacks.
\n
During the recording, the SDK triggers the following callback once every minute:
\nuploading_progress Reports the upload progress (%) of the recorded files.uploaded Occurs when all the recorded files are uploaded to the third-party cloud storage.backuped Occurs when some of the recorded files fail to upload to the third-party cloud storage and upload to Agora Cloud Backup instead. Agora Cloud Backup automatically uploads these files to your cloud storage.\n\nIf you cannot play the recorded files after five minutes, contact Agora technical support.
\n
\n\nIf uploading takes a long time, the stop response returns the
\nHTTP 206status code, indicating that the recording stops but the uploading status isunknown. You need to get the uploading status from the callback events.
\n\nThe Agora.io Cloud Recording automatically leaves the channel and stops recording when no user is in the channel for more than 30 seconds by default.
\n
acquire to get a resource ID before calling startquery after calling stopThe following are some common errors:
\nacquire ➡ start ➡ startHTTP 201 status code and error code: 7acquire ➡ start ➡ acquire ➡ startacquire and start requests with the same parameters returns the HTTP 400 status code and error code: 53acquire ➡ start ➡ Recording stops ➡ queryquery after the recording stops returns the HTTP 404 status code and error code: 404stop.transcodingConfig or storageConfig in the start request are invalid.acquire ➡ start ➡ stop & querystop together with query affects the response of stop: The HTTP 206 status code and the response does not have the fileList field.The RESTful API requires basic HTTP authentication. You need to set the Authorization parameter in every HTTP request header.
\n\n\nAuthorization header is not visible in Postman Web View, use Run In Postman button above to view full example snippet
\n
Use the Acquire endpoint to receive the reqwuired token (resourceId) needed for use with each of the other Agora.io Cloud Recording endpoints.
If this method call succeeds, you will receive a resource ID (resourceId) from the HTTP response body. The resource ID is valid for five minutes, so you need to start recording with this resource ID within five minutes.
Call the start method within five minutes after getting the resource ID to join a channel and start the recording.
\nIf this method call succeeds, you get a recording ID (sid) from the HTTP response body.
\n\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","mode","{{mode-type}}","start"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"9743f8ce-ef00-412e-9f37-3c61689f973f"},{"name":"stop","event":[{"listen":"test","script":{"id":"203914fc-36af-4b74-ad72-3dbb0526a637","exec":["// var jsonData = JSON.parse(responseBody);","// var serverResponse = jsonData.serverResponse","// console.log(serverResponse);","// postman.setEnvironmentVariable(\"uploadingStatus\", serverResponse.uploadingStatus);"],"type":"text/javascript"}}],"id":"bb6d6e58-e437-4b97-859e-0c9218cf1f40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json;charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cname\": \"{{AccessChannel}}\",\n \"uid\": \"{{RecordingUID}}\",\n \"clientRequest\": {}\n}"},"url":"https://api.agora.io/v1/apps/{{APPID}}/cloud_recording/resourceid//sid/{{sid}}/mode/{{mode-type}}/stop","description":"Note: Agora Cloud Recording does not support string usernames (User Accounts). Ensure that every user in the channel has an integer UID. When you call the start method, ensure that the UID in the quotation marks is an integer UID, too.
\n
Call the stop method to stop the recording.
\nIf this method call succeeds, you get the M3U8 filename and the current uploading status from the HTTP response body.
\n\n\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","sid","{{sid}}","mode","{{mode-type}}","stop"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb6d6e58-e437-4b97-859e-0c9218cf1f40"},{"name":"updateLayout","event":[{"listen":"test","script":{"id":"06272db7-4f34-44a3-87ea-f34f89ee84a7","exec":[""],"type":"text/javascript"}}],"id":"6365c7c0-ce61-49e6-9b6e-e60dfdb4b912","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cname\": \"{{AccessChannel}}\",\n \"uid\": \"{{RecordingUID}}\",\n \"clientRequest\": {\n \"mixedVideoLayout\": 3,\n \"backgroundColor\": \"#FF0000\",\n \"layoutConfig\": [\n {\n \"uid\": \"1\",\n \"x_axis\": 0.1,\n \"y_axis\": 0.1,\n \"width\": 0.1,\n \"height\": 0.1,\n \"alpha\": 1.0,\n \"render_mode\": 1\n },\n {\n \"uid\": \"2\",\n \"x_axis\": 0.2,\n \"y_axis\": 0.2,\n \"width\": 0.1,\n \"height\": 0.1,\n \"alpha\": 1.0,\n \"render_mode\": 1\n }\n ]\n }\n}"},"url":"https://api.agora.io/v1/apps/{{APPID}}/cloud_recording/resourceid//sid/{{sid}}/mode/{{mode-type}}/updateLayout","description":"Agora Cloud Recording automatically leaves the channel and stops recording when no user is in the channel for more than 30 seconds by default.
\n
During a recording, you can call this method to update the video mixing layout multiple times.
\nThis method call overrides the existing layout configurations.
\nFor example, if you set the backgroundColor parameter as \"#FF0000\" (red) when starting a recording and call this method to update the layout without setting the backgroundColor parameter, the background color changes back to black (the default value).
\nThe following parameters are required in the URL.
\nappid String The App ID used in the channel to be recorded.resourceid String The resource ID requested by the acquire method.sid String The recording ID created by the start method.mode String The recording mode. Supports individual mode (individual) and composite mode (mix).The following parameters are required in the request body.
cname String Name of the channel to be recorded.uid String The UID of the recording client. A 32-bit unsigned integer ranging from 1 to (232-1) that is unique in the channel, for example \"527841\". Do not set it as \"0\"clientRequest JSON Object A specific client request. See full details below.clientRequest requires the following parameters:
maxResolutionUid (Optional) String. When the layoutType parameter is set as 2 (vertical layout), you can specify the UID of the large video window by this parameter.mixedVideoLayout (Optional) Number. Sets the video mixing layout. 0, 1, and 2 are the predefined layouts. If you set this parameter as 3, you need to set the layout by the layoutConfig parameter.0 (Default) Floating layout: The first user in the channel occupies the full canvas. The other users occupy the small regions on top of the canvas, starting from the bottom left corner. The small regions are arranged in the order of the users joining the channel. This layout supports one full-size region and up to four rows of small regions on top with four regions per row, comprising 17 users.1 Best fit layout: This is a grid layout. The number of columns and rows and the grid size vary depending on the number of users in the channel. This layout supports up to 17 users.2 Vertical layout: One large region is displayed on the left edge of the canvas, and several smaller regions are displayed along the right edge of the canvas. The space on the right supports up to 2 columns of small regions with 8 regions per column. This layout supports up to 17 users.3 Customized layout: Set the layoutConfig parameter to customize the layout.backgroundColor (Optional) String. The background color of the canvas (the display window or screen) in RGB hex value. The string starts with a \"#\". The default value is \"#000000\", the black color.layoutConfig (Optional) JSONArray. An array of the configuration of each user's region. Supports 17 users at most. Each user's region configuration is a JSON object with the following parameters:uid (Optional) String. The string contains the UID of the user displaying the video in the region. If this parameter is not specified, the configurations apply in the order of the users joining the channel.x_axis (Mandatory) Float. Relative horizontal position of the top-left corner of the region. The value is between 0.0 (leftmost) and 1.0 (rightmost). x_axis can also be an integer 0 or 1.y_axis (Mandatory) Float. Relative vertical position of the top-left corner of the region. The value is between 0.0 (top) and 1.0 (bottom). y_axis can also be an integer 0 or 1.width (Mandatory) Float. Relative width of the region. The value is between 0.0 and 1.0. width can also be an integer 0 or 1.height (Mandatory) Float. Relative height of the region. The value is between 0.0 and 1.0. height can also be an integer 0 or 1.alpha (Optional) Float. The transparency of the image. The value is between 0.0 (transparent) and 1.0 (opaque). The default value is 1.0.render_mode (Optional) Number. The video display mode:0 (Default) Cropped mode: Uniformly scales the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.1 Fit mode: Uniformly scales the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio will be filled with black.During the recording, you can call the query method to check the recording status multiple times.
\nIf this method call succeeds, you get the M3U8 filename and the current recording status from the HTTP response body.
\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","sid","{{sid}}","mode","{{mode-type}}","query"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b46cb22-7a72-446c-ac46-fa069bc0abc9"}],"id":"7a040ae7-9e29-4f4e-9f45-ccbf5082a2ae","description":"A collection of the Cloud Recording API requests. With the Agora.io Cloud Recording RESTful API, you can send requests to do the following things:
\nAgora.io Cloud Recording API - official documentation
\n\n\nNote: due to limitation with the Web view of this collection, certain elements are not visibile within the web version of this documentation use the Run In Postman button above to view full examples of each snippet
\n
The variables below are used throughout this documentation. Use the Run In Postman button above to open the collection within Postman and set up an environment with the variables below.
\nAPPID
\nCustomerID
\nCustomerSecret
\nresourceId
\nAccessChannel
\nRecordingUID
\nStorageVendor
\nStorageRegion
\nBucket
\nAccessKey
\nSecretKey
\nsid
\n\n\n\n\nAgora Cloud Recording does not support string usernames (User Accounts). Ensure that every user in the channel has an integer UID. When you call the start method, ensure that the UID in the quotation marks is an integer UID, too.
\n
The recording ID is the unique identification of a recording. Each cloud recording session has a unique recording ID.
\nAfter starting the recording with the start request, you can get the recording ID from its response. You can also get the recording ID from any of the callbacks.
\n\n\nOne resource ID can only be used for one recording session.
\n
In individual recording mode, if you choose to record audio or video only, each recording session generates one M3U8 file; if you record both audio and video, each recording session generates two M3U8 files. The M3U8 file is a playlist pointing to all the split TS/WebM files of the recording. You can use the M3U8 file to play and manage the recorded files. For detailed information about the naming conventions of the M3U8 and TS/WebM files in individual recording mode, see Manage Recorded Files.
\nIn composite recording mode, each recording session generates one M3U8 file. The name of the M3U8 file is sid_cname.m3u8, which consists of the recording ID and the channel name.
The Agora Cloud Recording RESTful API provides a callback service. After enabling the callback service, you can receive notifications about cloud recording events.
\n\n\nThe Agora server automatically uploads the recorded files. Pay attention to the following callbacks.
\n
During the recording, the SDK triggers the following callback once every minute:
\nuploading_progress Reports the upload progress (%) of the recorded files.uploaded Occurs when all the recorded files are uploaded to the third-party cloud storage.backuped Occurs when some of the recorded files fail to upload to the third-party cloud storage and upload to Agora Cloud Backup instead. Agora Cloud Backup automatically uploads these files to your cloud storage.\n\nIf you cannot play the recorded files after five minutes, contact Agora technical support.
\n
\n\nIf uploading takes a long time, the stop response returns the
\nHTTP 206status code, indicating that the recording stops but the uploading status isunknown. You need to get the uploading status from the callback events.
\n\nThe Agora.io Cloud Recording automatically leaves the channel and stops recording when no user is in the channel for more than 30 seconds by default.
\n
acquire to get a resource ID before calling startquery after calling stopThe following are some common errors:
\nacquire ➡ start ➡ startHTTP 201 status code and error code: 7acquire ➡ start ➡ acquire ➡ startacquire and start requests with the same parameters returns the HTTP 400 status code and error code: 53acquire ➡ start ➡ Recording stops ➡ queryquery after the recording stops returns the HTTP 404 status code and error code: 404stop.transcodingConfig or storageConfig in the start request are invalid.acquire ➡ start ➡ stop & querystop together with query affects the response of stop: The HTTP 206 status code and the response does not have the fileList field.The RESTful API requires basic HTTP authentication. You need to set the Authorization parameter in every HTTP request header.
\n\n\nAuthorization header is not visible in Postman Web View, use Run In Postman button above to view full example snippet
\n
Use the Acquire endpoint to receive the reqwuired token (resourceId) needed for use with each of the other Agora.io Cloud Recording endpoints.
If this method call succeeds, you will receive a resource ID (resourceId) from the HTTP response body. The resource ID is valid for five minutes, so you need to start recording with this resource ID within five minutes.
Call the start method within five minutes after getting the resource ID to join a channel and start the recording.
\nIf this method call succeeds, you get a recording ID (sid) from the HTTP response body.
\n\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","mode","{{mode-type}}","start"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"551e9154-656f-4bb7-8d11-48241d1f598a"},{"name":"stop","event":[{"listen":"test","script":{"exec":["// var jsonData = JSON.parse(responseBody);","// var serverResponse = jsonData.serverResponse","// console.log(serverResponse);","// postman.setEnvironmentVariable(\"uploadingStatus\", serverResponse.uploadingStatus);"],"type":"text/javascript","id":"d227a545-464c-4ced-b8e8-0450cd47a059"}}],"id":"5d9cbe8f-99a7-4dd4-8646-323ff2d23938","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json;charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cname\": \"{{AccessChannel}}\",\n \"uid\": \"{{RecordingUID}}\",\n \"clientRequest\": {}\n}"},"url":"https://api.agora.io/v1/apps/{{APPID}}/cloud_recording/resourceid//sid/{{sid}}/mode/{{mode-type}}/stop","description":"Note: Agora Cloud Recording does not support string usernames (User Accounts). Ensure that every user in the channel has an integer UID. When you call the start method, ensure that the UID in the quotation marks is an integer UID, too.
\n
Call the stop method to stop the recording.
\nIf this method call succeeds, you get the M3U8 filename and the current uploading status from the HTTP response body.
\n\n\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","sid","{{sid}}","mode","{{mode-type}}","stop"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d9cbe8f-99a7-4dd4-8646-323ff2d23938"},{"name":"query","event":[{"listen":"test","script":{"exec":["// var jsonData = JSON.parse(responseBody);","// var serverResponse = jsonData.serverResponse","// console.log(serverResponse);","// postman.setEnvironmentVariable(\"serverResponseFileList\", serverResponse.fileList);","// postman.setEnvironmentVariable(\"serverResponseStatus\", serverResponse.status);"],"type":"text/javascript","id":"cb25ea15-342e-4d41-a3ad-4819479f084d"}}],"id":"fae90db7-5ea3-47d9-b9ab-55462cbbcab3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.agora.io/v1/apps/{{APPID}}/cloud_recording/resourceid//sid/{{sid}}/mode/{{mode-type}}/query","description":"Agora Cloud Recording automatically leaves the channel and stops recording when no user is in the channel for more than 30 seconds by default.
\n
During the recording, you can call the query method to check the recording status multiple times.
\nIf this method call succeeds, you get the M3U8 filename and the current recording status from the HTTP response body.
\n","urlObject":{"protocol":"https","path":["v1","apps","{{APPID}}","cloud_recording","resourceid","","sid","{{sid}}","mode","{{mode-type}}","query"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"fae90db7-5ea3-47d9-b9ab-55462cbbcab3"}],"id":"598a61b6-bc97-4c7f-9ff8-1d61616c82ff","description":"A collection of the Cloud Recording API requests. With the Agora.io Cloud Recording RESTful API, you can send requests to do the following things:
\nAgora.io Cloud Recording API - official documentation
\n\n\nNote: due to limitation with the Web view of this collection, certain elements are not visibile within the web version of this documentation use the Run In Postman button above to view full examples of each snippet
\n
The variables below are used throughout this documentation. Use the Run In Postman button above to open the collection within Postman and set up an environment with the variables below.
\n
\n\nAgora Cloud Recording does not support string usernames (User Accounts). Ensure that every user in the channel has an integer UID. When you call the start method, ensure that the UID in the quotation marks is an integer UID, too.
\n
The recording ID is the unique identification of a recording. Each cloud recording session has a unique recording ID.
\nAfter starting the recording with the start request, you can get the recording ID from its response. You can also get the recording ID from any of the callbacks.
\n\n\nOne resource ID can only be used for one recording session.
\n
In individual recording mode, if you choose to record audio or video only, each recording session generates one M3U8 file; if you record both audio and video, each recording session generates two M3U8 files. The M3U8 file is a playlist pointing to all the split TS/WebM files of the recording. You can use the M3U8 file to play and manage the recorded files. For detailed information about the naming conventions of the M3U8 and TS/WebM files in individual recording mode, see Manage Recorded Files.
\nIn composite recording mode, each recording session generates one M3U8 file. The name of the M3U8 file is sid_cname.m3u8, which consists of the recording ID and the channel name.
The Agora Cloud Recording RESTful API provides a callback service. After enabling the callback service, you can receive notifications about cloud recording events.
\n\n\nThe Agora server automatically uploads the recorded files. Pay attention to the following callbacks.
\n
During the recording, the SDK triggers the following callback once every minute:
\nuploading_progress Reports the upload progress (%) of the recorded files.\nAfter the recording stops, the SDK triggers one of the following callbacks:uploaded Occurs when all the recorded files are uploaded to the third-party cloud storage.backuped Occurs when some of the recorded files fail to upload to the third-party cloud storage and upload to Agora Cloud Backup instead. Agora Cloud Backup automatically uploads these files to your cloud storage.\n\nIf you cannot play the recorded files after five minutes, contact Agora technical support.
\n
\n\nIf uploading takes a long time, the stop response returns the
\nHTTP 206status code, indicating that the recording stops but the uploading status isunknown. You need to get the uploading status from the callback events.
\n\nThe Agora.io Cloud Recording automatically leaves the channel and stops recording when no user is in the channel for more than 30 seconds by default.
\n
acquire to get a resource ID before calling startquery after calling stopThe following are some common errors:
\ncalling enpoints with sequence: acquire ➡ start ➡ start
Repeating the start request with the same resource ID returns the HTTP 201 status code and error code: 7
calling enpoints with sequence: acquire ➡ start ➡ acquire ➡ start
Repeating the acquire and start requests with the same parameters returns the HTTP 400 status code and error code: 53
calling enpoints with sequence: acquire ➡ start ➡ Recording stops ➡ query
Calling query after the recording stops returns the HTTP 404 status code and error code: 404
The recording stops in the following situations:
\nWhen you call stop.
When no user is in the channel for the idle time (30 seconds by default).
\nWhen the asynchronous parameter check finds errors. This means that some parameters of transcodingConfig or storageConfig in the start request are invalid.
calling enpoints with sequence: acquire ➡ start ➡ stop & query
Calling stop together with query affects the response of stop: The HTTP 206 status code and the response does not have the fileList field.
For the user events and channel events RESTful API, the number of requests per second for each App ID must not exceed 10.
\nThe Signaling RESTful API only supports HTTPS. You can use either of the following methods to authenticate your HTTP request:
\n\nFor basic HTTP authentication, you need to put api_key:api_secret in the Authorization field of the HTTP header. For more information on how to generate the Authorization filed, see RESTful API authentication.
For token authentication, you need to put the following information to the x-agora-token field and the x-agora-uid field when sending your HTTP request:
For more information on how to generate the x-agora-token field and the x-agora-uid field, see RESTful API authentication.
All requests are sent to the host: api.agora.io.
https://api.agora.io/dev/v2/project/\n\nNote: is the App ID used by your project. All the request URLs and request bodies are case-sensitive.
\n
This method gets the user events from the address specified by the Agora Signaling server. Events you acquired from this API are removed from the Agora Signaling server. You cannot get the same event twice.
\n\n\n\n
\n- The number of requests per second for each App ID must not exceed 10.
\n- The Signaling backend stores a maximum of 2,000 events. If the number of events exceeds 2,000, the latest event replaces the oldest event.
\n- The backend returns a maximum of 1,000 events each time.
\n- Agora does not guarantee the time sequence of events across geographical regions (countries or continents), because Agora stores events by geographical regions.
\n- If you have pulled events from one geographical region, you may get the same events when you pull from a different geographical region. This is because Agora only synchronize events within a geographical region and does not synchronize events across geographical regions.
\n
https://api.agora.io/dev/v2/project/876922cbca0098dff4323566daa89675/rtm/vendor/user_events
{\n \"result\": \"success\",\n \"request_id\" : \"10116762670167749259\",\n \"events\" : [event]\n}\n\n[event] contains the following content:
{\n \"user_id\": \"rtmtest_RTM_4852_4857w7%\",\n \"type\" : \"Login\",\n \"ms\" : 1578027420761\n}\n\nThis method gets the channel events from the address specified by the Agora Signaling server. Events you acquired from this API are removed from the Agora Signaling server. You cannot get the same event twice.
\n\n\n\n
\n- The number of requests per second for each App ID must not exceed 10.
\n- The Signaling server stores a maximum of 2,000 events. If the number of events exceeds 2,000, the latest event replaces the oldest event.
\n- The backend returns a maximum of 1,000 events each time.
\n- Agora does not guarantee the time sequence of events across geographical regions (countries or continents), because Agora stores events by geographical regions.
\n- If you have pulled events from one geographical region, you may get the same events when you pull from a different geographical region. This is because Agora only synchronize events within a geographical region and does not synchronize events across geographical regions.
\n
https://api.agora.io/dev/v2/project/876922cbca0098dff4323566daa89675/rtm/vendor/channel_events
{\n \"result\": \"success\",\n \"request_id\" : \"10116762670167749259\",\n \"events\" : [event]\n}\n\n[event] contains the following content:
{\n \"group_id\": \"example_channel_id\",\n \"user_id\": \"rtmtest_RTM_4852_4857w7%\",\n \"type\" : \"Join\",\n \"ms\" : 1578027418981\n}\n\nThe following table contains the most common HTTP status codes for Signaling.
\nYou use this API to send messages to a user or a channel.
\nFor basic HTTP authentication, you can send peer-to-peer or channel messages with any user ID. For token authentication, you send peer-to-peer or channel messages with only the user ID used to generate the Signaling token.
\nIf the messaging time delay from the server to the client must be less than 200 ms, Agora recommends that you use the Signaling SDK for Linux C++ or the Signaling SDK for Linux Java to send messages from the server to the client.
\nYou need to pass the basic HTTP authentication and put api_key:api_secret in the Authorization field of the HTTP header. For more information on how to generate the Authorization field, see Secure authentication with tokens.
If you have already generated an Signaling Token on your server, you can use token authentication. You need to put the following information to the x-agora-token field and the x-agora-uid field when sending your HTTP request:
The following sample code shows how to implement token authentication in Java:
\nRequest request = new Request.Builder()\n...\n// Puts your Signaling Token to the `x-agora-token` field of the HTTP request.\n.addHeader(\"x-agora-token\", \"\")\n// Puts the uid, which generates the Signaling token, to the `x-agora-uid` field of the HTTP request.\n.addHeader(\"x-agora-uid\", \"\")\n...\n\nFor more information about how to generate an Signaling Token, see Secure authentication with tokens.
\nAll requests are sent to the host: api.agora.io.
https://api.agora.io/dev/v2/project/'appid' is the App ID used by your project. All the request URLs and request bodies are case-sensitive.
\n/rtm/users//peer_messagesSends a peer-to-peer message from the server. The user who sends the message does not have to log into Signaling.
\nFor each app ID, the maximum combined frequency of the Sends peer-to-peer message API and the Sends channel message API is 500 calls per second.
\nThe following figure shows the process in which the server sends a peer-to-peer message to the Signaling SDK.
\nThe receiver is online and wait_for_ack is true
wait_for_ack is false
This API has the following URL parameters:
\nThis API has the following query parameters:
\nThis API has the following request body parameters:
\nThis API has the following response body parameters:
\nhttps://api.agora.io/dev/v2/project/876922cbca0098dff4323566daa89675/rtm/users/userA/peer_messages?wait_for_ack=trueContent-type is application/json;charset=utf-8Authorization is basic HTTP or token. See RESTful API Authentication.The message has been sent:
\n{\n \"result\": \"success\",\n \"request_id\": \"123\",\n \"code\": \"message_sent\"\n}\n\nThe message has been received:
\n{\n \"result\": \"success\",\n \"request_id\": \"123\",\n \"code\": \"message_delivered\"\n}\n\nThe receiver is offline:
\n{\n \"request_id\": \"123\",\n \"code\": \"message_offline\"\n}\n\n/rtm/users//channel_messagesSends a channel message from the server. You can send a message to a channel without having to join it first.
\nFor each app ID, the maximum combined frequency of the Sends peer-to-peer message API and the Sends channel message API is 500 calls per second.
\nThis API has the following URL parameters:
\nThis API has the following request body parameters:
\nThis API has the following response body parameters:
\nhttps://api.agora.io/dev/v2/project/876922cbca0098dff4323566daa89675/rtm/users/userA/channel_messagesContent-type is application/json;charset=utf-8Authorization is basic HTTP or token. See Secure authentication with tokens.{\n \"code\": \"message_sent\",\n \"request_id\": \"123\",\n \"result\": \"success\"\n}\n\nhttps://docs.agora.io/en/signaling/reference/restful-messaging?platform=android
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"77050d9d-8e7a-4329-a395-4b8388a0249d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0424b20b-a066-4ae2-88e0-e0774238423e","type":"text/javascript","exec":[""]}}],"_postman_id":"096a65fd-46ea-42cb-861b-d6804bfca207"},{"name":"Real-Time STT 7.x","item":[{"name":"start","event":[{"listen":"prerequest","script":{"id":"46a42dee-317d-4063-a460-0696e2f0ef49","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"991b2365-3e62-41d7-8876-d3b87d4b15da","exec":["var jsonData = JSON.parse(responseBody);\r","pm.collectionVariables.set(\"agentId\", jsonData.agent_id);\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"905e6096-42b9-46a1-9741-ff354a01fd43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"languages\": [\r\n \"en-US\"\r\n ],\r\n \"name\": \"{{channelName}}\",\r\n \"maxIdleTime\": 60,\r\n \"rtcConfig\": {\r\n \"channelName\": \"{{channelName}}\",\r\n \"subBotUid\": \"{{audioUID}}\",\r\n \"subBotToken\": \"{{subBotToken}}\",\r\n \"pubBotUid\": \"{{textUID}}\",\r\n \"pubBotToken\": \"{{pubBotToken}}\",\r\n \"subscribeAudioUids\": [\r\n \"{{rtcUserUid}}\"\r\n ]\r\n },\r\n \"captionConfig\": {\r\n \"sliceDuration\": 60,\r\n \"storage\": {\r\n \"accessKey\":\"{{AccessKey}}\",\r\n \"secretKey\":\"{{SecretKey}}\",\r\n \"bucket\":\"{{Bucket}}\",\r\n \"vendor\": {{StorageVendor}},\r\n \"region\": {{StorageRegion}},\r\n \"fileNamePrefix\":[\r\n \"directory\",\r\n \"subDirectory\"\r\n ]\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/api/speech-to-text/v1/projects/:appId/join","description":"Use this request to configure and start a real-time transcription task.
\nRequest body parameters
The following parameters need to be passed in the request body:
captionConfig.storage
Please refer to storage config of Cloud Recording
rtcConfig
These are optional parameters that you can add to the rtcConfig mentioned above. Encryption may be needed if you encrypt your RTC calls.
translateConfig
Translation is in beta currently. If you want to test translation, you can add this parameter to your start request and it will translate as well. There is a cost with translation added to transcription so please consult your Agora sales team prior to doing so as to not incur unintended charges.
Example for multi-language with translation
\n\"translateConfig\": {\n \"languages\": [\n {\n \"source\": \"en-US\", \n \"target\": [\n \"language-1\", \n \"language-2\", \n \"language-3\"\n ]\n },\n {\n \"source\": \"es-ES\", \n \"target\": [\n \"language-4\",\n \"language-5\"\n ]\n }\n ]\n }\n\nNote:
\nrtcConfig.subBotUid and rtcConfig.pubBotUid must be different, and only int uid can be used, and the tokens used by the two are also different.
rtcConfig.subBotUid and rtcConfig.pubBotUid must be different from the multiple uids in the channel
If you need to synchronize the subtitle file with the audio and video files recorded in the cloud, you need to add the following settings in the start request body of the cloud recording when the cloud recording starts
\n{\n \"privateParams\": \"{\\\"enableNTPtimestamp\\\": true}\",\n ...\n}\n\nResponse body
\nIf the status code is 2XX, the request is successful. The response body contains the following fields:
\nIf the status code is not 2XX, the request has failed. In this case, the response body contains the message field reporting the reason.
Use this request to configure and start a real-time transcription task.
\nRequest body parameters
The following parameters need to be passed in the request body:
captionConfig.storage
Please refer to storage config of Cloud Recording
rtcConfig
These are optional parameters that you can add to the rtcConfig mentioned above. Encryption may be needed if you encrypt your RTC calls.
translateConfig
Translation is in beta currently. If you want to test translation, you can add this parameter to your start request and it will translate as well. There is a cost with translation added to transcription so please consult your Agora sales team prior to doing so as to not incur unintended charges.
Example for multi-language with translation
\n\"translateConfig\": {\n \"languages\": [\n {\n \"source\": \"en-US\", \n \"target\": [\n \"language-1\", \n \"language-2\", \n \"language-3\"\n ]\n },\n {\n \"source\": \"es-ES\", \n \"target\": [\n \"language-4\",\n \"language-5\"\n ]\n }\n ]\n }\n\nNote:
\nrtcConfig.subBotUid and rtcConfig.pubBotUid must be different, and only int uid can be used, and the tokens used by the two are also different.
rtcConfig.subBotUid and rtcConfig.pubBotUid must be different from the multiple uids in the channel
If you need to synchronize the subtitle file with the audio and video files recorded in the cloud, you need to add the following settings in the start request body of the cloud recording when the cloud recording starts
\n{\n \"privateParams\": \"{\\\"enableNTPtimestamp\\\": true}\",\n ...\n}\n\nResponse body
\nIf the status code is 2XX, the request is successful. The response body contains the following fields:
\nIf the status code is not 2XX, the request has failed. In this case, the response body contains the message field reporting the reason.
Use this request to get information about the status of a real-time transcription task.
\nResponse body
\nIf the response status code is 2XX, the request is successful. The response body contains the following fields:
The App ID provided by Agora
\n","type":"text/plain"},"type":"any","value":"{{appID}}","key":"appId"},{"type":"any","value":"{{agentId}}","key":"agentId"}]}},"response":[{"id":"2a625251-8500-42e3-a331-de099b1f4845","name":"query","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.agora.io/api/speech-to-text/v1/projects/:appId/agents/:agentId","protocol":"https","host":["api","agora","io"],"path":["api","speech-to-text","v1","projects",":appId","agents",":agentId"],"variable":[{"key":"appId","value":"{{appId}}"},{"key":"agentId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 11 Mar 2023 03:38:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"91"},{"key":"Connection","value":"keep-alive"},{"key":"X-Capacity-RateLimit","value":"active"},{"key":"X-Capacity-RateLimit-Remaining-second","value":"10"},{"key":"X-Capacity-RateLimit-Limit-second","value":"10"},{"key":"X-RateLimit-Remaining-Second","value":"9"},{"key":"X-RateLimit-Limit-Second","value":"10"},{"key":"RateLimit-Limit","value":"10"},{"key":"RateLimit-Remaining","value":"9"},{"key":"RateLimit-Reset","value":"1"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"b6522b456ba04552bd30549764cc6a37"}],"cookie":[],"responseTime":null,"body":"{\n \"createTs\": 1678505852,\n \"status\": \"RUNNING\",\n \"agent_id\": \"13696ee5864e9f0df5979a8eda4545b8\",\n \"message\": \"Details of the request result\"\n}"}],"_postman_id":"071b715b-8e5a-46ef-a088-edaa21bb4a68"},{"name":"stop","event":[{"listen":"test","script":{"id":"da41d89c-4c09-4760-acd4-a7259436292a","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"3ecab444-c4b1-4204-a867-322785a16a29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.agora.io/api/speech-to-text/v1/projects/:appId/agents/:agentId/leave","description":"If the response status code is 2XX, the request is successful.
All HTTP requests in this folder require basic authentication. Use customerID as the Username, and customerSecret as the password. You can obtain these parameters from Agora Console by clicking on your user name and then selecting RESTful API fom the menu.
https://docs.agora.io/en/real-time-stt/overview/product-overview
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a8856065-b1d9-458d-acdd-2c374cfac845","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"03bcab53-df27-4330-92a6-773ed6eac0b3","type":"text/javascript","exec":[""]}}],"_postman_id":"69bd200a-7543-4104-8ccc-415741abbeb7"},{"name":"Real-Time STT 6.x","item":[{"name":"acquire","event":[{"listen":"test","script":{"id":"323d9872-b82c-4bcf-9e69-c602015fb789","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"builderToken\", jsonData.tokenName);\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"aaf6a513-e8ff-4c5b-866e-8b34879fb12b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"instanceId\": \"demo\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/v1/projects/:appId/rtsc/speech-to-text/builderTokens","description":"builderTokenUse this request to generate a builderToken before starting a real-time transcription task. You use the builderToken to securely start, query, and stop your real-time transcription tasks.
Use this builderToken to send a start request within 5 minutes. After this time, you need to generate a new builderToken.
Request body parameters
\nThe following parameters need to be passed in the request body:
\nIf the status code is 2XX, the request is successful. The response body contains the following fields:
If the status code is not 2XX, the request has failed. In this case, the response body contains the message field, reporting the reason for the failure.
The App ID provided by Agora.
\n","type":"text/plain"},"type":"any","value":"{{appID}}","key":"appId"}]}},"response":[{"id":"8b61e9b2-7e6a-4007-ae54-c9289b02dbf8","name":"acquire","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"instanceId\": \"XXXX\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/v1/projects/:appId/rtsc/speech-to-text/builderTokens","protocol":"https","host":["api","agora","io"],"path":["v1","projects",":appId","rtsc","speech-to-text","builderTokens"],"variable":[{"key":"appId","value":"{{appId}}","description":"The App ID provided by Agora."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 11 Mar 2023 03:36:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"443"},{"key":"Connection","value":"keep-alive"},{"key":"X-Capacity-RateLimit","value":"active"},{"key":"X-Capacity-RateLimit-Limit-second","value":"10"},{"key":"X-Capacity-RateLimit-Remaining-second","value":"10"},{"key":"X-RateLimit-Remaining-Second","value":"9"},{"key":"X-RateLimit-Limit-Second","value":"10"},{"key":"RateLimit-Limit","value":"10"},{"key":"RateLimit-Remaining","value":"9"},{"key":"RateLimit-Reset","value":"1"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"8e18846a17d4477aa95557e762366a87"}],"cookie":[],"responseTime":null,"body":"{\n \"createTs\": 1678505791,\n \"instanceId\": \"XXXX\",\n \"tokenName\": \"nUwUbQf9Zg6tsgtLslGnDg0lk8RYaUE09pqOuSIgwfy1uJa4K6lWCzLqJNDen8tHgNjbAcOGIWpgWQEllEvR86LKWnExC9WFhPSQo0Eim0W2guETD_yO4hsHLKNpKvcTivXo5PNOYqLEANOdsLbU8pQ5fRgwcxplOVI_GT5MR6YhPT-2O4h64xTS3qpMZv1qtV8dLpcaxTKDwK5zckGk6PKjRycZ_BClZTTKlKXKkfPztQNwyKa00UJDJK5uyZqzExx-Q_PGQEB2r-u4oWriMaqmSo1M8ShsI4TX-920jE0MoB_JBb5GHQUpmHcZOJCTMO2SiKwZLzMK0F-jAaWYBbhRAu3hnQ_LjtcWvDJEDWkEJZonYjTfENjvwOsjFPvp\"\n}"}],"_postman_id":"aaf6a513-e8ff-4c5b-866e-8b34879fb12b"},{"name":"start","event":[{"listen":"prerequest","script":{"id":"46a42dee-317d-4063-a460-0696e2f0ef49","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"991b2365-3e62-41d7-8876-d3b87d4b15da","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"taskId\", jsonData.taskId);\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"a78a60f9-2100-413a-8382-7867502b2d31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"languages\": [\r\n \"en-US\"\r\n ],\r\n \"maxIdleTime\": 60,\r\n \"rtcConfig\": {\r\n \"channelName\": \"{{channelName}}\",\r\n \"subBotUid\": \"{{audioUID}}\",\r\n \"subBotToken\": \"{{subBotToken}}\",\r\n \"pubBotUid\": \"{{textUID}}\",\r\n \"pubBotToken\": \"{{pubBotToken}}\",\r\n \"subscribeAudioUids\": [\r\n \"{{rtcUserUid}}\"\r\n ]\r\n },\r\n \"captionConfig\": {\r\n \"storage\": {\r\n \"accessKey\":\"{{AccessKey}}\",\r\n \"secretKey\":\"{{SecretKey}}\",\r\n \"bucket\":\"{{Bucket}}\",\r\n \"vendor\": {{StorageVendor}},\r\n \"region\": {{StorageRegion}},\r\n \"fileNamePrefix\":[\r\n \"directory\",\r\n \"subDirectory\"\r\n ]\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/v1/projects/:appId/rtsc/speech-to-text/tasks?builderToken=","description":"Use this request to configure and start a real-time transcription task.
\nRequest body parameters
The following parameters need to be passed in the request body:
captionConfig.storage
Please refer to storage config of Cloud Recording
rtcConfig
These are optional parameters that you can add to the rtcConfig mentioned above. Encryption may be needed if you encrypt your RTC calls.
translateConfig
Translation is in beta currently. If you want to test translation, you can add this parameter to your start request and it will translate as well. There is a cost with translation added to transcription so please consult your Agora sales team prior to doing so as to not incur unintended charges.
Example for multi-language with translation
\n\"translateConfig\": {\n \"languages\": [\n {\n \"source\": \"en-US\", \n \"target\": [\n \"language-1\", \n \"language-2\", \n \"language-3\"\n ]\n },\n {\n \"source\": \"es-ES\", \n \"target\": [\n \"language-4\",\n \"language-5\"\n ]\n }\n ]\n }\n\nNote:
\nrtcConfig.subBotUid and rtcConfig.pubBotUid must be different, and only int uid can be used, and the tokens used by the two are also different.
rtcConfig.subBotUid and rtcConfig.pubBotUid must be different from the multiple uids in the channel
If you need to synchronize the subtitle file with the audio and video files recorded in the cloud, you need to add the following settings in the start request body of the cloud recording when the cloud recording starts
\n{\n \"privateParams\": \"{\\\"enableNTPtimestamp\\\": true}\",\n ...\n}\n\nResponse body
\nIf the status code is 2XX, the request is successful. The response body contains the following fields:
\nIf the status code is not 2XX, the request has failed. In this case, the response body contains the message field reporting the reason.
The builderToken you obtained using the acquire request
The App ID provided by Agora.
\n","type":"text/plain"},"type":"any","value":"{{appID}}","key":"appId"}]}},"response":[{"id":"0a3f3ec0-1916-453d-bf2e-9812dc1daead","name":"start","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"languages\": [\r\n \"en-US\"\r\n ],\r\n \"maxIdleTime\": 60,\r\n \"rtcConfig\": {\r\n \"channelName\": \"XXXX\",\r\n \"subBotUid\": \"666\",\r\n \"subBotToken\":\"007lnoquitehr98ter89hdfnvfdvdfvdf\",\r\n \"pubBotUid\": \"666666\",\r\n \"pubBotToken\":\"007lnoquitehr98ter89hdfnvfdvdfvdf\",\r\n \"subscribeAudioUids\": [\r\n \"1234\",\r\n \"5678\"\r\n ]\r\n },\r\n \"captionConfig\": {\r\n \"storage\": {\r\n \"accessKey\":\"3tergregdgdfdfbf3tergregdgdfdfbf3tergregdgdfdfbf\",\r\n \"secretKey\":\"dsfgsfgdsfg34grdsfgsfgdsfg34grdsfgsfgdsfg34gr\",\r\n \"bucket\":\"agoraTranscriptions\",\r\n \"vendor\": 1,\r\n \"region\": 1,\r\n \"fileNamePrefix\":[\r\n \"directory\",\r\n \"subDirectory\"\r\n ]\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/v1/projects/:appId/rtsc/speech-to-text/tasks?builderToken={{builderToken}","protocol":"https","host":["api","agora","io"],"path":["v1","projects",":appId","rtsc","speech-to-text","tasks"],"query":[{"key":"builderToken","value":"{{builderToken}"}],"variable":[{"key":"appId","value":"{{appId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 11 Mar 2023 03:37:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"87"},{"key":"Connection","value":"keep-alive"},{"key":"X-Capacity-RateLimit-Remaining-second","value":"10"},{"key":"X-Capacity-RateLimit","value":"active"},{"key":"X-Capacity-RateLimit-Limit-second","value":"10"},{"key":"RateLimit-Remaining","value":"9"},{"key":"X-RateLimit-Remaining-Second","value":"9"},{"key":"X-RateLimit-Limit-Second","value":"10"},{"key":"RateLimit-Limit","value":"10"},{"key":"RateLimit-Reset","value":"1"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"ce5bdb3422e0400d801bbbf9966fc782"}],"cookie":[],"responseTime":null,"body":"{\n \"createTs\": 1678505852,\n \"status\": \"STARTED\",\n \"taskId\": \"13696ee5864e9f0df5979a8eda4545b8\"\n}"}],"_postman_id":"a78a60f9-2100-413a-8382-7867502b2d31"},{"name":"query","event":[{"listen":"test","script":{"id":"98b33f53-7ec9-4edc-a1f4-82d20b28efe1","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"80131858-4c76-4746-bc73-e69330dc53d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.agora.io/v1/projects/:appId/rtsc/speech-to-text/tasks/:taskId?builderToken=","description":"Use this request to get information about the status of a real-time transcription task.
\nResponse body
\nIf the response status code is 2XX, the request is successful. The response body contains the following fields:
The builderToken you obtained using the acquire request
The App ID provided by Agora
\n","type":"text/plain"},"type":"any","value":"{{appID}}","key":"appId"},{"id":"900117e1-faf0-48c1-8cd1-cfec92cc082a","description":{"content":"The taskId returned by the start request
If the response status code is 2XX, the request is successful.
The builderToken you obtained using the acquire request
The App ID provided by Agora
\n","type":"text/plain"},"type":"any","value":"{{appID}}","key":"appId"},{"id":"1522725c-7272-4f40-a4c0-1abfdebf8687","description":{"content":"The taskId returned by the start request
All HTTP requests in this folder require basic authentication. Use customerID as the Username, and customerSecret as the password. You can obtain these parameters from Agora Console by clicking on your user name and then selecting RESTful API fom the menu.
https://docs.agora.io/en/real-time-stt/overview/product-overview
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"793d19d4-26ec-4530-92f6-a13704acc772","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0313545e-df0d-4471-97c3-5497fd08aa4d","type":"text/javascript","exec":[""]}}],"_postman_id":"9353d85b-73e9-4f87-a273-2a1180f554ca"},{"name":"Interactive Whiteboard","item":[{"name":"Token Generation","item":[{"name":"Generate SDK Token","event":[{"listen":"test","script":{"id":"dee59499-a851-4973-a94d-ff8e76d06814","exec":["var wbToken = responseBody.replace(/\"/g,'');","console.log(wbToken);","pm.collectionVariables.set(\"wbToken\", wbToken);"],"type":"text/javascript","packages":{}}}],"id":"4c4fe4b0-521e-4f53-81c1-bfd8a7be9ac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accessKey\": \"{{accessKey}}\",\n \"secretAccessKey\": \"{{secretAccessKey}}\",\n \"lifespan\": {{lifespan}},\n \"role\": \"{{role}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/tokens/teams","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","tokens","teams"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c4fe4b0-521e-4f53-81c1-bfd8a7be9ac4"},{"name":"Generate Room Token","event":[{"listen":"test","script":{"id":"dee59499-a851-4973-a94d-ff8e76d06814","exec":["var wbRoomToken = responseBody.replace(/\"/g,'');","console.log(wbRoomToken);","pm.collectionVariables.set(\"wbRoomToken\", wbRoomToken);"],"type":"text/javascript","packages":{}}}],"id":"8dd5c0c9-b76e-4039-80ad-27c3963b631f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"region","value":"{{region}}","type":"text"},{"key":"token","value":"{{wbToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ak\": \"{{accessKey}}\",\n \"lifespan\": {{lifespan}},\n \"role\": \"{{role}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/tokens/rooms/{{uuid}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","tokens","rooms","{{uuid}}"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"8dd5c0c9-b76e-4039-80ad-27c3963b631f"},{"name":"Generate Task Token","event":[{"listen":"test","script":{"id":"dee59499-a851-4973-a94d-ff8e76d06814","exec":["var wbTaskToken = responseBody.replace(/\"/g,'');","console.log(wbTaskToken);","pm.collectionVariables.set(\"wbTaskToken\", wbTaskToken);"],"type":"text/javascript","packages":{}}}],"id":"d89260e1-175b-4571-8423-65a4a9ac7d98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"region","value":"{{region}}","type":"text"},{"key":"token","value":"{{wbToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ak\": \"{{accessKey}}\", //optional\n \"lifespan\": {{lifespan}},\n \"role\": \"{{role}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/tokens/tasks/{{uuid}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","tokens","tasks","{{uuid}}"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"d89260e1-175b-4571-8423-65a4a9ac7d98"}],"id":"e06ec0b7-bd05-4baa-9555-b2ddb87d99f2","_postman_id":"e06ec0b7-bd05-4baa-9555-b2ddb87d99f2","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}}},{"name":"Room Management","item":[{"name":"Create","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":["var response = `{${responseBody}}`;","var jsonData = JSON.parse(response);","var uuid = jsonData.uuid;","console.log(uuid);","pm.collectionVariables.set(\"uuid\", uuid);"],"type":"text/javascript","packages":{}}}],"id":"c400c937-860e-4bf2-98cd-8b0a1167206b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"isRecord\": false, //not supported yet\n \"limit\": 0 //optional\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/rooms","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","rooms"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"c400c937-860e-4bf2-98cd-8b0a1167206b"},{"name":"Get room info","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"11943048-3a6f-4057-8273-73304fd3d24e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/rooms/{{uuid}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","rooms","{{uuid}}"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"11943048-3a6f-4057-8273-73304fd3d24e"},{"name":"Get room list","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"f894e54f-6039-4f66-a7a8-4a6e548b2ff5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/rooms/{{uuid}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","rooms","{{uuid}}"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"f894e54f-6039-4f66-a7a8-4a6e548b2ff5"},{"name":"Disable","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"8efda8fc-a991-403d-a5ad-ea2c4f9cdce2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"isBan\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/rooms/{{uuid}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","rooms","{{uuid}}"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"8efda8fc-a991-403d-a5ad-ea2c4f9cdce2"}],"id":"07c16d56-2d3a-42e3-b5aa-87ab02212646","_postman_id":"07c16d56-2d3a-42e3-b5aa-87ab02212646","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}}},{"name":"Scene Management","item":[{"name":"Get scene path list","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":["var response = `{\"paths\": ${responseBody}}`;","var jsonData = JSON.parse(response);","var path = jsonData.paths[0];","var path1 = jsonData.paths[1];","console.log(path);","pm.collectionVariables.set(\"path\", path);"],"type":"text/javascript","packages":{}}}],"id":"dda755bf-5489-4163-8278-e250ce66e0de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/rooms/{{uuid}}/scenes","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","rooms","{{uuid}}","scenes"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"dda755bf-5489-4163-8278-e250ce66e0de"},{"name":"Add","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"52aaa544-8c48-4531-a7df-4207c7d12579","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"scenes\": [\n {\n \"name\": \"{{name}}\",\n \"ppt\": \"{{ppt}}\", //optional\n \"src\": \"{{src}}\",\n \"width\": \"{{width}}\",\n \"height\": \"{{height}}\"\n }\n ],\n \"path\": \"{{path}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/rooms/{{uuid}}/scenes","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","rooms","{{uuid}}","scenes"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"52aaa544-8c48-4531-a7df-4207c7d12579"},{"name":"Switch a scene","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"ec34dcff-6a18-4371-9e26-78da36ba5a81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"scenePath\": \"{{path1}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/rooms/{{uuid}}/scene-state","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","rooms","{{uuid}}","scene-state"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec34dcff-6a18-4371-9e26-78da36ba5a81"}],"id":"31f787ca-017a-4509-812a-76678fedb4ed","_postman_id":"31f787ca-017a-4509-812a-76678fedb4ed","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}}},{"name":"Screenshot Management","item":[{"name":"Screenshot a scene","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"c50af60a-967e-461f-b484-d41a482cd025","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"width\": \"{{width}}\",\n \"height\": \"{{height}}\",\n \"path\": \"{{path}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/rooms/{{uuid}}/screenshots","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","rooms","{{uuid}}","screenshots"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"c50af60a-967e-461f-b484-d41a482cd025"},{"name":"Screenshot a scene directory","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"6ffa08e3-9252-47d0-811f-c1ce0350732d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"width\": \"{{width}}\",\n \"height\": \"{{height}}\",\n \"path\": \"{{path}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/rooms/{{uuid}}/screenshot-list","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","rooms","{{uuid}}","screenshot-list"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ffa08e3-9252-47d0-811f-c1ce0350732d"}],"id":"cd91dc0f-79bf-4fd1-828f-61d0e2101cdc","_postman_id":"cd91dc0f-79bf-4fd1-828f-61d0e2101cdc","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}}},{"name":"File Conversion","item":[{"name":"Start file conversion","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":["var response = `{${responseBody}}`;","var jsonData = JSON.parse(response);","var uuid = jsonData.uuid;","console.log(uuid);","pm.collectionVariables.set(\"uuid\", uuid);"],"type":"text/javascript","packages":{}}}],"id":"b8ab6558-8723-45b0-9470-2e87bac27ce6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"resource\": \"{{resource}}\",\n \"type\": \"{{type}}\",\n \"preview\": true, //optional\n \"scale\": 1.0, //optional\n \"outputFormat\": \"{{outputFormat}}\", //optional\n \"webhookEndpoint\": \"{{webhookEndpoint}}\",\n \"webhookRetry\": 3\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/projector/tasks","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","projector","tasks"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8ab6558-8723-45b0-9470-2e87bac27ce6"},{"name":"Query progress file-conversion task","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"e3cef1b3-b990-4196-9811-e5e1e2197c5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/projector/tasks/{{uuid}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","projector","tasks","{{uuid}}"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3cef1b3-b990-4196-9811-e5e1e2197c5f"},{"name":"Query to-be-converted task","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"e6eb16f6-3577-4056-bf56-2e9c6b53ecdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/projector/tasks","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","projector","tasks"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6eb16f6-3577-4056-bf56-2e9c6b53ecdd"},{"name":"Cancel","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"1f1cdf75-c64a-40a5-ad01-f4be402c9d24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/projector/tasks/{{uuid}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","projector","tasks","{{uuid}}"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f1cdf75-c64a-40a5-ad01-f4be402c9d24"},{"name":"Set task priority","event":[{"listen":"test","script":{"id":"99351823-b5ef-480b-82ee-aa6f6b02ec3f","exec":[""],"type":"text/javascript"}}],"id":"5ea01c31-8bbb-4e6f-8ac8-e38081e4a6f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"token","value":"{{wbToken}}","type":"text"},{"key":"region","value":"{{region}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"priority\": \"highest\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netless.link/v5/projector/tasks/{{uuid}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}},"urlObject":{"protocol":"https","path":["v5","projector","tasks","{{uuid}}"],"host":["api","netless","link"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ea01c31-8bbb-4e6f-8ac8-e38081e4a6f4"}],"id":"c76b0449-989e-46ad-92eb-6e0a268dd749","_postman_id":"c76b0449-989e-46ad-92eb-6e0a268dd749","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":true,"source":{"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","name":"Interactive Whiteboard","type":"folder"}}}],"id":"e678f990-8026-4d78-b1bb-4763a6b6ac75","description":"This collection is the Agora Whiteboard RESTful API collection.
\nhttps://docs.agora.io/en/interactive-whiteboard/reference/whiteboard-api/overview?platform=android
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerCertificate}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e742e57f-fe1c-4792-a8ff-f20d266aaf00","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96c9ec3c-170b-4e72-b326-28b7f783ec1c","type":"text/javascript","exec":[""]}}],"_postman_id":"e678f990-8026-4d78-b1bb-4763a6b6ac75"},{"name":"Flexible Classroom","item":[{"name":"Create Classroom","id":"a0917a83-7db0-401e-bc10-498c17cf2d42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"roomName\": \"{{AccessChannel}}\",\n \"roomType\": {{roomType}},\n \"roomProperties\": { // Optional\n \"schedule\": {\n \"startTime\": 1655452800000, //Change this\n \"duration\": 600,\n \"closeDelay\": 300\n },\n \"processes\": {\n \"handsUp\": {\n \"maxAccept\": 10\n }\n },\n \"hostingScene\": {\n \"videoURL\": \"https://url\",\n \"finishType\": 1\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0917a83-7db0-401e-bc10-498c17cf2d42"},{"name":"Kick user","id":"93288c04-c79d-4eb3-9ef6-aa4d21d77292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"dirty\": {\n \"state\": 1,\n \"duration\": 600\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/users/{{userUuid}}/exit","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","users","{{userUuid}}","exit"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"93288c04-c79d-4eb3-9ef6-aa4d21d77292"},{"name":"Set classroom state","id":"f56e3084-c55a-4aa1-9ba3-81d88a2403e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/states/{{state}}","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","states","{{state}}"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"f56e3084-c55a-4aa1-9ba3-81d88a2403e5"},{"name":"Set recording state","id":"13b710e0-8459-4620-a0d8-cfd5d06aaf4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"mode\": \"web\",\n \"webRecordConfig\": {\n \"url\": \"https://webdemo.agora.io/xxxxx/?userUuid={{userUuid}}&roomUuid={{roomUuid}}&roleType=0&roomType={{roomType}}&pretest=false&rtmToken={{signalToken}}&language=en&appId={{APPID}}\",\n \"rootUrl\": \"https://xxx.yyy.zzz\"\n },\n \"retryTimeout\": 60\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/records/states/{{state}}","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","records","states","{{state}}"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"13b710e0-8459-4620-a0d8-cfd5d06aaf4e"},{"name":"Update recording config","id":"965e29fa-99e5-4310-9c20-75ecd130aad2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"webRecordConfig\": {\n \"onhold\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/records/states/{{state}}","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","records","states","{{state}}"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"965e29fa-99e5-4310-9c20-75ecd130aad2"},{"name":"Get recording list","id":"7270a360-1ecd-4908-a7cc-83c675d0f23a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/records","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","records"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"7270a360-1ecd-4908-a7cc-83c675d0f23a"},{"name":"Get classroom events","id":"fb112fe0-c9c6-4c3d-8d21-c2f0fbefa110","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/polling/apps/{{APPID}}/v2/rooms/sequences","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","polling","apps","{{APPID}}","v2","rooms","sequences"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb112fe0-c9c6-4c3d-8d21-c2f0fbefa110"},{"name":"Update custom classroom properties","id":"877af324-c223-4f96-807e-9c32afbfbd95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"cause\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/properties","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","properties"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"877af324-c223-4f96-807e-9c32afbfbd95"},{"name":"Delete custom classroom properties","id":"785b62b6-4b0c-4364-92cf-d3e6317df439","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"cause\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/properties","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","properties"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"785b62b6-4b0c-4364-92cf-d3e6317df439"},{"name":"Update custom user properties","id":"a9f66419-0b0a-4fdb-a54b-6f2a31a7af20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"cause\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/users/{{userUuid}}/properties","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","users","{{userUuid}}","properties"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9f66419-0b0a-4fdb-a54b-6f2a31a7af20"},{"name":"Delete custom user properties","id":"663afa12-ff50-41ad-b33a-cad14ffab6fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"properties\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"cause\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/users/{{userUuid}}/properties","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","users","{{userUuid}}","properties"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"663afa12-ff50-41ad-b33a-cad14ffab6fd"},{"name":"Set extApp properties","id":"24fd25a6-f146-4c48-b49a-16e0112ae622","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"properties\": {},\n \"common\": {\n \"state\": 0\n },\n \"cause\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/extApps/{{extAppUuid}}/properties","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","extApps","{{extAppUuid}}","properties"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"24fd25a6-f146-4c48-b49a-16e0112ae622"},{"name":"Delete extApp properties","id":"633d37fb-d91b-471c-9415-62e7ee78b99a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"{\n \"properties\" :[\n \"key-path1\",\n \"key-path2\"\n ],\n \"cause\":{}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/extApps/{{extAppUuid}}/properties","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","extApps","{{extAppUuid}}","properties"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"633d37fb-d91b-471c-9415-62e7ee78b99a"},{"name":"Get data for pop-up quizzes","id":"7d5c8608-b918-46e7-bc80-a4b0cb579e4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/widgets/popupQuiz/sequences","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","widgets","popupQuiz","sequences"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d5c8608-b918-46e7-bc80-a4b0cb579e4d"},{"name":"Get data for polls","id":"0e38240d-32ef-46a2-b4c5-fe98605ea801","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"agora token={{signalToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/{{region}}/edu/apps/{{APPID}}/v2/rooms/{{roomUuid}}/widgets/poll/sequences","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea","id":"141a0bd6-d95e-4138-b1d3-2230745545ea","name":"Flexible Classroom","type":"folder"}},"urlObject":{"protocol":"https","path":["{{region}}","edu","apps","{{APPID}}","v2","rooms","{{roomUuid}}","widgets","poll","sequences"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e38240d-32ef-46a2-b4c5-fe98605ea801"}],"id":"141a0bd6-d95e-4138-b1d3-2230745545ea","description":"This collection is the Agora Flexible Classroom RESTful API collection.
\nhttps://docs.agora.io/en/flexible-classroom/reference/classroom-api?platform=android
\nFlexible Classroom Cloud Service uses tokens for authentication. You need to put the following information to the x-agora-token and x-agora-uid fields when sending your HTTP request:
For details, see Generate an RTM Token.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b3d91b31-95ad-48ee-838f-6dd3be21ef17","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d6cdf8f4-ef28-4a50-8fd9-c68b80d73571","type":"text/javascript","exec":[""]}}],"_postman_id":"141a0bd6-d95e-4138-b1d3-2230745545ea"},{"name":"Media Gateway","item":[{"name":"Configuration Templates","item":[{"name":"create/reset","id":"c7cbfefa-da25-4b1e-84f1-d148543ed7c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"transcoding\": {\r\n \"video\": {\r\n \"enabled\": true,\r\n \"codec\": \"H.264\",\r\n \"width\": 1280,\r\n \"height\": 720,\r\n \"fps\": 24,\r\n \"bitrate\": 2200,\r\n \"simulcastStream\": {\r\n \"width\": 960,\r\n \"height\": 540,\r\n \"fps\": 24,\r\n \"bitrate\": 1670\r\n }\r\n },\r\n \"audio\": {\r\n \"enabled\": false,\r\n \"profile\": 3\r\n }\r\n },\r\n \"jitterBuffer\": {\r\n \"size\": 500,\r\n \"maxSize\": 800\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates/:templateId","description":"This method creates a stream configuration template (Stream Template). In the stream configuration template, you can configure transcoding parameters for video or audio streams, as well as parameters for mitigating network latency.
\nUp to 10 flow configuration templates can be created under each App ID, and each flow configuration template has a unique ID identification (templatedId). When creating a stream configuration template, you need to specify a templateId for it. If the template corresponding to the templateId already exists, the value of the entire flow configuration template will be reset with the incoming body data.
\nThere are two ways to use flow configuration templates, which can be used in combination:
\n\n\nBy default, all App IDs do not set a stream configuration template, that is, video transcoding is not enabled by default.
\n
\n\nFor
\ntemplateIdString type required parameter. Flow configuration template ID, the value can only be \"a-z\", A-Z\", \"0-9_-\", and the length cannot exceed 12Bytes.
Request body parameters
\nThe request body consists of a JSON Object type named settings which includes the following fields:
transcoding: JSON Object (Optional) Transcoding settings, includes the following fields:video: JSON Object type (Optional) Video transcoding settings, include the following fields:enabled: Boolean (Required) Whether to enable video transcoding, the default value is false(disabled).
codec: String (Optional) String type. Transcoding codec, optional values \"H.264\", \"VP8\", the default is \"H.264\";
width: Number (Optional) Width in encoding resolution. The value range is 2 to 1920.
height: Number (Optional) Height in encoding resolution. The value range is 2 to 1920.
bitrate: (optional) Number type. Encoding bitrate, unit kbps, value range is 0 to 14000;
\n\nWhen the simulcast(low) stream is not enabled, it is recommended to use the automatically matched bitrate without setting the bitrate yourself.
\n
audio: (optional) JSON Object type. Includes the following fields:enabled: (required) Boolean type. Whether to enable audio transcoding, enabled by default.profile: (optional) Number type. Encoding audio scene, the default is 0, which means: 48 KHz sampling rate, music encoding, mono, the maximum encoding rate is 64 Kbps. If you want to set other profiles, please contact Agora technical support for confirmation.simulcastStream: JSON Object (Optional) The function of large and small video streams, used to improve the adaptive switching capability of the viewer in a weak network environment. Includes the following fields:enabled: Boolean (Required) Whether to enable small video transcoding. The default is `false`(off). If you want to enable it, you must enable the video transcoding function at the same time.height: Number (Optional) Height in small stream resolution, Number type. The value range is 2 to 1920.fps: Number (Optional) Small stream frame rate. The value range is 1 to 60.jitterBuffer: (optional) JSON Object type. The gateway jitter buffer parameters will only take effect when video transcoding is enabled (If there are no special requirements, no explicit configuration is required)size: (optional)Number type. jitterBuffer length, unit ms, default value 500 (meaning the gateway will add 500ms to the end-to-end delay to reduce the lag rate caused by network jitter)maxSize: (optional) Number type. The maximum length of jitterBuffer, unit ms, default value 1000, if provided, must be > jitterBuffer.size. When the jitterBuffer length exceeds this value, the gateway will enable acceleration until it returns to jitterBuffer.size.(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"},{"type":"any","value":"{{templateId}}","key":"templateId"}]}},"response":[{"id":"59f99e8d-644d-4a65-999a-bab92e923947","name":"create/reset","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"transcoding\": {\r\n \"video\": {\r\n \"enabled\": true,\r\n \"codec\": \"H.264\",\r\n \"width\": 1280,\r\n \"height\": 720,\r\n \"fps\": 24,\r\n \"bitrate\": 2200,\r\n \"simulcastStream\": {\r\n \"width\": 960,\r\n \"height\": 540,\r\n \"fps\": 24,\r\n \"bitrate\": 1670\r\n }\r\n },\r\n \"audio\": {\r\n \"enabled\": false,\r\n \"profile\": 3\r\n }\r\n },\r\n \"jitterBuffer\": {\r\n \"size\": 500,\r\n \"maxSize\": 800\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates/{{templateId}}","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","stream-templates","{{templateId}}"],"variable":[{"id":"f8297374-7711-45b9-8950-3dd39383b13e","key":"region","value":"{{region}}"},{"id":"616128ed-001a-445e-8f54-712f4259f408","key":"appId","value":"{{appId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:36 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"184"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"ed8012bbb2b440c78b18c5685da843c1"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"c7cbfefa-da25-4b1e-84f1-d148543ed7c8"},{"name":"update","id":"8b61e9b0-cb31-479a-b118-0fcc4b50c34c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n \"settings\": {\r\n \"transcoding\": {\r\n \"video\": {\r\n \"enabled\": true,\r\n \"codec\": \"H.264\",\r\n \"width\": 1280,\r\n \"height\": 720,\r\n \"fps\": 24,\r\n \"bitrate\": 2200,\r\n \"simulcastStream\": {\r\n \"width\": 960,\r\n \"height\": 540,\r\n \"fps\": 24,\r\n \"bitrate\": 1670\r\n }\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates/:templateId","description":"Update the created flow configuration template.
\n\n\n\n
\n- This interface can only be called if the flow configuration template already exists.
\n- Modifications to the stream configuration template will only take effect after the stream is re-pushed. Considering the synchronization delay between the gateway and the database, please wait 3 minutes after calling this interface before re-pushing the stream.
\n
Request body parameters
\nThe request body consists of a JSON Object type named settings which includes the following fields. The update interface can only be called if the stream configuration template already exists, and will only update the incoming fields.
\n\n\n
\n- To ensure a successful request, do not set required fields to
\nnullor\"\".- The simulcast (low stream) parameters supported by the update is:
\n\n
\n- \n
transcoding.video- \n
transcoding.audio- \n
jitterBuffer- For example, if you only want to update the field transcoding.video for fps, you need to pass in the entire
\ntranscoding.videofield again but only modify the fps field and pass in the other fields unchanged. Fields cannot be passed individually.- \n
transcoding.video,transcoding.audio, andjitterBufferare independent of each other and do not affect each other. If onlytranscoding.videois passed in then only its parameters will be updated and the parameter values oftranscoding.audioandjitterBufferwill not be affected.
transcoding: JSON Object (Optional) Transcoding settings, includes the following fields:video: JSON Object type (Optional) Video transcoding settings, include the following fields:enabled: Boolean (Required) Whether to enable video transcoding, the default value is false(disabled).codec: String (Optional) String type. Transcoding codec, optional values \"H.264\", \"VP8\", the default is \"H.264\";width: Number (Optional) Width in encoding resolution. The value range is 2 to 1920.height: Number (Optional) Height in encoding resolution. The value range is 2 to 1920.bitrate: (optional) Number type. Encoding bit rate, unit kbps, value range is 0 to 14000;simulcastStream: JSON Object (Optional) The function of large and small video streams, used to improve the adaptive switching capability of the viewer in a weak network environment. Includes the following fields:enabled: Boolean (Required) Whether to enable small video transcoding. The default is false(off). If you want to enable it, you must enable the video transcoding function at the same time.width: Number (Optional) Width in small stream resolution. The value range is 2 to 1920.height: Number (Optional) Height in small stream resolution, Number type. The value range is 2 to 1920.fps: Number (Optional) Small stream frame rate. The value range is 1 to 60.audio: (optional) JSON Object type. Includes the following fields:enabled: (required) Boolean type. Whether to enable audio transcoding, enabled by default.profile: (optional) Number type. Encoding audio scene, the default is 0, which means: 48 KHz sampling rate, music encoding, mono, the maximum encoding rate is 64 Kbps. If you want to set other profiles, please contact Agora technical support for confirmation.bitrate: (optional) Number type. Encoding bit rate, unit kbps, value range is 64kbps ~ 320kbps, if not filled in, the bit rate is determined by the profile value.jitterBuffer: (optional) JSON Object type. The gateway jitter buffer parameters will only take effect when video transcoding is enabled (If there are no special requirements, no explicit configuration is required)size: (optional) Number type. jitterBuffer length, unit ms, default value 500 (meaning the gateway will add 500ms to the end-to-end delay to reduce the lag rate caused by network jitter)maxSize: (optional) Number type. The maximum length of jitterBuffer, unit ms, default value 1000, if provided, must be > jitterBuffer.size. When the jitterBuffer length exceeds this value, the gateway will enable acceleration until it returns to jitterBuffer.size.(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"},{"type":"any","value":"{{templateId}}","key":"templateId"}]}},"response":[{"id":"329cf98a-2d8e-4fc7-951a-e592103ce5d7","name":"update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"\r\n{\r\n \"settings\": {\r\n \"transcoding\": {\r\n \"video\": {\r\n \"enabled\": true,\r\n \"codec\": \"H.264\",\r\n \"width\": 1280,\r\n \"height\": 720,\r\n \"fps\": 24,\r\n \"bitrate\": 2200,\r\n \"simulcastStream\": {\r\n \"width\": 960,\r\n \"height\": 540,\r\n \"fps\": 24,\r\n \"bitrate\": 1670\r\n }\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates/{{templateId}}","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","stream-templates","{{templateId}}"],"variable":[{"id":"f8297374-7711-45b9-8950-3dd39383b13e","key":"region","value":"{{region}}"},{"id":"616128ed-001a-445e-8f54-712f4259f408","key":"appId","value":"{{appId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:36 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"184"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"ed8012bbb2b440c78b18c5685da843c1"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"8b61e9b0-cb31-479a-b118-0fcc4b50c34c"},{"name":"delete","id":"8bdb3a05-47be-403d-83cd-08f498bd8874","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates/:templateId","description":"Request package body
None.
(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"},{"type":"any","value":"{{templateId}}","key":"templateId"}]}},"response":[{"id":"c4b3fa00-35e3-470e-a427-49e2394cdeec","name":"delete","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates/{{templateId}}","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","stream-templates","{{templateId}}"],"variable":[{"id":"c7060baa-14d2-45e0-8d11-a63fdf17a354","key":"region","value":"{{region}}"},{"id":"073a4a73-db73-49d8-8853-6bb674bbd205","key":"appId","value":"{{appId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"170"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"4d508315094745c4bcbb8fd06bc57f7b"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"8bdb3a05-47be-403d-83cd-08f498bd8874"},{"name":"set global config","id":"c0e799c4-97ca-419f-b2df-48b9ddd7e9dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"defaultStreamTemplate\": \"720p\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/appconfig","description":"This method sets the global flow configuration template, that is, the template that applies to all push codes under the App ID.
\n\n\nBefore calling this interface, there must be a created template. You can refer to the Create or Reset Stream Configuration Template API to create a template.
\n
Request body parameters
\nThe request body consists of a JSON Object type named settings which includes the following fields:
defaultStreamTemplate: String type. Flow configuration template ID, must have been created.Note:
\ntranscoding parameters. Now it is recommended that you use the Create or reset stream configuration template API settings instead.transcoding, the current effective mechanism is as follows:defaultStreamTemplate, the previously set through this API transcoding will automatically become invalid, and the parameters in the new template will take over.defaultStreamTemplate is not set, the transcoding previously set through this API will still be retained as the default global configuration parameter of this AppIDdefaultStreamTemplate is set, the transcoding parameter previously set through this API will automatically become invalid.(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"}]}},"response":[{"id":"d52048b8-ecbc-4745-92c5-ab76333ac1d5","name":"set global config","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"defaultStreamTemplate\": \"720p\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/appconfig","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","appconfig"],"variable":[{"id":"f8297374-7711-45b9-8950-3dd39383b13e","key":"region","value":"{{region}}"},{"id":"616128ed-001a-445e-8f54-712f4259f408","key":"appId","value":"{{appId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:36 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"184"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"ed8012bbb2b440c78b18c5685da843c1"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"c0e799c4-97ca-419f-b2df-48b9ddd7e9dc"},{"name":"query all templates","id":"72073934-d634-4223-8ae0-6a40cfbd2d70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates","description":"Call this interface to get all templates and their configurations
\nResponse body parameters
\ntranscoding: JSON Object (Optional) Transcoding settings, includes the following fields:video: JSON Object type (Optional) Video transcoding settings, include the following fields:enabled: Boolean (Required) Whether to enable video transcoding, the default value is false(disabled).codec: String (Optional) String type. Transcoding codec, optional values \"H.264\", \"VP8\", the default is \"H.264\";width: Number (Optional) Width in encoding resolution. The value range is 2 to 1920.height: Number (Optional) Height in encoding resolution. The value range is 2 to 1920.bitrate: (optional) Number type. Encoding bit rate, unit kbps, value range is 0 to 14000;audio: (optional) JSON Object type. Includes the following fields:enabled: (required) Boolean type. Whether to enable audio transcoding, enabled by default.profile: (optional) Number type. Encoding audio scene, the default is 0, which means: 48 KHz sampling rate, music encoding, mono, the maximum encoding rate is 64 Kbps. If you want to set other profiles, please contact Agora technical support for confirmation.bitrate: (optional) Number type. Encoding bit rate, unit kbps, value range is 64kbps ~ 320kbps, if not filled in, the bit rate is determined by the profile value.simulcastStream: JSON Object (Optional) The function of large and small video streams, used to improve the adaptive switching capability of the viewer in a weak network environment. Includes the following fields:enabled: Boolean (Required) Whether to enable small video transcoding. The default is false(off). If you want to enable it, you must enable the video transcoding function at the same time.width: Number (Optional) Width in small stream resolution. The value range is 2 to 1920.height: Number (Optional) Height in small stream resolution, Number type. The value range is 2 to 1920.fps: Number (Optional) Small stream frame rate. The value range is 1 to 60.jitterBuffer: (optional) JSON Object type. The gateway jitter buffer parameters will only take effect when video transcoding is enabled (If there are no special requirements, no explicit configuration is required)size: (optional)Number type. jitterBuffer length, unit ms, default value 500 (meaning the gateway will add 500ms to the end-to-end delay to reduce the lag rate caused by network jitter)maxSize: (optional) Number type. The maximum length of jitterBuffer, unit ms, default value 1000, if provided, must be > jitterBuffer.size. When the jitterBuffer length exceeds this value, the gateway will enable acceleration until it returns to jitterBuffer.size.(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"}]}},"response":[{"id":"84f81734-b2a9-4ea6-bc29-906cd58446b2","name":"query all templates","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","stream-templates"],"variable":[{"id":"f8297374-7711-45b9-8950-3dd39383b13e","key":"region","value":"{{region}}"},{"id":"616128ed-001a-445e-8f54-712f4259f408","key":"appId","value":"{{appId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:36 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"184"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"ed8012bbb2b440c78b18c5685da843c1"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"72073934-d634-4223-8ae0-6a40cfbd2d70"},{"name":"query template","id":"d0a6af9e-645e-4b04-969b-8d7e4252d7c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates/:templateId","description":"Call this interface to get the specific template configuration
\nResponse body parameters
\ntranscoding: JSON Object (Optional) Transcoding settings, includes the following fields:video: JSON Object type (Optional) Video transcoding settings, include the following fields:enabled: Boolean (Required) Whether to enable video transcoding, the default value is false(disabled).codec: String (Optional) String type. Transcoding codec, optional values \"H.264\", \"VP8\", the default is \"H.264\";width: Number (Optional) Width in encoding resolution. The value range is 2 to 1920.height: Number (Optional) Height in encoding resolution. The value range is 2 to 1920.bitrate: (optional) Number type. Encoding bit rate, unit kbps, value range is 0 to 14000;audio: (optional) JSON Object type. Includes the following fields:enabled: (required) Boolean type. Whether to enable audio transcoding, enabled by default.profile: (optional) Number type. Encoding audio scene, the default is 0, which means: 48 KHz sampling rate, music encoding, mono, the maximum encoding rate is 64 Kbps. If you want to set other profiles, please contact Agora technical support for confirmation.bitrate: (optional) Number type. Encoding bit rate, unit kbps, value range is 64kbps ~ 320kbps, if not filled in, the bit rate is determined by the profile value.simulcastStream: JSON Object (Optional) The function of large and small video streams, used to improve the adaptive switching capability of the viewer in a weak network environment. Includes the following fields:enabled: Boolean (Required) Whether to enable small video transcoding. The default is false(off). If you want to enable it, you must enable the video transcoding function at the same time.width: Number (Optional) Width in small stream resolution. The value range is 2 to 1920.height: Number (Optional) Height in small stream resolution, Number type. The value range is 2 to 1920.fps: Number (Optional) Small stream frame rate. The value range is 1 to 60.jitterBuffer: (optional) JSON Object type. The gateway jitter buffer parameters will only take effect when video transcoding is enabled (If there are no special requirements, no explicit configuration is required)size: (optional)Number type. jitterBuffer length, unit ms, default value 500 (meaning the gateway will add 500ms to the end-to-end delay to reduce the lag rate caused by network jitter)maxSize: (optional) Number type. The maximum length of jitterBuffer, unit ms, default value 1000, if provided, must be > jitterBuffer.size. When the jitterBuffer length exceeds this value, the gateway will enable acceleration until it returns to jitterBuffer.size.(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"},{"type":"any","value":"","key":"templateId"}]}},"response":[{"id":"c58ba8b6-1caa-488a-9a7a-68c1677b4331","name":"query templates","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/stream-templates/:templateId","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","stream-templates",":templateId"],"variable":[{"id":"f8297374-7711-45b9-8950-3dd39383b13e","key":"region","value":"{{region}}"},{"id":"616128ed-001a-445e-8f54-712f4259f408","key":"appId","value":"{{appId}}"},{"key":"templateId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:36 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"184"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"ed8012bbb2b440c78b18c5685da843c1"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"d0a6af9e-645e-4b04-969b-8d7e4252d7c9"},{"name":"configure [deprecated]","id":"e1d9b7e9-382a-42bb-9c51-9b9277d580a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"transcoding\": {\r\n \"video\": {\r\n \"enabled\": true,\r\n \"codec\": \"H.264\",\r\n \"width\": 640,\r\n \"height\": 480,\r\n \"fps\": 15,\r\n \"bitrate\": 1200\r\n },\r\n \"audio\": {\r\n \"enabled\": false,\r\n \"codec\": \"OPUS\"\r\n }\r\n },\r\n \"simulcastStream\": {\r\n \"enabled\": true,\r\n \"width\": 320,\r\n \"height\": 240,\r\n \"fps\": 10,\r\n \"bitrate\": 1200\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/appconfig","description":"Call this interface to set the transcoding configuration information of the RTMP gateway service.
\nRequest body parameters
\nThe request body consists of a JSON Object type named settings which includes the following fields:
transcoding: JSON Object (Optional) Transcoding settings, includes the following fields:video: JSON Object type (Optional) Video transcoding settings, include the following fields:enabled: Boolean (Required) Whether to enable video transcoding, the default value is false(disabled).width: Number (Optional) Width in encoding resolution. The value range is 2 to 1920.height: Number (Optional) Height in encoding resolution. The value range is 2 to 1920.fps: Number (Optional) Encoding frame rate. The value range is 1 to 60.codec: String (Optional) H264 or H265audio: JSON Object (Optional) Audio transcoding settings. Include the following fields:enabled: Boolean (Required) Whether to enable audio transcoding. The default value is true(on).profile: Number (Optional) Encoded audio scene. The default is 0, means: 48 KHz sampling rate, music encoding, mono, the maximum encoding bit rate is 64 Kbps.codec: String (Optional) AAC or OPUSsimulcastStream: JSON Object (Optional) The function of large and small video streams, used to improve the adaptive switching capability of the viewer in a weak network environment. Includes the following fields:enabled: Boolean (Required) Whether to enable small video transcoding. The default is false(off). If you want to enable it, you must enable the video transcoding function at the same time.width: Number (Optional) Width in small stream resolution. The value range is 2 to 1920.height: Number (Optional) Height in small stream resolution, Number type. The value range is 2 to 1920.fps: Number (Optional) Small stream frame rate. The value range is 1 to 60.bitrate: Number (Optional) Small stream bit rate. The value range depends on the set width, height, fpsvalue, if it exceeds the range, it will be reset to the valid range.(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"}]}},"response":[{"id":"20b0234b-c949-474e-8164-298e704b4378","name":"configure","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"transcoding\": {\r\n \"video\": {\r\n \"enabled\": true,\r\n \"width\": 640,\r\n \"height\": 480,\r\n \"fps\": 15\r\n },\r\n \"audio\": {\r\n \"enabled\": false \r\n }\r\n },\r\n \"simulcastStream\": {\r\n \"enabled\": true,\r\n \"width\": 320,\r\n \"height\": 240,\r\n \"fps\": 10\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/appconfig","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","appconfig"],"variable":[{"id":"f8297374-7711-45b9-8950-3dd39383b13e","key":"region","value":"{{region}}"},{"id":"616128ed-001a-445e-8f54-712f4259f408","key":"appId","value":"{{appId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:36 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"184"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"ed8012bbb2b440c78b18c5685da843c1"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"e1d9b7e9-382a-42bb-9c51-9b9277d580a2"}],"id":"5568d053-6c44-46d6-ad7a-b3fbd05149a5","_postman_id":"5568d053-6c44-46d6-ad7a-b3fbd05149a5","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{customerId}}"},{"key":"password","value":"{{customerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"6aed9690-285e-45f0-a329-c995adbd0956","id":"6aed9690-285e-45f0-a329-c995adbd0956","name":"Media Gateway","type":"folder"}}},{"name":"Query Stream","item":[{"name":"query stream list","event":[{"listen":"test","script":{"id":"b290986d-edf8-401a-87dd-070282110a82","exec":["var jsonData = pm.response.json();","var sid = jsonData.data[0].sid;","console.log(sid);","pm.collectionVariables.set(\"sid\", sid);"],"type":"text/javascript","packages":{}}}],"id":"ff33368f-be09-442f-9195-49ef39ba5788","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/online-streams\n","description":"Query the list of streams currently being pushed.
\nResponse body parameters
\nIf the status code is 2xx, the request was successful. Body contains the following fields:
status: String. Request status. Value is success.data: JSON Object type, includes the following fields:streamKey: String. The streaming code to be queried.channel: String. The name of the audio network channel bound to the streaming code.uid: String. The UID of the user in the audio network channel bound to the streaming code.expiresAfter: Number. The effective duration of the streaming code, calculated from the creation time, in seconds.createdAt: String type, Unix time stamp created by streaming code, unit is seconds.bitrate: Number. The source stream bitrate (audio + video) of the push stream, in Kbps.video: object. Video stream parameters, only returned if statusis .\"Running\"width: Number. Video width, in px.height: Number. Video height, unit is px.fps: Number. Video frame rate, unit is fps.audio: Object. Audio stream parameters, only returned if statusis .\"Running\"channels: Number. Number of audio channels.sampleRate: Number. Audio sampling rate, unit is Hz.If the status code is not 2xx, the request has failed. The response body contains messagea field of String type, describing the specific reason for the failure.
(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"}]}},"response":[{"id":"7f4e9440-b6cb-4258-85eb-452ffca5460f","name":"query stream list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/streamkeys/:streamkey\n","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","streamkeys",":streamkey\n"],"variable":[{"key":"region","value":"ap","description":"(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\n`cn`: Chinese mainland\n`ap`: Asia except Mainland China\n`na`: North America\n`eu`: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.\n"},{"key":"appId","value":"9d2498880e934632b38b0a68fa2f1622","description":"(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.\n"},{"key":"streamkey\n","value":"","description":"(required) The streaming code to be queried."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:08 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"91"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"8af32870af66446f982c34762470da03"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"sid\": \"string\",\n \"channel\": \"demo\",\n \"uid\": \"100\",\n \"url\": \"string\",\n \"status\": \"string\",\n \"beginAt\": \"string\",\n \"bitrate\": 0,\n \"video\": {\n \"width\": 0,\n \"height\": 0,\n \"fps\": 0\n },\n \"audio\": {\n \"channels\": 0,\n \"sampleRate\": 0\n }\n }\n ]\n}"}],"_postman_id":"ff33368f-be09-442f-9195-49ef39ba5788"},{"name":"Mute/Unmute the stream","event":[{"listen":"test","script":{"id":"bc491711-c4db-4bd4-a749-8e47d2b37e06","exec":[""],"type":"text/javascript","packages":{}}}],"id":"0e9f38c1-8942-499d-9394-1e87466b326a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"videoMuted\": true,\r\n \"audioMuted\": false\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/online-streams/:sid/mute","description":"Command Execution Confirmation:
\nA successful API call confirms that the mute/unmute command has been successfully sent to the gateway node.
\nIt does not confirm the successful completion of the mute/unmute operation, as this is executed asynchronously in the background.
\nOperation Delay:
\nThe mute/unmute operation typically takes approximately 1 second from the time the request is sent to take effect.
\nIf the operation does not take effect as expected, you may retry the API call.
\nStream Reconnection Behavior:
\nThe API operates on the current stream at the time of the request.
\nIf the stream is interrupted and restarted, the new stream will default to an unmuted state, and you will need to call the API again if muting is required.
\nPath parameters
\nappId: string (required) App ID provided by Agora to each developer. After creating a project in the Agora console, you can get an App ID. App ID is a unique identifier for a project.
region: string (required) Create an area for pushing stream key. Agora supports the creation of stream keys by region. Currently, it supports the following regions:
na: North America
eu: European
ap: Asia except mainland China
cn: Chinese mainland
sid: string (required) You can get this through the \"Query Stream List API\" or from the webhook callback
Request body parameters
\nThe request body consists of a JSON Object type named settings which includes the following fields:
videoMuted: Boolean (required) A value of true means muting the video stream; a value of false means unmuting the video streamd.
audioMuted: Boolean (required) A value of true means muting the audio stream; a value of false means unmuting the audio stream
\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{customerId}}"},{"key":"password","value":"{{customerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"6aed9690-285e-45f0-a329-c995adbd0956","id":"6aed9690-285e-45f0-a329-c995adbd0956","name":"Media Gateway","type":"folder"}},"urlObject":{"protocol":"https","path":[":region","v1","projects",":appId","rtls","ingress","online-streams",":sid","mute"],"host":["api","agora","io"],"query":[],"variable":[{"description":{"content":"To ensure a successful request, do not set this required field to
\nnullor\"\".
(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"},{"description":{"content":"(required) You can get this value using the Query String List API
\n","type":"text/plain"},"type":"any","value":"{{sid}}","key":"sid"}]}},"response":[{"id":"2ce0085f-a651-4784-9e78-629ba9414767","name":"Mute/Unmute the stream","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"videoMuted\": true,\r\n \"audioMuted\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/online-streams/:sid/mute","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","online-streams",":sid","mute"],"variable":[{"key":"region","value":"{{region}}","description":"(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\n`cn`: Chinese mainland\n`ap`: Asia except Mainland China\n`na`: North America\n`eu`: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.\n\n"},{"key":"appId","value":"{{appId}}","description":"(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.\n"},{"key":"sid","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Aug 2024 06:05:25 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"X-Capacity-RateLimit-Limit-second","value":"100"},{"key":"X-Capacity-RateLimit-Remaining-second","value":"100"},{"key":"X-Capacity-RateLimit","value":"active"},{"key":"RateLimit-Reset","value":"1"},{"key":"X-RateLimit-Remaining-Second","value":"99"},{"key":"X-RateLimit-Limit-Second","value":"100"},{"key":"RateLimit-Limit","value":"100"},{"key":"RateLimit-Remaining","value":"99"},{"key":"X-Kong-Upstream-Latency","value":"83"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.8.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"770c0ac5b19340b891d8504827681ae3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"0e9f38c1-8942-499d-9394-1e87466b326a"},{"name":"query stream info","event":[{"listen":"test","script":{"id":"57e66b52-9096-4da1-909a-bd5f0b786753","exec":[""],"type":"text/javascript","packages":{}}}],"id":"42689183-25ad-4938-b76a-d59f90bb3d19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/online-streams/:sid\n","description":"Use the stream session ID (SID) to query the information of the specified ongoing stream.
\nResponse body parameters
\nIf the status code is 2xx, the request was successful. Body contains the following fields:
status: String. Request status. Value is success.data: JSON Object type, includes the following fields:streamKey: String. The streaming code to be queried.channel: String. The name of the audio network channel bound to the streaming code.uid: String. The UID of the user in the audio network channel bound to the streaming code.expiresAfter: Number. The effective duration of the streaming code, calculated from the creation time, in seconds.createdAt: String type, Unix time stamp created by streaming code, unit is seconds.bitrate: Number. The source stream bitrate (audio + video) of the push stream, in Kbps.video: object. Video stream parameters, only returned if statusis .\"Running\"width: Number. Video width, in px.height: Number. Video height, unit is px.fps: Number. Video frame rate, unit is fps.audio: Object. Audio stream parameters, only returned if statusis .\"Running\"channels: Number. Number of audio channels.sampleRate: Number. Audio sampling rate, unit is Hz.If the status code is not 2xx, the request has failed. The response body contains messagea field of String type, describing the specific reason for the failure.
(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"},{"description":{"content":"(required) The streaming session ID (Session ID) is the unique identifier for each streaming task initiated. It can be obtained by querying the current push list API , or by receiving the payload of the message notification callback .
\n","type":"text/plain"},"type":"any","value":"{{sid}}","key":"sid\n"}]}},"response":[{"id":"26284117-1284-45e2-81f9-6b59c97a0173","name":"query stream info","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/online-streams/:sid\n","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","online-streams",":sid\n"],"variable":[{"key":"region","value":"ap","description":"(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\n`cn`: Chinese mainland\n`ap`: Asia except Mainland China\n`na`: North America\n`eu`: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.\n"},{"key":"appId","value":"9d2498880e934632b38b0a68fa2f1622","description":"(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.\n"},{"key":"sid\n","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:08 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"91"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"8af32870af66446f982c34762470da03"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"sid\": \"3a394cda-d8ce-72f9-afd1-3d183a7f35a9\",\n \"channel\": \"demo\",\n \"uid\": \"100\",\n \"url\": \"rtls-ingress-prod-na.agoramdn.com/live/streamKey\",\n \"status\": \"Running\",\n \"beginAt\": \"1690097264\",\n \"bitrate\": 2106,\n \"video\": {\n \"width\": 1280,\n \"height\": 720,\n \"fps\": 30\n },\n \"audio\": {\n \"channels\": 2,\n \"sampleRate\": 48000\n }\n }\n}"}],"_postman_id":"42689183-25ad-4938-b76a-d59f90bb3d19"},{"name":"force disconnect","id":"44585312-b63d-48e6-b6b8-626412514951","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/online-streams/:sid","description":"Use the streaming session ID (SID) to disconnect the specified ongoing streaming.
\nYou can combine this interface with the destroy stream key API to completely disable the stream. Destroying the stream key will only delete the stream key from the database. After that, the stream key can no longer be used, but the ongoing stream key cannot be disconnected. If you need to disconnect the ongoing stream, you can refer to the following operations:
\nBe sure to destroy the stream key first, otherwise after using this interface alone to force a disconnection, the streaming software will immediately reconnect. At this time, a new stream session (corresponding to a new sid) will be generated, and the disconnection will fail.
(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"},{"type":"any","value":"{{sid}}","key":"sid"}]}},"response":[{"id":"b7300734-f10b-4312-b863-5d5401e2431c","name":"force disconnect","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/online-streams/:sid","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","online-streams",":sid"],"variable":[{"key":"region","value":"{{region}}"},{"key":"appId","value":"{{appId}}"},{"key":"sid","value":"{{sid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"170"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"4d508315094745c4bcbb8fd06bc57f7b"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"44585312-b63d-48e6-b6b8-626412514951"}],"id":"0a33b75c-704c-45c3-b908-8d9699ad0e6e","_postman_id":"0a33b75c-704c-45c3-b908-8d9699ad0e6e","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{customerId}}"},{"key":"password","value":"{{customerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"6aed9690-285e-45f0-a329-c995adbd0956","id":"6aed9690-285e-45f0-a329-c995adbd0956","name":"Media Gateway","type":"folder"}}},{"name":"create stream key","event":[{"listen":"test","script":{"id":"bc491711-c4db-4bd4-a749-8e47d2b37e06","exec":["var jsonData = pm.response.json();\r","pm.collectionVariables.set(\"streamKey\", jsonData.data.streamKey);\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r",""],"type":"text/javascript","packages":{}}}],"id":"a9260f56-b941-4d76-8855-31a8d00fdc6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"channel\": \"demo\",\r\n \"uid\": \"100\",\r\n \"expiresAfter\": 3600\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/streamkeys","description":"This interface creates a streaming key.
\nThis can ensure that the media stream is pushed to the correct channel and anchor uid. Before streaming, you need to create a stream key first.
\n\n\nPlease keep the created stream key properly and do not expose it, otherwise anyone can use the stream key to push streams to the channel.
\n
Path parameters
\nappId: string (required) App ID provided by Agora to each developer. After creating a project in the Agora console, you can get an App ID. App ID is a unique identifier for a project.region: string (required) Create an area for pushing stream key. Agora supports the creation of stream keys by region. Currently, it supports the following regions:na: North Americaeu: Europeanap: Asia except mainland Chinacn: Chinese mainlandstreamkey: string (required) Stream key that you need details from.Request body parameters
\nThe request body consists of a JSON Object type named settings which includes the following fields:
channel: (required) the Agora channel name, String type. The string length must be less than 64 bytes. The following character sets are supported:uid: String type (required) The host user UID of the RTMP gateway in the Agora channel. Can be a numeric ID or a string ID. If it is a numeric ID, the value range is from 1 to 2^32 -1; if it is a string ID, it cannot exceed 255 bytes, nor can it be an empty string. The supported character set is the same as that for the channel. To ensure a successful request, do not set this required field to null or \"\".expiresAfter: The validity period of the created stream key in seconds. Counted from creation time. If fill in with 0, the stream key will always be valid.\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{customerId}}"},{"key":"password","value":"{{customerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"6aed9690-285e-45f0-a329-c995adbd0956","id":"6aed9690-285e-45f0-a329-c995adbd0956","name":"Media Gateway","type":"folder"}},"urlObject":{"protocol":"https","path":[":region","v1","projects",":appId","rtls","ingress","streamkeys"],"host":["api","agora","io"],"query":[],"variable":[{"description":{"content":"To ensure a successful request, do not set this required field to
\nnullor\"\".
(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"}]}},"response":[{"id":"1c9cca56-92d1-4fd0-8024-8961e02ad34f","name":"create stream key","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"settings\": {\r\n \"channel\": \"demo\",\r\n \"uid\": \"100\",\r\n \"expiresAfter\": 3600\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/streamkeys","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","streamkeys"],"variable":[{"key":"region","value":"{{region}}","description":"(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\n`cn`: Chinese mainland\n`ap`: Asia except Mainland China\n`na`: North America\n`eu`: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.\n\n"},{"key":"appId","value":"{{appId}}","description":"(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Aug 2024 06:05:25 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"X-Capacity-RateLimit-Limit-second","value":"100"},{"key":"X-Capacity-RateLimit-Remaining-second","value":"100"},{"key":"X-Capacity-RateLimit","value":"active"},{"key":"RateLimit-Reset","value":"1"},{"key":"X-RateLimit-Remaining-Second","value":"99"},{"key":"X-RateLimit-Limit-Second","value":"100"},{"key":"RateLimit-Limit","value":"100"},{"key":"RateLimit-Remaining","value":"99"},{"key":"X-Kong-Upstream-Latency","value":"83"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.8.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"770c0ac5b19340b891d8504827681ae3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"streamKey\": \"AKxOnm8SAhrcu_-GY5fwH1Oz7b1Qt-z\",\n \"channel\": \"demo\",\n \"uid\": \"100\",\n \"expiresAfter\": 3600,\n \"createdAt\": \"1723183524\"\n }\n}"}],"_postman_id":"a9260f56-b941-4d76-8855-31a8d00fdc6e"},{"name":"query","id":"d0ecc3da-5acc-4f5d-918f-dcd83dea763b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/streamkeys/:streamkey\n","description":"Call this interface to query information about streaming codes, such as bound UID, bound channel name, valid duration.
\nPath parameters
\nappId: string (required) App ID provided by Agora to each developer. After creating a project in the Agora console, you can get an App ID. App ID is a unique identifier for a project.
region: string (required) Create an area for pushing stream key. Agora supports the creation of stream keys by region. Currently, it supports the following regions:
na: North Americaeu: Europeanap: Asia except mainland Chinacn: Chinese mainlandNote :
\nregion is in the same region as the input source stream.region is in the same region as the domain name used for push streaming.streamkey: string (required) Stream key that you need details from.
templateId: string (required) Stream configuration template ID. The value can only be a-z, A-Z, 0-9, and the length cannot exceed 12 bytes. The value of the flow configuration template ID can be set according to business scenario requirements. For example, the values can be \"720p\", \"1080p\" according to different target resolutions; the values can also be \"gameA\", \"gameB\" and so on according to different game scenarios.
Response body parameters
\nIf the status code is 2xx, the request was successful. Body contains the following fields:
status: String. Request status. Value is success.data: JSON Object type, includes the following fields:streamKey: String. The streaming code to be queried.channel: String. The name of the audio network channel bound to the streaming code.uid: String. The UID of the user in the audio network channel bound to the streaming code.expiresAfter: Number. The effective duration of the streaming code, calculated from the creation time, in seconds.createdAt: String type, Unix time stamp created by streaming code, unit is seconds.If the status code is not 2xx, the request has failed. The response body contains message a field of String type, describing the specific reason for the failure.
(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"},{"description":{"content":"(required) The streaming code to be queried.
\n","type":"text/plain"},"type":"any","value":"{{streamKey}}","key":"streamkey\n"}]}},"response":[{"id":"428bd4b4-ed37-4899-9478-ea6bb97f65bc","name":"query","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/streamkeys/:streamkey\n","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","streamkeys",":streamkey\n"],"variable":[{"key":"region","value":"ap","description":"(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\n`cn`: Chinese mainland\n`ap`: Asia except Mainland China\n`na`: North America\n`eu`: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.\n"},{"key":"appId","value":"9d2498880e934632b38b0a68fa2f1622","description":"(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.\n"},{"key":"streamkey\n","value":"","description":"(required) The streaming code to be queried."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:08 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"91"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"8af32870af66446f982c34762470da03"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"streamKey\": \"A0j5ptIcqnI2CQHd3zbQjUcgR58rbYH\",\n \"channel\": \"demo\",\n \"uid\": \"100\",\n \"expiresAfter\": 3600,\n \"createdAt\": \"1690097264\"\n }\n}"}],"_postman_id":"d0ecc3da-5acc-4f5d-918f-dcd83dea763b"},{"name":"destroy","id":"23d86349-1b24-4002-999d-ea6851231095","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/streamkeys/:streamkey","description":"Call this interface to destroy unused streaming keys.
\nPath parameters
\nappId: string (required) App ID provided by Agora to each developer. After creating a project in the Agora console, you can get an App ID. App ID is a unique identifier for a project.
region: string (required) Create an area for pushing stream key. Agora supports the creation of stream keys by region. Currently, it supports the following regions:
na: North America
eu: European
ap: Asia except mainland China
cn: Chinese mainland
streamkey: string (required) Stream key that you need details from.
templateId: string (required) Stream configuration template ID. The value can only be a-z, A-Z, 0-9, and the length cannot exceed 12 bytes. The value of the flow configuration template ID can be set according to business scenario requirements. For example, the values can be \"720p\", \"1080p\" according to different target resolutions; the values can also be \"gameA\", \"gameB\" and so on according to different game scenarios.
(required) The area where the streaming code is created, String type. Agora supports the creation of streaming codes by region, and currently supports the following regions:\ncn: Chinese mainland\nap: Asia except Mainland China\nna: North America\neu: Europe\nPlease make sure the region is the same as that for the input source stream and the domain name used for streaming.
(required) App ID provided by Agora, String type. After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\n","type":"text/plain"},"type":"any","value":"{{appId}}","key":"appId"},{"description":{"content":"(required) The stream key to be destroyed.
\n","type":"text/plain"},"type":"any","value":"{{streamKey}}","key":"streamkey"}]}},"response":[{"id":"1f7a2d32-99af-4f17-9669-3331fc08bfda","name":"destroy","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.agora.io/:region/v1/projects/:appId/rtls/ingress/streamkeys/:streamkey","protocol":"https","host":["api","agora","io"],"path":[":region","v1","projects",":appId","rtls","ingress","streamkeys",":streamkey"],"variable":[{"id":"c7060baa-14d2-45e0-8d11-a63fdf17a354","key":"region","value":"{{region}}"},{"id":"073a4a73-db73-49d8-8853-6bb674bbd205","key":"appId","value":"{{appId}}"},{"id":"79ee93a4-2127-4e75-990b-49b6ccf3fa54","key":"streamkey","value":"{{streamKey}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 23 Jul 2023 07:53:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kong-Upstream-Latency","value":"170"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.0.3"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"4d508315094745c4bcbb8fd06bc57f7b"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"23d86349-1b24-4002-999d-ea6851231095"}],"id":"6aed9690-285e-45f0-a329-c995adbd0956","description":"To execute requests in this folder using Postman, select the Media Gateway environment and fill in the corresponding values.
\nThe Agora RESTful API supports two authentication methods: Basic HTTP authentication and HMAC HTTP authentication. Basic authentication is easier to use but weaker in security. HMAC authentication has higher security and is the recommended authentication method.
\nX-Request-ID: UUID (Universal Unique Identifier) of the request. The Agora server returns this field in the response header.Authorization: For the value of this field, see the following authentication methods.All HTTP requests in this folder use basic authentication. Every time you send an HTTP request, you fill in the Authorization field in the request header. Use customerID as the Username, and customerSecret as the password. You can obtain these parameters from Agora Console by clicking on your user name and then selecting RESTful API fom the menu.
When sending an HTTP request using HMAC authentication, you generate a signature through the HMAC-SHA256 algorithm, and pass the signature and related information in the Authorization field of the request header.
In the process of generating the authentication field, you need to use the following information from your Agora account:
\nThe following Node.js code uses the API for obtaining service configuration information as an example to demonstrate how to generate the value of the Authorization field:
const crypto = require('crypto');\nconst http = require('http');\n// App ID of your soundnet project\nappid = \"\"\n// Customer ID obtained from the Agora console RESTful API\ncustomer_username = \"\"\n// The customer secret obtained from the Agora console RESTful API\ncustomer_secret = \"\"\nhost = \"https://api.agora.io\"\n// The region in of where you are going to send the request from. Ex. na, cn\nregion = \"\"\n// Request body\ndata = \"\"\nfunction hashData(data) {\n const hash = crypto.createHash('sha256');\n hash. update(data);\n return hash.digest('base64');\n}\nfunction signData(data) {\n const hmac = crypto.createHmac('sha256', customer_secret);\n hmac. update(data);\n return hmac.digest('base64');\n}\ndate = (new Date()).toUTCString();\nreqpath = `/${region}/v1/projects/${appid}/rtls/ingress/appconfig`;\nreqline = `GET ${reqpath} HTTP/1.1`;\n// Calculate the SHA-256 hash value of the Body\nbodySign = hashData(args.data);\ndigest = `SHA-256=${bodySign}`;\n// generate signature\nsigningStr = `host: ${host}\\ndate: ${date}\\n${reqline}\\ndigest: ${digest}`;\nsign = signData(signingStr);\nauth = `hmac username=\"${customer_username}\", `\nauth += `algorithm=\"hmac-sha256\", `\nauth += `headers=\"host date request-line digest\", `\nauth += `signature=\"${sign}\"`;\nconsole.log(`Authorization: ${auth}`);\n\n2xx, the request was successful.2xx, the request failed. Troubleshoot the problem according to the message field content in the corresponding response body.This article contains detailed help for the Media Push RESTful APIs.
\nThe RESTful APIs require basic HTTP authentication. You need to set the Authorization parameter in every HTTP request header. For how to get the value for Authorization, see RESTful API authentication.
You can implement different types of Media Push depending on the live streaming scenario requires transcoded or non-transcoded streaming. Transcoding is essentially an encoding and decoding function used to mix multiple audio and video streams into one audio and video stream, which can guarantee the synchronization of multiple hosts' live streams seen by the audience. Therefore, generally speaking, in the case of multiple-hosts live streaming, you need to enable transcoding when pushing streams to CDN; in the case of single-host live streaming, only one media stream is pushed to the CDN, so you do not need to enable transcoding. It is also required to set the codec to h264. Processing the media streams and pushing it to the CDN creates a Media Push task (shown as \"Converter\" in the rest of the article) in the Agora channel. You can control a Converter through the following methods:
\nCreate: Create a Converter for your project, and set up the relevant configuration of transcoded or non-transcoded streaming. The media stream in the channel is processed by the Converter according to this configuration and then pushed to the CDN.Delete: Destroy the specified Converter. The user's media stream in this channel will no longer be processed by the Converter or pushed to the CDN after you destroy the Converter.Update: Update the specified Converter configuration.Get: Get the streaming status of the specified Converter.POST https://api.agora.io/{region}/v1/projects/{appId}/rtmp-converters
appId: (Required) String. The App ID provided by Agora. You can get an App ID after creating a project in the Agora console. An App ID is the unique identification of a project.region: (Required) String. The region that the Converter was created in. Agora supports the creation of Converters in different regions. Currently, four regions are supported:cn: China Mainlandap: Asia, excluding Mainland Chinana: North Americaeu: Europeregion is lowercase.regionHintIp: (Optional) String. The IP address of the CDN source station. It must be a valid IPv4 address. This parameter can help ensure the stability of the RTMP stream.
POST https://api.agora.io/{region}/v1/projects/{appId}/rtmp-converters?regionHintIp={regionHintIp}
Content-Type: application/jsonAuthorization: The value of this field must refer to the Authentication instructions.X-Request-ID. Agora server returns an X-Custom-Request-ID field in the response header for trouble shooting.You can implement different types of Media Push depending on the live streaming scenario requires transcoded or non-transcoded streaming. Generally speaking, in the case of multiple-hosts live streaming, you need to enable transcoding when using Media Push RESTful APIs; in the case of single-host live streaming, only one media stream is pushed to the CDN, so you do not need to enable transcoding. For details, see Media Push Features.
\nMedia Push with transcoding
\nThe request Body is the converter field of JSON Object type. The field structure is shown in the following figure:
Details for these fields are shown in the following table:
\nMedia Push without transcoding
\nThe request body is the converter field of JSON Object type. The field structure is shown in the following figure:
Details for these fields are shown in the following table:
\nAll possible response status codes. See Status codes for details.
\nX-Resource-ID: The UUID (Universal Unique Identifier) that identifies the ID of the Converter updated in this request.If the status code is 2XX, the request is successful. The field structure is shown in the following figure:
\nDetails for these fields are shown in the following table:
\nIf the status code is not 2XX, the request fails. The body contains a String type message field that describes the specific reason for the failure.
{\n \"message\": \"Invalid authentication credentials.\"\n }\n\nCustom layout for Media Push with transcoding
\nThis example shows that the video of the two specified users in the show68 channel are mixed with a custom layout and pushed to the CDN. The audio of all users in the channel is also mixed.
{\n \"converter\": {\n \"name\": \"show68_vertical\",\n \"transcodeOptions\": {\n \"rtcChannel\": \"show68\",\n \"audioOptions\": {\n \"codecProfile\": \"LC-AAC\",\n \"sampleRate\": 48000,\n \"bitrate\": 48,\n \"audioChannels\": 1\n },\n \"videoOptions\": {\n \"canvas\": {\n \"width\": 360,\n \"height\": 640\n },\n \"layout\": [\n {\n \"rtcStreamUid\": 201,\n \"region\": {\n \"xPos\": 0,\n \"yPos\": 0,\n \"zIndex\": 1,\n \"width\": 360,\n \"height\": 320\n },\n \"fillMode\": \"fill\",\n \"placeholderImageUrl\": \"http://example.agora.io/user_placeholder.jpg\"\n },\n {\n \"rtcStreamUid\": 202,\n \"region\": {\n \"xPos\": 0,\n \"yPos\": 320,\n \"zIndex\": 1,\n \"width\": 360,\n \"height\": 320\n }\n }\n ],\n \"codecProfile\": \"High\",\n \"frameRate\": 15,\n \"gop\": 30,\n \"bitrate\": 400,\n \"seiOptions\": {}\n }\n },\n \"rtmpUrl\": \"rtmp://example/live/show68\"\n }\n}\n\nThe sample code for setting SEI information (seiOptions) is as follows:
{\n \"converter\": {\n \"transcodeOptions\": {\n \"videoOptions\": {\n \"seiOptions\": {\n \"source\": {\n \"metadata\": true,\n \"datastream\": true,\n \"customized\": {\n \"payload\": \"example\"\n }\n },\n \"sink\": {\n \"type\": 100\n }\n }\n }\n }\n }\n}\n\nVertical layout for Media Push with transcoding This example shows that the video of the two specified users in the show68 channel are mixed with a vertical layout and pushed to the CDN. The audio of two specified users in the channel are mixed.
{\n \"converter\": {\n \"name\": \"show68_vertical\",\n \"transcodeOptions\": {\n \"rtcChannel\": \"show68\",\n \"audioOptions\": {\n \"codecProfile\": \"HE-AAC\",\n \"sampleRate\": 48000,\n \"bitrate\": 128,\n \"audioChannels\": 1,\n \"rtcStreamUids\": [\n 201,\n 202\n ]\n },\n \"videoOptions\": {\n \"canvas\": {\n \"width\": 360,\n \"height\": 640,\n \"color\": 0\n },\n \"layout\": [\n {\n \"rtcStreamUid\": 201,\n \"region\": {\n \"xPos\": 0,\n \"yPos\": 0,\n \"zIndex\": 1,\n \"width\": 360,\n \"height\": 640\n },\n \"fillMode\": \"fill\",\n \"placeholderImageUrl\": \"http://example/host_placeholder.jpg\"\n },\n {\n \"rtcStreamUid\": 202,\n \"region\": {\n \"xPos\": 0,\n \"yPos\": 320,\n \"zIndex\": 1,\n \"width\": 360,\n \"height\": 320\n }\n }\n ],\n \"codec\": \"H.264\",\n \"codecProfile\": \"high\",\n \"frameRate\": 15,\n \"gop\": 30,\n \"bitrate\": 400,\n \"layoutType\": 1,\n \"vertical\": {\n \"maxResolutionUid\": 201,\n \"fillMode\": \"fill\",\n \"refreshIntervalSec\": 4\n },\n \"defaultPlaceholderImageUrl\": \"http://example/host_placeholder.jpg\",\n \"seiOptions\": {\n \"source\": {\n \"metadata\": true,\n \"datastream\": true,\n \"customized\": {\n \"payload\": \"example\"\n }\n },\n \"sink\": {\n \"type\": 100\n }\n }\n }\n },\n \"rtmpUrl\": \"rtmp://example/live/show68\",\n \"idleTimeout\": 300\n }\n}\n\nMedia Push without transcoding
\nThis example shows that the media stream of the specified user in the show68 channel is pushed to the CDN.
{\n \"converter\": {\n \"name\": \"show68_vertical\",\n \"rawOptions\": {\n \"rtcChannel\": \"show68\",\n \"rtcStreamUid\": 201\n },\n \"rtmpUrl\": \"rtmp://example/live/global\"\n }\n}\n\n{\n \"converter\": {\n \"id\": \"4c014467d647bb87b60b719f6fa57686\",\n \"createTs\": 1591786766,\n \"updateTs\": 1591786766,\n \"state\": \"connecting\"\n },\n \"fields\": \"id,createTs,updateTs,state\"\n}\n\nDELETE https://api.agora.io/{region}/v1/projects/{appId}/rtmp-converters/{converterId}
region: (Required) String. The region where the Converter is created in, which must be the same as the region set when creating Converter.appId: (Required) String type parameter. The App ID provided by Agora . You can get an App ID after creating a project in the Agora console. An App ID is the unique identification of a project.converterId: (Required) String type parameter. The ID of the Converter.Authorization: The value of this field must refer to the Authentication instructions.X-Request-ID. Agora server returns an X-Custom-Request-ID field in the response header for trouble shooting.All possible response status codes. See Status codes for details.
\nX-Resource-ID: The UUID (Universal Unique Identifier) that identifies the ID of the Converter created in this request.message field that describes the specific reason for the failure.PATCH https://api.agora.io/{region}/v1/projects/{appId}/rtmp-converters/{converterId}
region: (Required) String. The region where the Converter is created in, which must be the same as the region set when creating Converter.appId: (Required) String type parameter. The App ID provided by Agora. You can get an App ID after creating a project in the Agora console. An App ID is the unique identification of a project.converterId: (Required) String type parameter. The ID of the Converter.sequence: (Required) Number type parameter. The serial number of the Update request. The value must be greater than or equal to 0. Please make sure that the serial number of the next Update request is greater than the serial number of the previous Update request. The serial number can ensure that the Agora server updates the Converter according to the latest configuration you specify.
\n\nAgora recommends that you fill in
\nsequencesequentially, using 0 when calling Update for the first time, 1 for the second time, 2 for the third time, and so on. The Agora server will update the Converter according to the latest Update request (the largest serial number).
PATCH https://api.agora.io/v1/projects//rtmp-converters/?sequence={sequence}
Content-Type: application/jsonAuthorization: The value of this field must refer to the Authentication instructions.X-Request-ID. Agora server returns an X-Custom-Request-ID field in the response header for trouble shooting.For details about the fields, see the Create request body.
\n\n\n\n
Updatemethod does not support updating the following configurations of a Converter:
Create method to create a Converter that outputs video stream only or audio stream only, you cannot update it to a Converter that outputs audio stream only or video stream only through the Update method.layoutType is 1), you can only update the rtmpUrl field.All possible response status codes. See Status codes for details.
\nX-Resource-ID: The UUID (Universal Unique Identifier) that identifies the ID of the Converter updated in this request.If the status code is 2XX, the request is successful. The field structure is shown in the following figure:
\nDetails of these fields are shown in the following table:
\nIf the status code is not 2XX, the request fails. The body contains a String type message field that describes the specific reason for the failure.
{\n \"converter\": {\n \"id\": \"4c014467d647bb87b60b719f6fa57686\",\n \"createTs\": 1591786766,\n \"updateTs\": 1591788746,\n \"state\": \"running\"\n },\n \"fields\": \"id,createTs,updateTs,state\"\n}\n\nGET https://api.agora.io/{region}/v1/projects/{appId}/rtmp-converters/{converterId}
region: (Required) String. The region where the Converter is created in, which must be the same as the region set when creating Converter.appId: (Required) String type parameter. The App ID provided by Agora . You can get an App ID after creating a project in the Agora console. An App ID is the unique identification of a project.converterId: (Required) String type parameter. The ID of the Converter.Content-Type: application/jsonAuthorization: The value of this field must refer to the Authentication instructions.X-Request-ID. Agora server returns an X-Custom-Request-ID field in the response header for trouble shooting.All possible response status codes. See Status codes for details.
\nX-Resource-ID: The UUID (Universal Unique Identifier) that identifies the ID of the Converter created in this request.If the status code is 2XX, the request is successful. The field structure is shown in the following figure:
\nDetails of these fields are shown in the following table:
\nIf the status code is not 2XX, the request fails. The body contains a String type message field that describes the specific reason for the failed.
{\n \"reason\": \"Resource is not found and destroyed.\"\n}\n\nMedia Push without transcoding
\nIf the status code is 2XX, the request is successful. The field structure is shown in the following figure:
\nDetails of these fields are shown in the following table:
\nCustom layout for Media Push with transcoding
\nIf the status code is 2XX, the request is successful.
\n{\n \"name\": \"show68_vertical\",\n \"transcodeOptions\": {\n \"rtcChannel\": \"show68\",\n \"audioOptions\": {\n \"codecProfile\": \"HE-AAC\",\n \"sampleRate\": 48000,\n \"bitrate\": 128,\n \"audioChannels\": 1,\n \"rtcStreamUids\": [\n 201\n ]\n },\n \"videoOptions\": {\n \"canvas\": {\n \"width\": 360,\n \"height\": 640,\n \"color\": 0\n },\n \"layout\": [\n {\n \"rtcStreamUid\": 201,\n \"region\": {\n \"xPos\": 0,\n \"yPos\": 0,\n \"zIndex\": 1,\n \"width\": 360,\n \"height\": 320\n },\n \"fillMode\": \"fill\",\n \"placeholderImageUrl\": \"http://example.agora.io/host_placeholder.jpg\"\n },\n {\n \"rtcStreamUid\": 202,\n \"region\": {\n \"xPos\": 0,\n \"yPos\": 320,\n \"zIndex\": 1,\n \"width\": 360,\n \"height\": 320\n }\n },\n {\n \"imageUrl\": \"http://example.agora.io/watchmark.jpg\",\n \"region\": {\n \"xPos\": 0,\n \"yPos\": 0,\n \"zIndex\": 2,\n \"width\": 36,\n \"height\": 64\n },\n \"fillMode\": \"fit\"\n }\n ],\n \"codec\": \"H.264\",\n \"codecProfile\": \"High\",\n \"frameRate\": 15,\n \"gop\": 30,\n \"bitrate\": 400,\n \"seiOptions\": {}\n }\n },\n \"rtmpUrl\": \"rtmp://example.agora.io/live/show68\",\n \"idleTimeout\": 300,\n \"createTs\": 1616946970,\n \"updateTs\": 1783656785,\n \"state\": \"running\"\n}\n\nVertical layout for Media Push with transcoding
\nIf the status code is 2XX, the request is successful.
\n{\n \"name\": \"show68_vertical\",\n \"transcodeOptions\": {\n \"rtcChannel\": \"show68\",\n \"audioOptions\": {\n \"codecProfile\": \"HE-AAC\",\n \"sampleRate\": 48000,\n \"bitrate\": 128,\n \"audioChannels\": 1,\n \"rtcStreamUids\": [\n 201\n ]\n },\n \"videoOptions\": {\n \"canvas\": {\n \"width\": 360,\n \"height\": 640,\n \"color\": 0\n },\n \"layout\": [\n {\n \"rtcStreamUid\": 201,\n \"region\": {\n \"xPos\": 0,\n \"yPos\": 0,\n \"zIndex\": 1,\n \"width\": 360,\n \"height\": 640\n },\n \"fillMode\": \"fill\",\n \"placeholderImageUrl\": \"http://example.agora.io/host_placeholder.jpg\"\n }\n ],\n \"codec\": \"H.264\",\n \"codecProfile\": \"high\",\n \"frameRate\": 15,\n \"gop\": 30,\n \"bitrate\": 400,\n \"layoutType\": 1,\n \"vertical\": {\n \"maxResolutionUid\": 201,\n \"fillMode\": \"fill\",\n \"refreshIntervalSec\": 4\n },\n \"defaultPlaceholderImageUrl\": \"http://example.agora.io/host_placeholder.jpg\",\n \"seiOptions\": {\n \"source\": {\n \"metadata\": true,\n \"datastream\": true,\n \"customized\": {\n \"payload\": \"example\"\n }\n },\n \"sink\": {\n \"type\": 100\n }\n }\n }\n },\n \"rtmpUrl\": \"rtmp://example.agora.io/live/show68\",\n \"idleTimeout\": 300\n}\n\nMedia Push without transcoding
\n{\n \"converter\": {\n \"name\": \"wX8210Ce1VWVyGVHyaHA0W\",\n \"rawOptions\": {\n \"rtcChannel\": \"example\",\n \"rtcStreamUid\": XXXX\n },\n \"rtmpUrl\": \"rtmp://vid-218.push.chinanetcenter.broadcastapp.agora.io/live/global\",\n \"idleTimeout\": 120\n }\n}\n\nGET https://api.agora.io/v1/projects/{appId}/rtmp-convertersGET https://api.agora.io/v1/projects/{appId}/channels/{cname}/rtmp-convertersappId: (Required) String. The App ID provided by Agora. You can get an App ID after creating a project in the Agora console. An App ID is the unique identification of a project.cname: (Required) String. The Agora channel name. This is the channel to which the stream processed by the Converter belongs. The maximum length of the string is 64 characters, and the following character sets (89 characters in total) are supported:cursor: (Optional) String. Cursor for paging query Converters. The value must be greater than or equal to 0.
\n\n
List request for the first time. After the request is successful, the list of Converters on the first page return.cursor from the response body, and pass the cursor in the URL of the next request. Until the value of the cursor field in the response body is 0, it means that all Converters under the project or the specified channel have been queried.The HTTP URL using Query Parameters is as follows:
\nGET https://api.agora.io/v1/projects/{appId}/rtmp-converters?cursor={cursor}GET https://api.agora.io/v1/projects/{appId}/channels/{cname}/rtmp-converters?cursor={cursor}Content-Type: application/jsonAuthorization: The value of this field must refer to the Authentication instructions.X-Request-ID. Agora server returns an X-Custom-Request-ID field in the response header for troubleshooting.All possible response status codes. See Status codes for details.
\nX-Request-ID: The UUID (Universal Unique Identifier) that identifies this request. This value is the same as the X-Request-ID in the header of this request. If there is an error in the request, print out the value in the log to troubleshoot the problem.
\n\nIf the response status code of this request is not 2XX, this field may be missing from the response header.
\n
If the status code is 2XX, the request is successful. The field structure is shown in the following figure:
\nDetails for these fields are shown in the following table:
\n{\n \"success\": true,\n \"data\": {\n \"total_count\": 1,\n \"cursor\": 0,\n \"members\": [\n {\n \"rtcChannel\": \"testchannel\",\n \"status\": \"200\",\n \"converterName\": \"wX8210XXXXWVyGVHyaHA0W\",\n \"updateTs\": \"1641267823\",\n \"appId\": \"aab8b8f5a8cd4469a63042fcfafe7063\",\n \"rtmpUrl\": \"rtmp://example/live/areu\",\n \"ip\": \"183.131.160.244\",\n \"converterId\": \"889B6D4BEC4XXXXE68CCDA978BF21350\",\n \"create\": \"1641267818\",\n \"idleTimeout\": \"120\",\n \"state\": \"running\"\n }\n ]\n }\n}\n\nThe Agora server limits the call rate for the Media Push API by method. When a call rate exceeds its limit, the status code 429 (Too Many Requests) is returned. If you need a higher call rate, please contact technical support.
message field in the corresponding response message Body.This section summarizes the most important considerations for using the Media Push RESTful API.
\nhttps://docs.agora.io/en/Interactive%20Broadcast/streaming_product?platform=RESTful
\n","_postman_id":"685c918a-d7fa-4556-b07f-93d6f72d60c3","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}},{"name":"Media Pull","item":[{"name":"Create","event":[{"listen":"prerequest","script":{"id":"766d2fff-e2b0-4bb9-ba60-1d944e721b43","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"1f67345a-d845-4db6-bb1b-19d194aaca72","exec":["var jsonData = pm.response.json();\r","var playerId = jsonData.player.id;\r","console.log(playerId);\r","pm.collectionVariables.set(\"id\", playerId);"],"type":"text/javascript","packages":{}}}],"id":"a8a7547d-cdf7-4164-b7d6-f2263f2c676f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"player\": {\r\n \"streamUrl\": \"{{InjectUrl}}\",\r\n \"channelName\": \"{{AccessChannel}}\",\r\n \"token\": \"\",\r\n \"uid\": {{CloudPlayerUID}},\r\n // \"account\": \"{{CloudPlayerStringUid}}\"\r\n \"idleTimeout\": 300,\r\n \"name\": \"test\"\r\n }\r\n}"},"url":"https://api.agora.io/{{region}}/v1/projects/{{APPID}}/cloud-player/players","urlObject":{"protocol":"https","path":["{{region}}","v1","projects","{{APPID}}","cloud-player","players"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a8a7547d-cdf7-4164-b7d6-f2263f2c676f"},{"name":"Delete","event":[{"listen":"test","script":{"id":"81356c17-6430-4fbc-90de-b97881e0927c","exec":[""],"type":"text/javascript"}}],"id":"b6386a17-9a34-4fa5-81cb-7feec49b6b3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.agora.io/{{region}}/v1/projects/{{APPID}}/cloud-player/players/{{id}}","urlObject":{"protocol":"https","path":["{{region}}","v1","projects","{{APPID}}","cloud-player","players","{{id}}"],"host":["api","agora","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6386a17-9a34-4fa5-81cb-7feec49b6b3c"},{"name":"List","id":"aea1286d-1ebe-4181-8c0e-6e7c57b085fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.agora.io/v1/projects/{{APPID}}/cloud-player/players?Content-Type=application/json","urlObject":{"protocol":"https","path":["v1","projects","{{APPID}}","cloud-player","players"],"host":["api","agora","io"],"query":[{"key":"Content-Type","value":"application/json"}],"variable":[]}},"response":[],"_postman_id":"aea1286d-1ebe-4181-8c0e-6e7c57b085fb"}],"id":"66a79ef6-5286-49de-86e2-13400aa744c4","description":"The RESTful API for Media Pull enables you to inject an online media stream into the Agora channel as a live video source. After the injection succeeds, the online media stream automatically plays in the Agora channel, and remote users can see the content of the media stream.
\nInjecting an online media stream into the Agora channel creates a Media Pull task (shown as \"cloud player\" in the rest of the article) in the Agora channel. You can control the cloud player through the RESTful API and accomplish the following functions for Media Pull:
\nCreate: Creates a cloud player in the project.Delete: Destroys the cloud player in the project.List: Queries and lists all the cloud players in the project.Media Pull supports the following formats:
\nThe RESTful APIs require basic HTTP authentication. You need to set the Authorization parameter in every HTTP request header. For how to get the value for Authorization, see RESTful API authentication.
This API creates a cloud player in the project.
\nPOST https://api.agora.io/{region}/v1/projects/{appId}/cloud-player/players
appId: (Required) String. Agora provides the App ID when you create a project in Agora Console. The App ID identifies each project.region: (Required) String. The region that the cloud player was created in. Agora supports the creation of cloud players in different regions. Currently, it supports four regions:cn: China Mainlandap: Asia Pacificna: North Americaeu: EuropePlease ensure that the region you set is the same region as where your media stream originates is located.A sample request URL when using query parameters:
\nhttps://api.agora.io/{region}/v1/projects/{appId}/cloud-player/players?streamIp={streamIp}
streamIp: (Optional) String. The IP address of the media stream's origin server. Must be a valid IPv4 address. Use this parameter to ensure the transmission quality of the media stream when the media stream is only available in some regions. Otherwise, ignore this parameter.
The request header contains the following fields:
\nContent-Type: application/jsonAuthorization: See Authentication instructions.If the status code is 2XX, the request succeeds. The response body is a JSON Object called player, containing the following fields:
\n\n\n
\n- You must set the cloud player's username, which can be Number type or String type. Otherwise, the cloud player cannot be created, and Agora's server returns the
\n400(Bad Request)status code. Ensure that you have read How can I use a username in string type? when using a username in String type.- To avoid the failed request, do not pass
\nnullor\"\"in the required fields.
audioOptions: (Optional) JSON Object. The audio transcoding configuration of the cloud player. Setting this field to empty or not set means that the audio is not transcoded.Profile：Number. Audio profile. Sets the audio profile sample rate, bitrate, encoding mode, and the number of channels.0: Default audio profile.1: SPEECH_STANDARD. A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.2: MUSIC_STANDARD. A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.3: MUSIC_STANDARD_STEREO. A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.4: MUSIC_HIGH_QUALITY. A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.5: MUSIC_HIGH_QUALITY_STEREO. A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.videoOptions: (Optional) JSON Object. The video transcoding configuration of the cloud player. Setting this field to empty or not set means that the video is not transcoded.width: Number. The width (px) of the output video. The value range is [66,1920].height: Number. The height (px) of the output video. The value range is [66,1080].widthHeightAdaption: Bool. Whether to enable horizontal and vertical screen adaptive mode:true: Enable portrait and landscape adaptive mode. After you enable the adaptive mode, if the source media stream is in landscape mode, the output video width and height are 1280 × 720; if the source media stream is in portrait mode, the output video width and height are 720 × 1280.false: (Default) Do not enable portrait and landscape adaptive mode.frameRate: The frameRate (fps) of the output video. The value range is [1,30]. The default value is 15. For details, see Video profile table.bitrate: Number. The bitrate (Kbps) of the output video. The value range is [1,10000]. For details, see Video profile table.codec: String type. The encoding format of the output video. The following settings are supported:fillMode: String. The fill mode of the output video:fit: (Default) Scales the video proportionally until it is fully displayed in the viewport.fill: Scales the video proportionally until it fills the viewport.streamUrl: (Required) String. The RTMP/HTTP/HTTPS URL of the online media stream. The maximum length of this field is 1024 bytes.\n\nTo injetct an image to the Agora channel, set
\nstreamUrlto the URL of the image you want to inject, and the cloud player will convert the image to a video and inject it to the Agora channel. Images in JPEG and PNG formats are currently supported. You can set video transcoding parameters throughvideoOptions.
channelName: (Required) String. The channel name. The maximum length of this field is 64 bytes. Supported character scopes are:
Ensure that the value is different from any other User IDs of other users and players in the channel.
\nEnsure that the value is different from any other User Accounts of other users and players in the channel.
\ntoken: (Optional) String. The authentication token used by the cloud player in the channel. If you do not enable the App Certificate in Agora Console, ignore this field. If you enable the App Certificate in Agora Console, you must pass a value in this field:
uid or account must be the same as the User ID or User Account of the cloud player, and privilegeExpiredTs is recommended to be 0 to ensure that the token is valid for 24 hours at most.idleTimeout: (Optional) Number. The maximum length of time (in seconds) that the cloud player is idle. The \"idle\" state means that the media stream is not playing. When the idle state exceeds idleTimeout, the cloud player is automatically destroyed. The value ranges from 5 to 600. The default value is 300. If the value is less than 5, Agora's server automatically adjusts it to 5; if the value is greater than 600, Agora's server automatically adjusts it to 600.
playTs: (Optional) Number. The Unix timestamp (in seconds) when the cloud player starts playing the online media stream. The value range of playTs is [createTs-86400, createTs+300]. The default value is 0, which means the cloud player starts playing the online media stream when the cloud player is successfully created. If the value of playTs is not 0, the following behavior occurs:
playTs > createTs: The cloud player starts playing the online media stream when the time is playTs. This is suitable for timing playback with other elements.
playTs < createTs: If the online media stream is a live stream, the cloud player starts playing the live stream when the cloud player is successfully created. If the online media stream is an on-demand stream, the cloud player starts playing the online media stream at the specified time in the stream prior to the creation of the cloud player. This is suitable for error recovery. For example, if the cloud player experiences an error during operation, you can create a new cloud player and set the playTs field of new cloud player to the unix timestamp when the old cloud player started to play the online media stream.
To avoid repeatedly creating multiple cloud players to inject the same online media stream into the same channel, use the name parameter to manage all the cloud players in your specified project. Agora recommends that you pass a value in name using a combination of the channel name (channelName) and the username (uid or account) of the cloud player, such as class32_101 and class33_teacher101 in the sample code.
name is null if you do not pass any value. Multiple cloud players using null name parameters can exist in one project at the same time; multiple cloud players with the same name cannot exist in one project at the same time. When trying to create a cloud player with the same name as an existing cloud player in the project, you will receive the 409(Conflict) status code.encryptMode: (Optional) String. Encryption mode. Agora recommends using either the aes-128-gcm2 or aes-256-gcm2 encryption mode, both of which support adding a salt and are more secure.
aes-128-xts: 128-bit AES encryption, XTS mode.
aes-256-xts: 256-bit AES encryption, XTS mode.
aes-128-ecb: 128-bit AES encryption, ECB mode.
sm4-128-ecb: 128-bit SM4 encryption, ECB mode.
aes-128-gcm: 128-bit AES encryption, GCM mode.
aes-256-gcm: 256-bit AES encryption, GCM mode.
aes-128-gcm2: 128-bit AES encryption, GCM mode. Compared to aes-128-gcm encryption mode, aes-128-gcm2 encryption mode is more secure and requires you to set the salt (encryptKdfSalt).
aes-256-gcm2: 256-bit AES encryption, GCM mode. Compared to aes-256-gcm encryption mode, aes-256-gcm2 encryption mode is more secure and requires you to set the salt (encryptKdfSalt).
encryptKey: (Optional) String. Encryption key with unlimited length. Agora recommends using a 32-byte key.If you do not set an encryption key or set it as null, you cannot use the built-in encryption.
encryptKdfSalt: (Optional) String. The salt with the length of 32 bytes. Agora recommends using OpenSSL to generate the salt on your server. For details, see Media Stream Encryption.This parameter is only valid when you set the encryption mode as aes-128-gcm2 or aes-256-gcm2. In this case, ensure that this parameter is not 0.
repeatTime: (Optional) Int. Number of media streams played. This parameter applies only to on-demand streams. It can be set to:
1: (Default) Plays a media resource once.
-1: Plays media resources in a loop.
N: User-defined number of media resources to be played. It is an integer and cannot be set to 0.
seekPosition: (Optional) Number. Specifies the playback position (seconds) of the on-demand file. The default value is 0, which means play from the beginning of the on-demand file. It must be less than the media resource duration.
dataStreamOptions: (Optional) JSON Object. The data stream configuration, which is used to set the SEI information carried by the video frame. This parameter applies only to on-demand streams.
\nenable: Set whether to inject the SEI information of Agora DataStream type.
true: Inject the SEI information of Agora DataStream type.false: (Default) Do not inject the SEI information of Agora DataStream type. Agora DataStream is a data stream format of JSON type, the example is as follows:1message PositionData { 2 # The length of the on-demand file 3int32 duration = 1; 4 # The playback position of the on-demand file 5int32 position = 2; 6 # The user ID of the host playing the on-demand file 7int32 uid = 3; 8} For all possible response status codes, see Status codes.
\nThe response header contains the following fields:
\nX-Request-ID: UUID (Universally Unique Identifier) to identify this request. It is the same as the X-Request-ID field in the request header. If the request fails, print out this value in the log for troubleshooting.\n\nIf you receive the
\n401(Unauthorized)status code for this request, the response header does not contain the field.
X-Resource-ID: UUID (Universally Unique Identifier) to identify the cloud player created by this request:409(Conflict), the name of the cloud player created by this request is duplicate with the name of other existing players in the project. This value is the ID of that existing player. Please check and modify the name of the cloud player created by this request.If the status code is 2XX, the request succeeds. The response body contains the following fields:
\nplayer: JSON Object. Contains the following fields:uid: Number. The User ID of the cloud player in the channel.account: String. The User Account of the cloud player in the channel.id: String. The ID of the cloud player. It is a UUID (Universally Unique Identifier) generated by Agora's server to identify the ID of the cloud player created.createTs: Number. The Unix timestamp (in seconds) when creating the cloud player.status: String. The state of the cloud player at runtime:\"idle\": The playback is not started.\"connecting\": Agora's server is connecting to the address of the media stream or detecting the audio and video data.\"running\": Playing.\"failed\": Agora's server cannot connect to the address of the media stream, or the media stream cannot be played.fields: String. The field mask to represent a set of symbolic field paths. The field mask is encoded as a single string where paths are separated by a comma. It specifies a subset of fields that should be returned by this request. In the sample code using uid, fields specifies that Agora's server returns the uid, id, createTs, and status fields. For details, see Google protobuf FieldMask.If the status code is not 2XX, the request fails. The response body contains the message field, which describes the detailed reason for the failure.
Media Pull without transcoding
\n{\n \"player\": {\n \"streamUrl\": \"rtmp://example.agora.io/live/class32/101\",\n \"channelName\": \"class32\",\n \"token\": \"2a784467d6\",\n \"uid\": 101,\n \"idleTimeout\": 300,\n \"playTs\": 1575508644,\n \"name\": \"test\"\n }\n}\n\nMedia Pull with transcoding
\n{\n \"player\": {\n \"audioOptions\": {\n \"profile\": 1\n },\n \"videoOptions\": {\n \"width\": 1920,\n \"height\": 1080,\n \"frameRate\": 15,\n \"bitrate\": 400,\n \"codec\": \"VP8\",\n \"gop\": 30,\n \"fillMode\": \"fill\"\n },\n \"streamUrl\": \"rtmp://example.agora.io/live/class32/101\",\n \"channelName\": \"class32\",\n \"token\": \"2a784467d6\",\n \"uid\": 101,\n \"idleTimeout\": 300,\n \"playTs\": 1575508644,\n \"name\": \"test\"\n }\n}\n\n{\n \"player\": {\n \"uid\": 101,\n \"id\": \"2a784467d647bb87b60b719f6fa56317\",\n \"createTs\": 1575508644,\n \"status\": \"running\"\n },\n \"fields\": \"player.uid,player.id,player.createTs,player.status\"\n}\n\nThis API destroys the cloud player in the project.
\nDELETE https://api.agora.io/{region}/v1/projects/{appId}/cloud-player/players/{id}
appId: (Required) String. Agora provides the App ID when you create a project in Agora Console. The App ID identifies each project.id: (Required) String. The ID of the cloud player.region: (Required) String. The region where the Player is created in.Authorization: See Authentication.For all possible response status codes, see Status codes.
\nThe response header contains the following fields:
\nX-Request-ID: UUID (Universally Unique Identifier) to identify this request. It is the same as the X-Request-ID field in the request header. If the request fails, print out this value in the log for troubleshooting.\n\nIf you receive the
\n401(Unauthorized)status code for this request, the response header does not contain the field.
X-Resource-ID: UUID (Universally Unique Identifier) to identify the ID of the cloud player created by this request. The UUID is the same as the value in the id path parameter.message field, which describes the detailed reason for the failure.This API queries and lists all the cloud players in the project.
\nGET https://api.agora.io/v1/projects/{appId}/cloud-player/players
appId: (Required) String. Agora provides the App ID when you create a project in Agora Console. The App ID identifies each project.
A sample request URL when using query parameters:
\nhttps://api.agora.io/v1/projects/{appId}/cloud-player/players?filter={filter}&pageSize={pageSize}&pageToken={pageToken}
eq and require URL encoding.Assuming the channel name is class32, replace filter={filter} in the sample request URL with filter=channelName eq class32; Assuming the channel name is bigclass, replace filter={filter} in the sample request URL with filter=channelName eq bigclass.pageSize: (Optional) Number. The maximum number of cloud players to return on one page. The value ranges from 1 to 500. The default value is 200, which means that for a single page, Agora's server lists up to 200 cloud players if you do not pass in any value.List API for the first time, do not pass any value in the pageToken query parameter. You can get the query results of the first page and the value of the nextPageToken field. The next time you use the List API, pass this value in the pageToken query parameter to query the cloud players on the next page.After using the above parameters, Agora's server queries and lists the cloud players according to the following steps:
\n\n\nAgora's server lists the cloud players in ascending order by
\ncreateTs.
The request header contains the following fields:
\nAuthorization: See Authentication.For all possible response status codes, see Status codes.
\n401(Unauthorized) status code for this request, the response header does not contain the field.If the status code is 2XX, the request succeeds. The response body contains the following fields:
\ntotalSize: Number. The number of cloud players that meet the filter criteria.players: JSON Array. Contains the following fields:name: String. The name of the cloud player.streamUrl: String. The RTMP/HTTP/HTTPS URL of the online media stream.channelName: String. The name of the Agora channel.uid: Number. The User ID of the cloud player in the Agora channel.account: String. The User Account of the cloud player in the Agora channel.id: String. UUID (Universally Unique Identifier) to identify the cloud player created. It is the ID of the cloud player.createTs: Number. The Unix timestamp (in seconds) when creating the cloud player.status: String. The state of the cloud player at runtime:\"idle\": The playback is not started.\"connecting\": Agora's server is connecting to the address of the media stream or detecting the audio and video data.\"running\": Playing.\"failed\": Agora's server cannot connect to the address of the media stream, or the media stream cannot be played.fields: String. The field mask to represent a set of symbolic field paths. The field mask is encoded as a single string where paths are separated by a comma. It specifies that Agora's server returns a subset of fields in each player in the players array. In the sample code using uid, fields specifies that Agora's server returns the name, streamUrl, channelName, uid, id, createTs, and status fields in each player in the players array.nextPageToken: String. The next page number of pageToken. You can pass the value of the nextPageToken field in the pageToken query parameter when using the List API next time. When nextPageToken is an empty string, there are no more players that match the request.If the status code is not 2XX, the request fails. The response body contains the message field, which describes the detailed reason for the failure.
{\n \"totalSize\": 10,\n \"players\": [{\n \"name\": \"class32_101\",\n \"streamUrl\": \"rtmp://example.agora.io/live/class32/101\",\n \"channelName\": \"class32\",\n \"uid\": 101,\n \"id\": \"2a784467d647bb87b60b719f6fa56317\",\n \"createTs\": 1575508644,\n \"status\": \"running\"\n }, {\n \"name\": \"class68_422\",\n \"streamUrl\": \"rtmp://example.agora.io/live/class68/422\",\n \"channelName\": \"class68\",\n \"uid\": 422,\n \"id\": \"0b719f6fa563172a784467d647bb87b6\",\n \"createTs\": 1575588644,\n \"status\": \"connecting\"\n }],\n \"fields\": \"player.name,player.streamUrl,player.channelName,player.uid,player.id,player.createTs,player.status\",\n \"nextPageToken\": \"7b60b719f\"\n}\n\nDo not exceed the API rate limits, otherwise you receive the 429(Too Many Requests) status code.
message field in the response body for troubleshooting.After using these RESTful APIs, Agora's notification server sends the callback notification to your server through HTTP or HTTPS request. For details, see Message Notification Service.
\nThis section summarizes some important considerations when using the Media Pull RESTful API.
\nThis collection is the Agora Media PushI Stream RESTful API collection. (previously Media Inject, Cloud Player)
\nhttps://docs.agora.io/en/Interactive%20Broadcast/inject_stream_restful_overview?platform=RESTful
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"754a6adc-e068-4f54-a8f1-c2218cf1b2c4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7bba98fa-9da0-4107-ad89-730f2b391e32","type":"text/javascript","exec":[""]}}],"_postman_id":"66a79ef6-5286-49de-86e2-13400aa744c4"},{"name":"IoT License Activation","item":[{"name":"activate","event":[{"listen":"test","script":{"id":"4ca1583a-f6b7-4711-87d2-389afc46dfc1","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"6ddb96e8-f053-400c-898a-8a774d6b33c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.agora.io/dabiz/license/v2/active?pid={{pid}}&licenseKey={{licenseKey}}&appid={{appID}}","description":"After receiving the Agora license, use the activate request for license activation.
Response parameters
\nIf the response status code is 200, the request is successful, and the response body contains the following parameters:
If the request fails, the status code is not 200. Follow the returned status code and the message field in the response body to troubleshoot errors.
Response example
The following is a response example for a successful activation request:
{\n \"code\":200,\n \"data\":{\n \"license\":\"1D65xxxxxxxxxxxxxxxxxxxxxxxx6016\",\n \"skuView\":{\n \"product\":1,\n \"name\":\"01\",\n \"mediaType\":1,\n \"minutes\":100,\n \"period\":\"00:00~23:59\"\n }\n }\n}\n\nThe license identification defined by SKU, validity period, and category.
\n","type":"text/plain"},"key":"pid","value":"{{pid}}"},{"description":{"content":"The unique ID of the device. For example, the SN number, Mac address, and so on. The string length must be less than 64 bytes.
\n","type":"text/plain"},"key":"licenseKey","value":"{{licenseKey}}"},{"description":{"content":"The unique identifier assigned by Agora to your project.
\n","type":"text/plain"},"key":"appid","value":"{{appID}}"}],"variable":[]}},"response":[],"_postman_id":"6ddb96e8-f053-400c-898a-8a774d6b33c4"}],"id":"c8160c19-a234-49fd-a333-7723b7ca53b2","description":"Call frequency limit
\nFor each Agora account (not each App ID), the maximum call frequency of each API on this page is 10 queries per second.
\nThe activation request requires basic authentication. Use the customerID as the Username, and the customerSecret as the password. You can obtain these parameters from Agora Console by clicking on your user name and then selecting RESTful API fom the menu.
Set this to country, region, net,s dk, os, or device
\n","type":"text/plain"},"key":"dimension","value":"{{dimension}}"},{"description":{"content":"Set this to video_freeze_rate or audio_freeze_rate
\n","type":"text/plain"},"key":"metric","value":"{{metric}}"}],"variable":[]}},"response":[],"_postman_id":"8074fa31-feb6-4332-8698-37c52250c61d"},{"name":"Retrieve Audio/Video freeze rate statistics","id":"01b90526-9a8d-4ae8-87fb-8feecc6b56ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/analytics/call/freeze/bucxket?start_ts={{created_ts}}&end_ts={{destroyed_ts}}&appid={{APPID}}&call_id={{call_id}}&metric={{metric}}","urlObject":{"path":["beta","analytics","call","freeze","bucxket"],"host":["{{baseUrl}}"],"query":[{"key":"start_ts","value":"{{created_ts}}"},{"key":"end_ts","value":"{{destroyed_ts}}"},{"key":"appid","value":"{{APPID}}"},{"key":"call_id","value":"{{call_id}}"},{"description":{"content":"Set this to video_freeze_rate or audio_freeze_rate
\n","type":"text/plain"},"key":"metric","value":"{{metric}}"}],"variable":[]}},"response":[],"_postman_id":"01b90526-9a8d-4ae8-87fb-8feecc6b56ab"},{"name":"Retrieve Insight Statistics","id":"bd212289-39ae-4bdd-9b21-ff7306f46493","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/analytics/call/statistics/time?start_ts={{created_ts}}&end_ts={{destroyed_ts}}&appid={{APPID}}&call_id={{call_id}}&metric={{metric}}","urlObject":{"path":["beta","analytics","call","statistics","time"],"host":["{{baseUrl}}"],"query":[{"key":"start_ts","value":"{{created_ts}}"},{"key":"end_ts","value":"{{destroyed_ts}}"},{"key":"appid","value":"{{APPID}}"},{"key":"call_id","value":"{{call_id}}"},{"description":{"content":"Set this to user_count, audio_freeze_rate, video_freeze_rate,\n audio_freeze_user_count, or video_freeze_user_count
\n","type":"text/plain"},"key":"metric","value":"{{metric}}"}],"variable":[]}},"response":[],"_postman_id":"bd212289-39ae-4bdd-9b21-ff7306f46493"}],"id":"7e05326b-b4c1-4fe0-aab3-e7c993a7e3b9","_postman_id":"7e05326b-b4c1-4fe0-aab3-e7c993a7e3b9","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}},{"name":"Data Insights","item":[{"name":"WebRTC","item":[{"name":"Quality by networkDelay","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"4aafbc43-1b3e-41e8-b2d1-756251203d43"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"71d99ee7-f346-487d-ae3b-4c38bcc54278"}}],"id":"096925d6-64d1-4b99-9491-0a730b1e71ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=networkDelay&aggregateGranularity=1h&productType=WebRTC","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"networkDelay"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"096925d6-64d1-4b99-9491-0a730b1e71ce"},{"name":"Quality by joinSuccessRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"54a6fc1a-9203-4537-88fa-cb98b0cb21b9"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"9a97071c-5ad2-4c11-a386-e99169a91bcc"}}],"id":"b2fc311b-f516-4f58-adc3-efaa7dbae96f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=joinSuccessRate&aggregateGranularity=1h&productType=WebRTC","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"joinSuccessRate"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"b2fc311b-f516-4f58-adc3-efaa7dbae96f"},{"name":"Quality by joinSuccessIn5sRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"2147da6a-7e59-4531-ac3a-3c452e0a22e0"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"b37b43c4-4d92-4aa6-9a27-2ca1d9c16bd1"}}],"id":"53bb9dab-055a-4f25-9035-cbf6bc12b092","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=joinSuccessIn5sRate&aggregateGranularity=1h&productType=WebRTC","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"joinSuccessIn5sRate"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"53bb9dab-055a-4f25-9035-cbf6bc12b092"},{"name":"Quality by audioFreezeRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"d7f41af9-e149-41f3-8930-ec75e836c39a"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"7caedc23-935b-40fd-89cf-97f4135a4aab"}}],"id":"f0436877-e7d7-447b-a1e5-3ab9a910db73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=audioFreezeRate&aggregateGranularity=1h&productType=WebRTC","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"audioFreezeRate"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"f0436877-e7d7-447b-a1e5-3ab9a910db73"},{"name":"Quality by videoFreezeRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"3e2083e6-73db-4037-ab18-386bd11b43a2"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"f4c6a648-98e6-4d5a-a668-2070f3d3c289"}}],"id":"f255c57c-a5f1-4f18-971e-7b64263ea5ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=videoFreezeRate&aggregateGranularity=1h&productType=WebRTC","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"videoFreezeRate"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"f255c57c-a5f1-4f18-971e-7b64263ea5ae"}],"id":"03aa94f3-be21-4968-a2b9-94a9c5b63637","_postman_id":"03aa94f3-be21-4968-a2b9-94a9c5b63637","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}},{"name":"Native","item":[{"name":"Quality by networkDelay","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"85bd4cc8-3e6b-41a6-86a4-9b864fc99a50"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"aaaa96a3-9c7c-422b-a4e7-08b8f49d58c2"}}],"id":"ff0c4b8b-b6d7-4b17-b104-af2da23dce34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=networkDelay&aggregateGranularity=1h&productType=Native","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"networkDelay"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"ff0c4b8b-b6d7-4b17-b104-af2da23dce34"},{"name":"Quality by joinSuccessRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"3ed4f6b9-4898-4218-b4c4-1ea22065d130"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"8e84a6b4-ca06-4b1a-922f-bc36530abef9"}}],"id":"19b957cb-c28c-4578-b4e3-279aeee5fd57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=joinSuccessRate&aggregateGranularity=1h&productType=Native","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"joinSuccessRate"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"19b957cb-c28c-4578-b4e3-279aeee5fd57"},{"name":"Quality by joinSuccessIn5sRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"88ffab37-8cb5-4d11-a139-8aaad8b0ed85"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"8caa6c31-aca1-4281-8837-6fc4fe11dcfb"}}],"id":"67e5f5b0-b171-48cf-999f-f2433ea02c3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=joinSuccessIn5sRate&aggregateGranularity=1h&productType=Native","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"joinSuccessIn5sRate"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"67e5f5b0-b171-48cf-999f-f2433ea02c3a"},{"name":"Quality by audioFreezeRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"bd402ab7-3ca6-4349-b64a-d1c12a518e0a"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"462a1340-10bd-42b2-a346-97d19266be81"}}],"id":"224032b9-07c1-4f3a-9b14-e891a4a8bd63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=audioFreezeRate&aggregateGranularity=1h&productType=Native","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"audioFreezeRate"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"224032b9-07c1-4f3a-9b14-e891a4a8bd63"},{"name":"Quality by videoFreezeRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"96089ab8-84c4-4456-a8d0-e502c32b7e88"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"206eabac-78a9-4cbe-84d1-a73270003a73"}}],"id":"11c28248-0422-4fa0-a095-3b3bab665de9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/quality/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=videoFreezeRate&aggregateGranularity=1h&productType=Native","urlObject":{"path":["beta","insight","quality","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"videoFreezeRate"},{"key":"aggregateGranularity","value":"1h"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"11c28248-0422-4fa0-a095-3b3bab665de9"}],"id":"d225a921-2833-4888-acf3-84aa1001e55a","_postman_id":"d225a921-2833-4888-acf3-84aa1001e55a","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}},{"name":"Usage by userCount","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"9c28fa09-1ba4-43e4-a4e7-11a5bc6fc7ad"}},{"listen":"prerequest","script":{"exec":["// Last 3 days","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 86400 * 3));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 43200));",""],"type":"text/javascript","id":"59f1e36f-ef8e-4378-851f-3fbc5b043803"}}],"id":"95b7fed3-13e4-425f-8e37-85b2bd7cfce9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/insight/usage/by_time?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=userCount&aggregateGranularity=1d","urlObject":{"path":["beta","insight","usage","by_time"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"userCount"},{"key":"aggregateGranularity","value":"1d"}],"variable":[]}},"response":[],"_postman_id":"95b7fed3-13e4-425f-8e37-85b2bd7cfce9"}],"id":"9a1fdc6e-94df-4718-992b-cdeea802cbba","_postman_id":"9a1fdc6e-94df-4718-992b-cdeea802cbba","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}},{"name":"Realtime","item":[{"name":"WebRTC","item":[{"name":"Quality by networkDelay","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"ea3d66a0-d8f2-467b-a1f7-d491a2483340"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"7520cb6c-826e-456e-b446-0eaf21095708"}}],"id":"b63dd0a5-a58f-4294-aa3b-ac419f6d0a38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=networkDelay&productType=WebRTC","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"networkDelay"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"b63dd0a5-a58f-4294-aa3b-ac419f6d0a38"},{"name":"Quality by joinSuccessRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"339581d2-a4c2-441c-a038-85b8abd87475"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"7bda2f80-53d2-464a-8063-2769f89312a6"}}],"id":"34af005a-484a-49c1-975d-05d351d56a06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=joinSuccessRate&productType=WebRTC","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"joinSuccessRate"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"34af005a-484a-49c1-975d-05d351d56a06"},{"name":"Quality by joinSuccessIn5sRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"b95064e3-3ef7-4077-9cc1-5c465a87a857"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"8d03a3d5-ca46-49c9-800f-66c3fb7115b3"}}],"id":"b774c4ea-f087-4459-8fd5-ec89cda77611","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=joinSuccessIn5sRate&productType=WebRTC","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"joinSuccessIn5sRate"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"b774c4ea-f087-4459-8fd5-ec89cda77611"},{"name":"Quality by audioFreezeRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"de269eed-5d93-4667-98ea-82a58e758a08"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"0f5a07b4-a396-43af-8c05-a8ff06828635"}}],"id":"6745f4dc-471a-43d9-9e22-387a214aa980","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=audioFreezeRate&productType=WebRTC","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"audioFreezeRate"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"6745f4dc-471a-43d9-9e22-387a214aa980"},{"name":"Quality by videoFreezeRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"4558e3b6-ea2d-4457-bd55-ddeb7e7dcde4"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"441c754d-4f82-49ec-9bd5-b6524fe27a37"}}],"id":"ceff4fd9-a2d1-403b-a76d-d37c30b02c5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=videoFreezeRate&productType=WebRTC","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"videoFreezeRate"},{"key":"productType","value":"WebRTC"}],"variable":[]}},"response":[],"_postman_id":"ceff4fd9-a2d1-403b-a76d-d37c30b02c5e"},{"name":"Scale - ChannelCount","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"0b248998-5dfc-474b-a968-22f92b1eea89"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"fd63f62b-9bdf-4040-a0b2-c1402c664a87"}}],"id":"e2948b77-856e-42ec-9794-6563828e87e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/usage/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=channelCount&productType=WebRTC","urlObject":{"path":["beta","realtime","usage","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"channelCount"},{"key":"productType","value":"WebRTC"},{"disabled":true,"key":"cname","value":""}],"variable":[]}},"response":[],"_postman_id":"e2948b77-856e-42ec-9794-6563828e87e1"},{"name":"Scale - UserCount","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"85ec9b1f-9ec7-4d4c-b7e2-e8e51e037337"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"4244a972-fe83-46d9-87f1-5037592c026b"}}],"id":"f6b88adf-6a7f-41e0-8d73-a936053d01c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/usage/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=userCount&productType=WebRTC","urlObject":{"path":["beta","realtime","usage","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"userCount"},{"key":"productType","value":"WebRTC"},{"disabled":true,"key":"cname","value":""}],"variable":[]}},"response":[],"_postman_id":"f6b88adf-6a7f-41e0-8d73-a936053d01c4"}],"id":"0c5a2418-53e7-4a19-ba66-e37b6719481c","_postman_id":"0c5a2418-53e7-4a19-ba66-e37b6719481c","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}},{"name":"Native","item":[{"name":"Quality by networkDelay","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"be3e3f7c-cd45-4214-9dca-fd48378b3382"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"75d24f63-72e3-4fc2-b54b-a93ce6df2f11"}}],"id":"a299c734-d6ab-4fa7-bbf2-5329fb54f7e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=networkDelay&productType=Native","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"networkDelay"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"a299c734-d6ab-4fa7-bbf2-5329fb54f7e7"},{"name":"Quality by joinSuccessRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"5e3d213c-1611-4f92-9b22-31d813f468f9"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"b4775d95-3f2f-4ce1-bdda-ecb741a0bc2a"}}],"id":"48cd00b3-b432-490b-9922-e4b9e463d650","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=joinSuccessRate&productType=Native","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"joinSuccessRate"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"48cd00b3-b432-490b-9922-e4b9e463d650"},{"name":"Quality by joinSuccessIn5sRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"e28e4fc9-c8a4-4f39-ab06-b353364d1f02"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"72975c45-53fa-4997-862e-c8cb3d34160f"}}],"id":"99f72616-8d33-438c-9f48-5239406430f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=joinSuccessIn5sRate&productType=Native","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"joinSuccessIn5sRate"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"99f72616-8d33-438c-9f48-5239406430f2"},{"name":"Quality by audioFreezeRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"a747f3f1-ebd9-4ecc-a482-9362c9aab63f"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"dc82979e-c3d8-4f53-8591-70ebbf690b85"}}],"id":"a2bc548c-f72d-496c-9a58-1e14197af4f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=audioFreezeRate&productType=Native","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"audioFreezeRate"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"a2bc548c-f72d-496c-9a58-1e14197af4f6"},{"name":"Quality by videoFreezeRate","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"a942a2f7-eb0a-4a66-be45-3dca288ed742"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"1c8e921e-2e9e-49ec-8281-f48b31fb3a4c"}}],"id":"406f83a4-21a1-4517-9837-f360b8e9b1a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/quality/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=videoFreezeRate&productType=Native","urlObject":{"path":["beta","realtime","quality","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"videoFreezeRate"},{"key":"productType","value":"Native"}],"variable":[]}},"response":[],"_postman_id":"406f83a4-21a1-4517-9837-f360b8e9b1a3"},{"name":"Scale - ChannelCount","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"4b1d5a6d-add7-4a1d-ba81-10cf7d0b768b"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"ffab4398-7908-471e-86fb-396852a8bfd4"}}],"id":"03f73333-de3a-47cb-9c31-d87e779b6fa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/usage/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=channelCount&productType=Native","urlObject":{"path":["beta","realtime","usage","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"channelCount"},{"key":"productType","value":"Native"},{"disabled":true,"key":"cname","value":""}],"variable":[]}},"response":[],"_postman_id":"03f73333-de3a-47cb-9c31-d87e779b6fa7"},{"name":"Scale - UserCount","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"e0ec9099-dea0-47fa-8b51-aab72f3eb135"}},{"listen":"prerequest","script":{"exec":["// Last 40 mins","pm.collectionVariables.set(\"startTs\", Math.floor(Date.now() / 1000 - 60 * 40));","pm.collectionVariables.set(\"endTs\", Math.floor(Date.now() / 1000 - 40));",""],"type":"text/javascript","id":"0c5cde84-2bcc-400e-99ec-79d98860fac3"}}],"id":"af231f4a-2302-4708-b4a6-4ff5b6625f6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/beta/realtime/usage/by_time_20sec?startTs={{startTs}}&endTs={{endTs}}&appid={{APPID}}&metric=userCount&productType=Native","urlObject":{"path":["beta","realtime","usage","by_time_20sec"],"host":["{{baseUrl}}"],"query":[{"key":"startTs","value":"{{startTs}}"},{"key":"endTs","value":"{{endTs}}"},{"key":"appid","value":"{{APPID}}"},{"key":"metric","value":"userCount"},{"key":"productType","value":"Native"},{"disabled":true,"key":"cname","value":""}],"variable":[]}},"response":[],"_postman_id":"af231f4a-2302-4708-b4a6-4ff5b6625f6f"}],"id":"159f8932-dd0e-4a2f-89f7-728be0b0ff23","_postman_id":"159f8932-dd0e-4a2f-89f7-728be0b0ff23","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}}],"id":"239a101f-8406-46bd-9f46-3c31d81205ad","_postman_id":"239a101f-8406-46bd-9f46-3c31d81205ad","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}}],"id":"dc2b3c60-6d14-4334-8006-263a9e93103e","description":"These RESTful APIs are only available with paid support packages or paid Analytics packages. Please contact Agora Sales if you would like to purchase them.
Keep in mind different support packages have different options available to them for the RESTful APIs.
Support Plans are available here: https://www.agora.io/en/pricing/support-plans/
\nAgora Analytics Plans are available here: https://analytics-lab.agora.io/pricing?source=console
\n","_postman_id":"dc2b3c60-6d14-4334-8006-263a9e93103e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}},{"name":"[Internal] Cloud Transcoder","item":[{"name":"Transcoding Templates","item":[{"name":"create/reset","event":[{"listen":"prerequest","script":{"id":"96448d3e-522a-406e-bff9-accdcd2bed8b","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"95b4b014-34c6-4401-826e-3d348d0ee1b2","exec":["var jsonData = JSON.parse(responseBody);\r","pm.collectionVariables.set(\"taskId\", jsonData.taskId);\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"c6992fff-7fe6-42e1-a355-6a62caf817f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"enabled\": true,\r\n \"video\": {\r\n \"width\": 1920,\r\n \"height\": 1080,\r\n \"fps\": 30\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtls/abr/config/codecs/{{codecId}}","description":"After initiating Acquirethe request, you can Createcreate a cloud transcoder through the request. The Agora server will begin to transcode and combine the multi-channel streams you specified and input them into the Agora RTC channel.
Security: Basic Auth
\nHTTP Basic Authentication : Every time you send an HTTP request, you must fill in the field in the request header Authorization. For information on how to generate the value of this field, please refer to Implementing HTTP Basic Authentication .
Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.
Example:Authorization: Basic ZGVtbzpwQDU1dzByZA==
appIdstringrequired
\nApp ID provided by Shengwang to each developer . After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\nbuilderTokenstringrequired
\nFill in the value Acquireobtained from the response body of the method tokenName.
Content-Typestringrequired
\napplication/json
application/jsonservicesobjectrequiredcloudTranscoderobjectrequiredserviceTypestringrequired
\nService type, here \"cloudTranscoderV2\".
configobjectrequiredtranscoderobjectrequiredidleTimeoutnumber
\nThe maximum amount of time, in seconds, that a Cloud transcoder can be idle. Idle means that all anchors corresponding to the audio and video streams processed by cloud transcoder have left the channel. After the idle state exceeds the set value idleTimeOut, the cloud transcoder will be automatically destroyed.
>= 1<= 86400Default :300audioInputsarray[object]rtcobjectrequiredrtcChannelstringrequired
\nThe RTC channel name to which the audio input source belongs. Currently, only subscribing to audio and video sources of a single channel is supported. The channels to which the audio source and video source belong must be the same.
\nrtcUidnumberrequired
\nUID corresponding to the audio input source. The same UID is not allowed to exist in the RTC channel.
\nrtcTokenstringrequired
\nToken that Cloud transcoder needs to set when entering the RTC channel of the video source to be transcoded. This value can be used to ensure channel security and prevent abnormal users from disrupting other users in the channel. For details, see Using Token Authentication .
\nNote : The UID of the Cloud transcoder in the RTC channel of the audio and video source to be transcoded is randomly assigned by Agora. Therefore, when generating a Token, the UID you use uidmust be 0.
videoInputsarray[object]rtcobjectrequiredplaceholderImageUrlstringrequired
\nThe URL of the placeholder image when the user is offline. Must be a legal URL and contain jpgor pngsuffix.
regionobjectrequiredcanvasobjectrequiredwidthnumberrequired
\nThe width of the canvas (px).
\n>= 120<= 3840heightnumberrequired
\nThe height of the canvas (px). The value range is [120,3840].
\n>= 120<= 3840colornumberrequired
\nThe background color of the canvas. RGB color value, expressed as a decimal number. For example, 0 represents black and 255 represents blue.
\n>= 0<= 16777215backgroundImagestring
\nCanvas background image. Must be a legal URL and contain jpgor pngsuffix.
Note : If no value is passed, there will be no canvas background image.
\nfillModestring
\nThe fill mode of the canvas background image:
\n\"FILL\": Zoom the screen and crop it in the center while maintaining the aspect ratio. See diagram for details .
\"FIT\": While maintaining the aspect ratio, zoom the screen to display it completely. See diagram for details .
Default :FILLwaterMarksarray[object]imageUrlstringrequired
\nThe URL of the watermark image. Must be a legal URL and contain jpgor pngsuffix.
regionobjectrequiredx#/components/schemas/x-wmrequiredynumberrequired
\nThe y coordinate (px) of the watermark on the canvas. Taking the upper left corner of the canvas as the origin, the y coordinate is the vertical displacement of the upper left corner of the screen relative to the origin.
\n>= 0<= 3840widthnumberrequired
\nThe width of the watermark (px).
\n>= 120<= 3840heightnumberrequired
\nThe height of the watermark (px).
\n>= 120<= 3840zOrdernumberrequired
\nThe layer number of the watermark. 0 represents the lowest layer. 100 represents the top layer.
\n>= 0<= 100fillModestring
\nWatermark fill mode:
\n\"FILL\": Zoom the screen and crop it in the center while maintaining the aspect ratio. See diagram for details .
\"FIT\": While maintaining the aspect ratio, zoom the screen to display it completely. See diagram for details .
Default :FILLoutputsarray[object]requiredrtcobjectrequiredrtcChannelstringrequired
\nThe name of the RTC channel to which the transcoded output audio and video stream belongs.
\nrtcUidnumberrequired
\nCloud transcoder UID in the RTC channel to which the transcoded output audio and video stream belongs. Identical UIDs are not allowed within RTC channels, so make sure this value is different from other user UIDs in the channel.
\nrtcTokenstringrequired
\nToken that Cloud transcoder needs to set when entering the RTC channel to which the output audio and video stream belongs. This value can be used to ensure channel security and prevent abnormal users from disrupting other users in the channel. For details, see Using Token Authentication . Note : The UID of Cloud transcoder in the RTC channel to which the transcoded output audio and video stream belongs is specified by you outputs.rtc.rtcUid. Therefore, when generating Token, the UID you use uidmust be outputs.rtc.rtcUidconsistent with .
audioOptionobjectprofileTypestring
\nAudio properties of transcoded output:
\n\"AUDIO_PROFILE_DEFAULT\": 48 kHz sampling rate, music encoding, mono, the maximum encoding rate is 64 Kbps.
\"AUDIO_PROFILE_SPEECH_STANDARD\": 32 kHz sampling rate, speech encoding, mono, the maximum encoding rate is 18 Kbps.
\"AUDIO_PROFILE_MUSIC_STANDARD\": 48 KHz sampling rate, music encoding, mono, the maximum encoding rate is 64 Kbps.
\"AUDIO_PROFILE_MUSIC_STANDARD_STEREO\": 48 KHz sampling rate, music encoding, two-channel, maximum encoding rate is 80 Kbps.
\"AUDIO_PROFILE_MUSIC_HIGH_QUALITY\": 48 KHz sampling rate, music encoding, mono, the maximum encoding rate is 96 Kbps.
\"AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO\": 48 KHz sampling rate, music encoding, two-channel, maximum encoding rate is 128 Kbps.
Default :AUDIO_PROFILE_DEFAULTvideoOptionobjectfpsnumber
\nThe frame rate (fps) of the transcoded output video.
\n>= 1<= 30Default :15codecstringrequired
\nThe codec for transcoding the output video. Values include:
\n\"H264\": Standard H.264 encoding.
\"VP8\": Standard VP8 encoding.
bitratenumber
\nThe bitrate of the transcoded output video.
\nNote : If you do not pass a value, Shengwang will automatically set the video bitrate based on network conditions and other video attributes.
\n>= 1<= 10000widthnumberrequired
\nThe width (px) of the transcoded output video.
\n>= 120<= 3840heightnumberrequired
\nThe height (px) of the transcoded output video.
\n>= 120<= 3840lowBitrateHighQualityboolean
\nWhether to enable the low-code high-definition function for the transcoded output audio and video streams:
\ntrue: On.
false: Not enabled.
Note : The low-code HD function can achieve the effect of higher-quality video perceived by the human eye at a lower bit rate. This function will increase the cost. Please contact Shengwang sales to inquire about the cost before activating it.
\nDefault :false
\n200Not 2XX
\nIf the status code is 2XX, the request is successful.
\nX-Request-IDstring
\nUUID (Universally Unique Identifier), used to identify this request.
\nNote : If a request error occurs, please print the value in the log to troubleshoot the problem. If the response status code of this request is not 2XX, this field may not be included in the response header.
\napplication/jsonresponses/200taskIdstring
\nTranscoding task ID, which is a UUID and is used to identify the cloud transcoder of this request operation.
\ncreateTsnumber
\nThe Unix timestamp (in seconds) when the transcoding task was created.
\nstatusstring
\nThe running status of the transcoding task:
\n\"IDLE\": The task has not started.
\"PREPARED\": The task has received a start request.
\"STARTING\": The task is starting.
\"CREATED\": Task initialization completed.
\"STARTED\": The task has been started.
\"IN_PROGRESS\": The task is in progress.
\"STOPPING\": The task is stopping.
\"STOPPED\": The task has been stopped.
\"EXIT\": The task exits normally.
\"FAILURE_STOP\": The task exited abnormally.
Note : You can use this field to monitor the status of the task.
\nservicesobjectcloudTranscoderobjecteventHandlersreserved-object
\nReserved fields.
\nexecutionobjectworkflowsreserved-object
\nReserved fields.
\npropertiesreserved-object
\nReserved fields.
\nsequenceIdstring
\nReserved fields.
\nvariablesreserved-object
\nReserved fields.
\nworkflowsreserved-object
\nReserved fields.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","projects","{{APPID}}","rtls","abr","config","codecs","{{codecId}}"],"host":["api","sd-rtn","com"],"query":[],"variable":[]}},"response":[{"id":"f3cddc42-2abe-42e2-9971-3dc99d84b55e","name":"create/reset","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"enabled\": true,\r\n \"video\": {\r\n \"width\": 1920,\r\n \"height\": 1080,\r\n \"fps\": 30\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtsc/cloud-transcoder/tasks"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"c6992fff-7fe6-42e1-a355-6a62caf817f1"},{"name":"query templates","id":"0858164c-1f74-4157-a234-54b3e4beade1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtls/abr/config/codecs","description":"Call this interface to get all templates and their configurations
\nResponse body parameters
\ntranscoding: JSON Object (Optional) Transcoding settings, includes the following fields:video: JSON Object type (Optional) Video transcoding settings, include the following fields:enabled: Boolean (Required) Whether to enable video transcoding, the default value is false(disabled).codec: String (Optional) String type. Transcoding codec, optional values \"H.264\", \"VP8\", the default is \"H.264\";width: Number (Optional) Width in encoding resolution. The value range is 2 to 1920.height: Number (Optional) Height in encoding resolution. The value range is 2 to 1920.bitrate: (optional) Number type. Encoding bit rate, unit kbps, value range is 0 to 14000;audio: (optional) JSON Object type. Includes the following fields:enabled: (required) Boolean type. Whether to enable audio transcoding, enabled by default.profile: (optional) Number type. Encoding audio scene, the default is 0, which means: 48 KHz sampling rate, music encoding, mono, the maximum encoding rate is 64 Kbps. If you want to set other profiles, please contact Agora technical support for confirmation.bitrate: (optional) Number type. Encoding bit rate, unit kbps, value range is 64kbps ~ 320kbps, if not filled in, the bit rate is determined by the profile value.simulcastStream: JSON Object (Optional) The function of large and small video streams, used to improve the adaptive switching capability of the viewer in a weak network environment. Includes the following fields:enabled: Boolean (Required) Whether to enable small video transcoding. The default is false(off). If you want to enable it, you must enable the video transcoding function at the same time.width: Number (Optional) Width in small stream resolution. The value range is 2 to 1920.height: Number (Optional) Height in small stream resolution, Number type. The value range is 2 to 1920.fps: Number (Optional) Small stream frame rate. The value range is 1 to 60.jitterBuffer: (optional) JSON Object type. The gateway jitter buffer parameters will only take effect when video transcoding is enabled (If there are no special requirements, no explicit configuration is required)size: (optional)Number type. jitterBuffer length, unit ms, default value 500 (meaning the gateway will add 500ms to the end-to-end delay to reduce the lag rate caused by network jitter)maxSize: (optional) Number type. The maximum length of jitterBuffer, unit ms, default value 1000, if provided, must be > jitterBuffer.size. When the jitterBuffer length exceeds this value, the gateway will enable acceleration until it returns to jitterBuffer.size.Before starting cloud transcoding, you must first call Acquirethe method to obtain a cloud transcoding resource.
Terms and Conditions :
\nAfter calling Acquirethe method successfully, you can get one in the response package body builderToken.
To ensure successful cloud transcoding, please initiate the corresponding request immediately within 2 seconds after each Acquire request is obtained . Making a batch request after a batch fetch may cause the request to fail.builderTokenCreatebuilderTokenCreate
One builderTokencan only be used for one cloud transcoding task. builderTokenThe time limit is 5 minutes.
Security: Basic Auth
\nHTTP Basic Authentication : Every time you send an HTTP request, you must fill in the field in the request header Authorization. For information on how to generate the value of this field, please refer to Implementing HTTP Basic Authentication .
Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.
Example:Authorization: Basic ZGVtbzpwQDU1dzByZA==
appIdstringrequired
\nApp ID provided by Shengwang to each developer . After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\nContent-Typestringrequired
\napplication/json
application/jsoninstanceIdstringrequired
\nUser-specified instance ID. The length must be within 64 characters, and the supported character set range is:
\nAll lowercase English letters (az)
\nAll uppercase English letters (AZ)
\nNumbers 0-9
\n\"-\", \"_\"
\nNote : One instanceIdcan generate multiple ones builderToken, but only one can be used to initiate a request in a task builderToken.
200Not 2XX
\nIf the status code is 2XX, the request is successful.
\nX-Request-IDstring
\nUUID (Universally Unique Identifier), used to identify this request.
\nNote : If a request error occurs, please print the value in the log to troubleshoot the problem. If the response status code of this request is not 2XX, this field may not be included in the response header.
\napplication/jsonresponses/200/tokenNamecreateTsnumber
\nbuilderTokenThe Unix timestamp (in seconds) when was generated .
instanceIdstring
\nSet when requested instanceId.
tokenNamestring
\nRepresents builderTokenthe value of , which needs to be passed in when calling other methods later.
After initiating Acquirethe request, you can Createcreate a cloud transcoder through the request. The Agora server will begin to transcode and combine the multi-channel streams you specified and input them into the Agora RTC channel.
Security: Basic Auth
\nHTTP Basic Authentication : Every time you send an HTTP request, you must fill in the field in the request header Authorization. For information on how to generate the value of this field, please refer to Implementing HTTP Basic Authentication .
Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.
Example:Authorization: Basic ZGVtbzpwQDU1dzByZA==
appIdstringrequired
\nApp ID provided by Shengwang to each developer . After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\nbuilderTokenstringrequired
\nFill in the value Acquireobtained from the response body of the method tokenName.
Content-Typestringrequired
\napplication/json
application/jsonservicesobjectrequiredcloudTranscoderobjectrequiredserviceTypestringrequired
\nService type, here \"cloudTranscoderV2\".
configobjectrequiredtranscoderobjectrequiredidleTimeoutnumber
\nThe maximum amount of time, in seconds, that a Cloud transcoder can be idle. Idle means that all anchors corresponding to the audio and video streams processed by cloud transcoder have left the channel. After the idle state exceeds the set value idleTimeOut, the cloud transcoder will be automatically destroyed.
>= 1<= 86400Default :300audioInputsarray[object]rtcobjectrequiredrtcChannelstringrequired
\nThe RTC channel name to which the audio input source belongs. Currently, only subscribing to audio and video sources of a single channel is supported. The channels to which the audio source and video source belong must be the same.
\nrtcUidnumberrequired
\nUID corresponding to the audio input source. The same UID is not allowed to exist in the RTC channel.
\nrtcTokenstringrequired
\nToken that Cloud transcoder needs to set when entering the RTC channel of the video source to be transcoded. This value can be used to ensure channel security and prevent abnormal users from disrupting other users in the channel. For details, see Using Token Authentication .
\nNote : The UID of the Cloud transcoder in the RTC channel of the audio and video source to be transcoded is randomly assigned by Agora. Therefore, when generating a Token, the UID you use uidmust be 0.
videoInputsarray[object]rtcobjectrequiredplaceholderImageUrlstringrequired
\nThe URL of the placeholder image when the user is offline. Must be a legal URL and contain jpgor pngsuffix.
regionobjectrequiredcanvasobjectrequiredwidthnumberrequired
\nThe width of the canvas (px).
\n>= 120<= 3840heightnumberrequired
\nThe height of the canvas (px). The value range is [120,3840].
\n>= 120<= 3840colornumberrequired
\nThe background color of the canvas. RGB color value, expressed as a decimal number. For example, 0 represents black and 255 represents blue.
\n>= 0<= 16777215backgroundImagestring
\nCanvas background image. Must be a legal URL and contain jpgor pngsuffix.
Note : If no value is passed, there will be no canvas background image.
\nfillModestring
\nThe fill mode of the canvas background image:
\n\"FILL\": Zoom the screen and crop it in the center while maintaining the aspect ratio. See diagram for details .
\"FIT\": While maintaining the aspect ratio, zoom the screen to display it completely. See diagram for details .
Default :FILLwaterMarksarray[object]imageUrlstringrequired
\nThe URL of the watermark image. Must be a legal URL and contain jpgor pngsuffix.
regionobjectrequiredx#/components/schemas/x-wmrequiredynumberrequired
\nThe y coordinate (px) of the watermark on the canvas. Taking the upper left corner of the canvas as the origin, the y coordinate is the vertical displacement of the upper left corner of the screen relative to the origin.
\n>= 0<= 3840widthnumberrequired
\nThe width of the watermark (px).
\n>= 120<= 3840heightnumberrequired
\nThe height of the watermark (px).
\n>= 120<= 3840zOrdernumberrequired
\nThe layer number of the watermark. 0 represents the lowest layer. 100 represents the top layer.
\n>= 0<= 100fillModestring
\nWatermark fill mode:
\n\"FILL\": Zoom the screen and crop it in the center while maintaining the aspect ratio. See diagram for details .
\"FIT\": While maintaining the aspect ratio, zoom the screen to display it completely. See diagram for details .
Default :FILLoutputsarray[object]requiredrtcobjectrequiredrtcChannelstringrequired
\nThe name of the RTC channel to which the transcoded output audio and video stream belongs.
\nrtcUidnumberrequired
\nCloud transcoder UID in the RTC channel to which the transcoded output audio and video stream belongs. Identical UIDs are not allowed within RTC channels, so make sure this value is different from other user UIDs in the channel.
\nrtcTokenstringrequired
\nToken that Cloud transcoder needs to set when entering the RTC channel to which the output audio and video stream belongs. This value can be used to ensure channel security and prevent abnormal users from disrupting other users in the channel. For details, see Using Token Authentication . Note : The UID of Cloud transcoder in the RTC channel to which the transcoded output audio and video stream belongs is specified by you outputs.rtc.rtcUid. Therefore, when generating Token, the UID you use uidmust be outputs.rtc.rtcUidconsistent with .
audioOptionobjectprofileTypestring
\nAudio properties of transcoded output:
\n\"AUDIO_PROFILE_DEFAULT\": 48 kHz sampling rate, music encoding, mono, the maximum encoding rate is 64 Kbps.
\"AUDIO_PROFILE_SPEECH_STANDARD\": 32 kHz sampling rate, speech encoding, mono, the maximum encoding rate is 18 Kbps.
\"AUDIO_PROFILE_MUSIC_STANDARD\": 48 KHz sampling rate, music encoding, mono, the maximum encoding rate is 64 Kbps.
\"AUDIO_PROFILE_MUSIC_STANDARD_STEREO\": 48 KHz sampling rate, music encoding, two-channel, maximum encoding rate is 80 Kbps.
\"AUDIO_PROFILE_MUSIC_HIGH_QUALITY\": 48 KHz sampling rate, music encoding, mono, the maximum encoding rate is 96 Kbps.
\"AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO\": 48 KHz sampling rate, music encoding, two-channel, maximum encoding rate is 128 Kbps.
Default :AUDIO_PROFILE_DEFAULTvideoOptionobjectfpsnumber
\nThe frame rate (fps) of the transcoded output video.
\n>= 1<= 30Default :15codecstringrequired
\nThe codec for transcoding the output video. Values include:
\n\"H264\": Standard H.264 encoding.
\"VP8\": Standard VP8 encoding.
bitratenumber
\nThe bitrate of the transcoded output video.
\nNote : If you do not pass a value, Shengwang will automatically set the video bitrate based on network conditions and other video attributes.
\n>= 1<= 10000widthnumberrequired
\nThe width (px) of the transcoded output video.
\n>= 120<= 3840heightnumberrequired
\nThe height (px) of the transcoded output video.
\n>= 120<= 3840lowBitrateHighQualityboolean
\nWhether to enable the low-code high-definition function for the transcoded output audio and video streams:
\ntrue: On.
false: Not enabled.
Note : The low-code HD function can achieve the effect of higher-quality video perceived by the human eye at a lower bit rate. This function will increase the cost. Please contact Shengwang sales to inquire about the cost before activating it.
\nDefault :false
\n200Not 2XX
\nIf the status code is 2XX, the request is successful.
\nX-Request-IDstring
\nUUID (Universally Unique Identifier), used to identify this request.
\nNote : If a request error occurs, please print the value in the log to troubleshoot the problem. If the response status code of this request is not 2XX, this field may not be included in the response header.
\napplication/jsonresponses/200taskIdstring
\nTranscoding task ID, which is a UUID and is used to identify the cloud transcoder of this request operation.
\ncreateTsnumber
\nThe Unix timestamp (in seconds) when the transcoding task was created.
\nstatusstring
\nThe running status of the transcoding task:
\n\"IDLE\": The task has not started.
\"PREPARED\": The task has received a start request.
\"STARTING\": The task is starting.
\"CREATED\": Task initialization completed.
\"STARTED\": The task has been started.
\"IN_PROGRESS\": The task is in progress.
\"STOPPING\": The task is stopping.
\"STOPPED\": The task has been stopped.
\"EXIT\": The task exits normally.
\"FAILURE_STOP\": The task exited abnormally.
Note : You can use this field to monitor the status of the task.
\nservicesobjectcloudTranscoderobjecteventHandlersreserved-object
\nReserved fields.
\nexecutionobjectworkflowsreserved-object
\nReserved fields.
\npropertiesreserved-object
\nReserved fields.
\nsequenceIdstring
\nReserved fields.
\nvariablesreserved-object
\nReserved fields.
\nworkflowsreserved-object
\nReserved fields.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","projects","{{APPID}}","rtsc","cloud-transcoder","tasks"],"host":["api","sd-rtn","com"],"query":[{"key":"builderToken","value":""}],"variable":[]}},"response":[{"id":"e628c565-d627-44be-a342-1ed9745c8d5c","name":"create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"services\": {\r\n \"cloudTranscoder\": {\r\n \"serviceType\": \"cloudTranscoderV2\",\r\n \"config\": {\r\n \"transcoder\": {\r\n \"idleTimeout\": 300,\r\n \"audioInputs\": [\r\n {\r\n \"rtc\": {\r\n \"rtcChannel\": \"testtranscoding01\",\r\n \"rtcUid\": 123,\r\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\r\n }\r\n },\r\n {\r\n \"rtc\": {\r\n \"rtcChannel\": \"testtranscoding01\",\r\n \"rtcUid\": 456,\r\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\r\n }\r\n }\r\n ],\r\n \"canvas\": {\r\n \"width\": 960,\r\n \"height\": 480,\r\n \"color\": 0,\r\n \"backgroundImage\": \"https://example.jpg\",\r\n \"fillMode\": \"FIT\"\r\n },\r\n \"waterMarks\": [\r\n {\r\n \"imageUrl\": \"https://example.png\",\r\n \"region\": {\r\n \"x\": 0,\r\n \"y\": 0,\r\n \"width\": 120,\r\n \"height\": 120,\r\n \"zOrder\": 50\r\n }\r\n }\r\n ],\r\n \"videoInputs\": [\r\n {\r\n \"rtc\": {\r\n \"rtcChannel\": \"testtranscoding01\",\r\n \"rtcUid\": 123,\r\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\r\n },\r\n \"placeholderImageUrl\": \"https://example.jpg\",\r\n \"region\": {\r\n \"x\": 0,\r\n \"y\": 0,\r\n \"width\": 320,\r\n \"height\": 360,\r\n \"zOrder\": 1\r\n }\r\n },\r\n {\r\n \"rtc\": {\r\n \"rtcChannel\": \"testtranscoding01\",\r\n \"rtcUid\": 456,\r\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\r\n },\r\n \"placeholderImageUrl\": \"https://example.jpg\",\r\n \"region\": {\r\n \"x\": 320,\r\n \"y\": 0,\r\n \"width\": 320,\r\n \"height\": 320,\r\n \"zOrder\": 1\r\n }\r\n }\r\n ],\r\n \"outputs\": [\r\n {\r\n \"rtc\": {\r\n \"rtcChannel\": \"testtranscoding02\",\r\n \"rtcUid\": 9999,\r\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\r\n },\r\n \"audioOption\": {\r\n \"profileType\": \"AUDIO_PROFILE_MUSIC_STANDARD\"\r\n },\r\n \"videoOption\": {\r\n \"fps\": 30,\r\n \"codec\": \"H264\",\r\n \"bitrate\": 800,\r\n \"width\": 960,\r\n \"height\": 480,\r\n \"lowBitrateHighQuality\": false\r\n }\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtsc/cloud-transcoder/tasks"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"createTs\" : 1661324613 , \n \"eventHandlers\" : { } , \n \"execution\" : { \n \"workflows\" : { } \n } ,\n \"properties\" : { } , \n \"sequenceId\" : \"0\" , \n \"services\" : { \n \"cloudTranscoder\" : { \n \"config\" : { } , \n \"createTs\" : 1661324614 , \n \"details\" : { } , \n \"message\" : \"\" , \n \"serviceType\" : \"cloudTranscoderV2\" , \n \"status\" : \"serviceReady\" \n }\n } ,\n \"status\" : \"STARTED\" , \n \"taskId\" : \"609f28f2644f1ae1ceb041b7047e3***\" , \n \"variables\" : { } , \n \"workflows\" : { }\n}"}],"_postman_id":"c92602db-c817-47bd-ae8f-de7afa3891f7"},{"name":"query","event":[{"listen":"test","script":{"id":"29b7ac8e-7a96-4de1-8e01-5a18a2ef18cf","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"99226600-4464-4537-98d3-505efc586c48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtsc/cloud-transcoder/tasks/?builderToken=","description":"After creating cloud transcoding, you can initiate Querya request to query the transcoding status.
Security: Basic Auth
\nHTTP Basic Authentication : Every time you send an HTTP request, you must fill in the field in the request header Authorization. For information on how to generate the value of this field, please refer to Implementing HTTP Basic Authentication .
Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.
Example:Authorization: Basic ZGVtbzpwQDU1dzByZA==
appIdstringrequired
\nApp ID provided by Shengwang to each developer . After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\ntaskIdstringrequired
\nTranscoding task ID, which is UUID and is used to identify the cloud transcoder of this request operation.
\nbuilderTokenstringrequired
\nFill in the value Acquireobtained from the response body of the method tokenName.
Content-Typestringrequired
\napplication/json
200Not 2XX
\nIf the status code is 2XX, the request is successful.
\nX-Request-IDstring
\nUUID (Universally Unique Identifier), used to identify this request.
\nNote : If a request error occurs, please print the value in the log to troubleshoot the problem. If the response status code of this request is not 2XX, this field may not be included in the response header.
\napplication/jsontaskIdstring
\nTranscoding task ID, which is a UUID and is used to identify the cloud transcoder of this request operation.
\ncreateTsnumber
\nThe Unix timestamp (in seconds) when the transcoding task was created.
\nstatusstring
\nThe running status of the transcoding task:
\n\"IDLE\": The task has not started.
\"PREPARED\": The task has received a start request.
\"STARTING\": The task is starting.
\"CREATED\": Task initialization completed.
\"STARTED\": The task has been started.
\"IN_PROGRESS\": The task is in progress.
\"STOPPING\": The task is stopping.
\"STOPPED\": The task has been stopped.
\"EXIT\": The task exits normally.
\"FAILURE_STOP\": The task exited abnormally.
Note : You can use this field to monitor the status of the task.
\nservicesobjectcloudTranscoderobjecteventHandlersreserved-object
\nReserved fields.
\nexecutionobjectworkflowsreserved-object
\nReserved fields.
\npropertiesreserved-object
\nReserved fields.
\nsequenceIdstring
\nReserved fields.
\nvariablesreserved-object
\nReserved fields.
\nworkflowsreserved-object
\nReserved fields.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","projects","{{APPID}}","rtsc","cloud-transcoder","tasks",""],"host":["api","sd-rtn","com"],"query":[{"key":"builderToken","value":""}],"variable":[]}},"response":[{"id":"2951e357-1927-466e-b0dc-b0ec9e5ed103","name":"query","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtsc/cloud-transcoder/tasks/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 11 Mar 2023 03:38:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"91"},{"key":"Connection","value":"keep-alive"},{"key":"X-Capacity-RateLimit","value":"active"},{"key":"X-Capacity-RateLimit-Remaining-second","value":"10"},{"key":"X-Capacity-RateLimit-Limit-second","value":"10"},{"key":"X-RateLimit-Remaining-Second","value":"9"},{"key":"X-RateLimit-Limit-Second","value":"10"},{"key":"RateLimit-Limit","value":"10"},{"key":"RateLimit-Remaining","value":"9"},{"key":"RateLimit-Reset","value":"1"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Request-ID","value":"b6522b456ba04552bd30549764cc6a37"}],"cookie":[],"responseTime":null,"body":"{\n \"createTs\": 1661420011,\n \"eventHandlers\": {},\n \"execution\": {\n \"workflows\": {}\n },\n \"properties\": {},\n \"sequenceId\": \"0\",\n \"services\": {\n \"cloudTranscoder\": {\n \"config\": {},\n \"createTs\": 1661420011,\n \"message\": \"OnSlaveServiceQueryUpdated\",\n \"serviceType\": \"cloudTranscoderV2\",\n \"status\": \"serviceInProgress\"\n }\n },\n \"status\": \"IN_PROGRESS\",\n \"taskId\": \"c0077139e34d0949c719189a393aa***\",\n \"variables\": {},\n \"workflows\": {}\n}"}],"_postman_id":"99226600-4464-4537-98d3-505efc586c48"},{"name":"update","id":"92f54076-e071-4d6f-9f39-9e7b347745cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"services\": {\n \"cloudTranscoder\": {\n \"serviceType\": \"cloudTranscoderV2\",\n \"config\": {\n \"transcoder\": {\n \"idleTimeout\": 300,\n \"audioInputs\": [\n {\n \"rtc\": {\n \"rtcChannel\": \"{{AccessChannel}}\",\n \"rtcUid\": {{uid}},\n \"rtcToken\": \"{{token}}\"\n }\n },\n {\n \"rtc\": {\n \"rtcChannel\": \"{{AccessChannel}}\",\n \"rtcUid\": {{uidTwo}},\n \"rtcToken\": \"{{tokenTwo}}\"\n }\n }\n ],\n \"canvas\": {\n \"width\": 960,\n \"height\": 480,\n \"color\": 0,\n \"backgroundImage\": \"https://example.jpg\",\n \"fillMode\": \"FIT\"\n },\n \"waterMarks\": [\n {\n \"imageUrl\": \"https://example.png\",\n \"region\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 120,\n \"height\": 120,\n \"zOrder\": 50\n }\n }\n ],\n \"videoInputs\": [\n {\n \"rtc\": {\n \"rtcChannel\": \"{{AccessChannel}}\",\n \"rtcUid\": {{uid}},\n \"rtcToken\": \"{{uid}}\"\n },\n \"placeholderImageUrl\": \"https://example.jpg\",\n \"region\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 320,\n \"height\": 360,\n \"zOrder\": 1\n }\n },\n {\n \"rtc\": {\n \"rtcChannel\": \"{{AccessChannel}}\",\n \"rtcUid\": {{uidTwo}},\n \"rtcToken\": \"{{tokenTwo}}\"\n },\n \"placeholderImageUrl\": \"https://example.jpg\",\n \"region\": {\n \"x\": 320,\n \"y\": 0,\n \"width\": 320,\n \"height\": 320,\n \"zOrder\": 1\n }\n }\n ],\n \"outputs\": [\n {\n \"rtc\": {\n \"rtcChannel\": \"{{AccessChannelOC}}\",\n \"rtcUid\": {{uidOC}},\n \"rtcToken\": \"{{tokenOC}}\"\n },\n \"audioOption\": {\n \"profileType\": \"AUDIO_PROFILE_MUSIC_STANDARD\"\n },\n \"videoOption\": {\n \"fps\": 30,\n \"codec\": \"H264\",\n \"bitrate\": 800,\n \"width\": 960,\n \"height\": 480,\n \"lowBitrateHighQuality\": false\n }\n }\n ]\n }\n }\n }\n }\n}"},"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtsc/cloud-transcoder/tasks/?builderToken=&sequenceId={{sequenceId}}&updateMask=services.cloudTranscoder.config","description":"After obtaining and creating the cloud transcoder through Acquirethe and request, you can initiate a request to update the cloud transcoder.CreateUpdate
Notes for use : UpdateWhen updating cloud transcoder, your request package body must contain Createall fields in the request package body. For fields that do not need to be updated, please maintain the original values. UpdateThe request only supports modification of the following fields:
Add or delete audioInputs[]members videoInputs[]in rtc, used to subscribe or unsubscribe to the audio and video streams of the host in the channel.
Modify the field videoInputs[]in regionto update the host's combined picture layout.
Modify the fields outputs[]in to update the transcoding output audio configuration and video configuration.audioOptionvideoOption
Note : CreateWhen requesting to create a cloud transcoder, there are three usage scenarios:
Audio and video scenes.
\nAudio-only scenario.
\nFull channel mixing scene.
\nFor the setting methods of these three scenarios, please refer to the click switching exampleCreate on the right side of the document . When requesting to update cloud transcoder, please keep the usage scenario consistent, otherwise an exception will occur. For example, for cloud transcoder for audio and video scenes, please do not update it to cloud transcoder for pure audio scenes.Update
Security: Basic Auth
\nHTTP Basic Authentication : Every time you send an HTTP request, you must fill in the field in the request header Authorization. For information on how to generate the value of this field, please refer to Implementing HTTP Basic Authentication .
Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.
Example:Authorization: Basic ZGVtbzpwQDU1dzByZA==
appIdstringrequired
\nApp ID provided by Shengwang to each developer . After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\ntaskIdstringrequired
\nTranscoding task ID, which is UUID and is used to identify the cloud transcoder of this request operation.
\nbuilderTokenstringrequired
\nFill in the value Acquireobtained from the response body of the method tokenName.
sequenceIdstringrequired
\nUpdateThe requested sequence number. The value needs to be greater than or equal to 0. Please ensure that the sequence number of the next Updaterequest is greater than the sequence number of the previous Updaterequest. The serial number ensures that the Agora server updates the cloud transcoder according to the latest configuration you specify.
Usage suggestions : Shengwang recommends that you set to Updatewhen calling for the first time . On the second call to , set to . On the third call to , set to . And so on. The Shengwang server will update the cloud transcoder according to the latest request (that is, the largest serial number).sequence0Updatesequence1Updatesequence2Update
Content-Typestringrequired
\napplication/json
application/jsonservicesobjectrequiredcloudTranscoderobjectrequired
\n200Not 2XX
\nIf the status code is 2XX, the request is successful. The package body is empty.
\nX-Request-IDstring
\nUUID (Universally Unique Identifier), used to identify this request.
\nNote : If a request error occurs, please print the value in the log to troubleshoot the problem. If the response status code of this request is not 2XX, this field may not be included in the response header.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","projects","{{APPID}}","rtsc","cloud-transcoder","tasks",""],"host":["api","sd-rtn","com"],"query":[{"key":"builderToken","value":""},{"key":"sequenceId","value":"{{sequenceId}}"},{"key":"updateMask","value":"services.cloudTranscoder.config"}],"variable":[]}},"response":[{"id":"282f4209-d513-458c-8f18-4d25e33e7087","name":"update","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"services\": {\n \"cloudTranscoder\": {\n \"serviceType\": \"cloudTranscoderV2\",\n \"config\": {\n \"transcoder\": {\n \"idleTimeout\": 300,\n \"audioInputs\": [\n {\n \"rtc\": {\n \"rtcChannel\": \"testtranscoding01\",\n \"rtcUid\": 123,\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\n }\n },\n {\n \"rtc\": {\n \"rtcChannel\": \"testtranscoding01\",\n \"rtcUid\": 456,\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\n }\n }\n ],\n \"canvas\": {\n \"width\": 960,\n \"height\": 480,\n \"color\": 0,\n \"backgroundImage\": \"https://example.jpg\",\n \"fillMode\": \"FIT\"\n },\n \"waterMarks\": [\n {\n \"imageUrl\": \"https://example.png\",\n \"region\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 120,\n \"height\": 120,\n \"zOrder\": 50\n }\n }\n ],\n \"videoInputs\": [\n {\n \"rtc\": {\n \"rtcChannel\": \"testtranscoding01\",\n \"rtcUid\": 123,\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\n },\n \"placeholderImageUrl\": \"https://example.jpg\",\n \"region\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 320,\n \"height\": 360,\n \"zOrder\": 1\n }\n },\n {\n \"rtc\": {\n \"rtcChannel\": \"testtranscoding01\",\n \"rtcUid\": 456,\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\n },\n \"placeholderImageUrl\": \"https://example.jpg\",\n \"region\": {\n \"x\": 320,\n \"y\": 0,\n \"width\": 320,\n \"height\": 320,\n \"zOrder\": 1\n }\n }\n ],\n \"outputs\": [\n {\n \"rtc\": {\n \"rtcChannel\": \"testtranscoding02\",\n \"rtcUid\": 9999,\n \"rtcToken\": \"aab8b8f5a8cd4469a63042fcfafe7***\"\n },\n \"audioOption\": {\n \"profileType\": \"AUDIO_PROFILE_MUSIC_STANDARD\"\n },\n \"videoOption\": {\n \"fps\": 30,\n \"codec\": \"H264\",\n \"bitrate\": 800,\n \"width\": 960,\n \"height\": 480,\n \"lowBitrateHighQuality\": false\n }\n }\n ]\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtsc/cloud-transcoder/tasks/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"createTs\": 1661324613,\n \"eventHandlers\": {},\n \"execution\": {\n \"workflows\": {}\n },\n \"properties\": {},\n \"sequenceId\": \"0\",\n \"services\": {\n \"cloudTranscoder\": {\n \"config\": {},\n \"createTs\": 1661324614,\n \"details\": {},\n \"message\": \"\",\n \"serviceType\": \"cloudTranscoderV2\",\n \"status\": \"serviceReady\"\n }\n },\n \"status\": \"STARTED\",\n \"taskId\": \"609f28f2644f1ae1ceb041b7047e3***\",\n \"variables\": {},\n \"workflows\": {}\n}"}],"_postman_id":"92f54076-e071-4d6f-9f39-9e7b347745cf"},{"name":"delete","event":[{"listen":"test","script":{"id":"27b49877-f6c9-4f05-aed1-8e480da63c43","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"63beb19a-ace3-4539-a716-4b526601ee08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtsc/cloud-transcoder/tasks/","description":"If you no longer need cloud transcoding, you can initiate Deletea destruction request.
Security: Basic Auth
\nHTTP Basic Authentication : Every time you send an HTTP request, you must fill in the field in the request header Authorization. For information on how to generate the value of this field, please refer to Implementing HTTP Basic Authentication .
Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.
Example:Authorization: Basic ZGVtbzpwQDU1dzByZA==
appIdstringrequired
\nApp ID provided by Shengwang to each developer . After creating a project in the Agora console, you can get an App ID. An App ID is a unique identifier for a project.
\ntaskIdstringrequired
\nTranscoding task ID, which is UUID and is used to identify the cloud transcoder of this request operation.
\nbuilderTokenstringrequired
\nFill in the value Acquireobtained from the response body of the method tokenName.
Content-Typestringrequired
\napplication/json
200Not 2XX
\nIf the status code is 2XX, the request is successful.
\nX-Request-IDstring
\nUUID (Universally Unique Identifier), used to identify this request.
\nNote : If a request error occurs, please print the value in the log to troubleshoot the problem. If the response status code of this request is not 2XX, this field may not be included in the response header.
\napplication/jsontaskIdstring
\nTranscoding task ID, which is a UUID and is used to identify the cloud transcoder of this request operation.
\ncreateTsnumber
\nThe Unix timestamp (in seconds) when the transcoding task was created.
\nstatusstring
\nThe running status of the transcoding task:
\n\"IDLE\": The task has not started.
\"PREPARED\": The task has received a start request.
\"STARTING\": The task is starting.
\"CREATED\": Task initialization completed.
\"STARTED\": The task has been started.
\"IN_PROGRESS\": The task is in progress.
\"STOPPING\": The task is stopping.
\"STOPPED\": The task has been stopped.
\"EXIT\": The task exits normally.
\"FAILURE_STOP\": The task exited abnormally.
Note : You can use this field to monitor the status of the task.
\nservicesobjectcloudTranscoderobjectconfigobject
\nSame as the fields you Createset in the request body config.
createTsnumber
\nThe Unix timestamp in seconds when the service was created.
\ndetailsreserved-object
\nReserved fields.
\nmessagestring
\nReserved fields.
\nserviceTypestring
\nService type, here \"cloudTranscoderV2\".
statusstring
\nThe running status of the transcoding service in the transcoding task:
\n\"serviceIdle\": The service has not started.
\"serviceReady\": The service is ready.
\"serviceStarted\": Service has started.
\"serviceInProgress\": Service is in progress.
\"serviceCompleted\": The service has been stopped and all tasks have been completed.
\"servicePartialCompleted\": The service has been stopped and the task is partially completed.
\"serviceValidationFailed\": Service parameter validation failed.
\"serviceAbnormal\": The service exited abnormally.
\"serviceUnknown\": Service unknown status.
Note : This field can be used to allow the Agora technical team to investigate the issue, and you do not need to pay too much attention to it.
\neventHandlersreserved-object
\nReserved fields.
\nexecutionobjectworkflowsreserved-object
\nReserved fields.
\npropertiesreserved-object
\nReserved fields.
\nsequenceIdstring
\nReserved fields.
\nvariablesreserved-object
\nReserved fields.
\nworkflowsreserved-object
\nReserved fields.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","projects","{{APPID}}","rtsc","cloud-transcoder","tasks",""],"host":["api","sd-rtn","com"],"query":[],"variable":[]}},"response":[{"id":"f2700f13-2f64-4cff-9d09-b47336771277","name":"delete","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.sd-rtn.com/v1/projects/{{APPID}}/rtsc/cloud-transcoder/tasks/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"createTs\": 1661324613,\n \"eventHandlers\": {},\n \"execution\": {\n \"workflows\": {}\n },\n \"properties\": {},\n \"sequenceId\": \"0\",\n \"services\": {\n \"cloudTranscoder\": {\n \"config\": {},\n \"createTs\": 1661324614,\n \"details\": {},\n \"message\": \"OnSlaveServiceStopped\",\n \"serviceType\": \"cloudTranscoderV2\",\n \"status\": \"serviceCompleted\"\n }\n },\n \"status\": \"STOPPED\",\n \"taskId\": \"609f28f2644f1ae1ceb041b7047e3***\",\n \"variables\": {},\n \"workflows\": {}\n}"}],"_postman_id":"63beb19a-ace3-4539-a716-4b526601ee08"}],"id":"67552e50-fca7-49f8-a799-3cf9e7cd2bab","_postman_id":"67552e50-fca7-49f8-a799-3cf9e7cd2bab","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}},{"name":"Conversational AI [Beta]","item":[],"id":"03b397c1-7838-44f2-9dd9-6a0791cb63c0","description":"\n","_postman_id":"03b397c1-7838-44f2-9dd9-6a0791cb63c0","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]},"isInherited":true,"source":{"_postman_id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","id":"d7da7175-1801-46b9-8ee4-e5c9e3010da3","name":"Agora RESTful APIs","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerID}}"},{"key":"password","value":"{{CustomerSecret}}"}]}},"event":[{"listen":"prerequest","script":{"id":"ff6b5545-1067-4e4a-a722-15f1be958728","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d1c398f9-5ef9-4ebd-bae3-9c39205fce08","type":"text/javascript","exec":[""]}}],"variable":[{"key":"builderToken","value":""},{"key":"taskId","value":""},{"key":"resourceId","value":""},{"key":"uniqueName","value":"","type":"string"},{"key":"AgoraChannelName","value":"","type":"string"},{"key":"llmApiKey","value":"","type":"string"},{"key":"llmUrl","value":"","type":"string"},{"key":"asrLang","value":"","type":"string"},{"key":"ttsVendor","value":"","type":"string"},{"key":"ttsVoiceName","value":"","type":"string"},{"key":"ttsKey","value":"","type":"string"},{"key":"ttsRegion","value":"","type":"string"}]}