Create meeting Channel

post/v1/channel

To create meeting channel.

post/v1/channel

https://managedservices-prod.rteappbuilder.com/

Request

HEADER

X-API-KEYREQUIRED

TYPE: STRING

API key to be generated via app-builder console

---

X-Project-ID

TYPE: STRING

Project ID

REQUEST BODY

Create a channel or meet

title

TYPE: STRING

---

enable_pstn

TYPE: BOOLEAN

SAMPLE REQUEST

{
  "title": "my_first_chan",
  "enable_pstn": true
}

Responses

201

400

201

created

id

TYPE: INTEGER

---

host_pass_phrase

TYPE: STRING

---

viewer_pass_phrase

TYPE: STRING

---

channel

TYPE: STRING

---

title

TYPE: STRING

---

pstn

TYPE: OBJECT

number

TYPE: STRING

---

dtmf

TYPE: INTEGER

---

error

TYPE: OBJECT

code

TYPE: STRING

---

message

TYPE: STRING

---

---

400

invalid input or request body

error

TYPE: OBJECT

code

TYPE: INTEGER

---

message

TYPE: STRING

---

201

SAMPLE RESPONSE

{
  "id": 123456,
  "host_pass_phrase": "fc9fd1ba-6943-4d40-837a-058523a140ed",
  "viewer_pass_phrase": "13e059b9-bb2c-4ba4-a9f4-f3ad75069179",
  "channel": "0056df0c-60da-4be8-ba11-54a677bf9d7f",
  "title": "my_first_chan",
  "pstn": {
    "number": "(555) 555-1234",
    "dtmf": 99938969,
    "error": {
      "code": 2004,
      "message": "service unavailable"
    }
  }
}

400

SAMPLE RESPONSE

{
  "error": {
    "code": 611,
    "message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
  }
}

Loading...