Documentation

Channel Leave

Causes the callee to be removed from the channel.

URL Requires Auth HTTP Method
/api/v1/channels.leave yes POST

Payload

| Argument | Example | Required | Description | | :— | :— | :— | :— | | roomId | ByehQjC44FwMeiLbX | Required | The channel’s id |

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/channels.leave \
     -d '{ "roomId": "ByehQjC44FwMeiLbX" }'

Example Result

{
  "channel": {
    "_id": "ByehQjC44FwMeiLbX",
    "name": "invite-me",
    "t": "c",
    "usernames": [
      "testing2"
    ],
    "msgs": 0,
    "u": {
      "_id": "aobEdbYhXfu5hkeqG",
      "username": "testing1"
    },
    "ts": "2016-12-09T15:08:58.042Z",
    "ro": false,
    "sysMes": true,
    "_updatedAt": "2016-12-09T15:22:40.656Z"
  },
  "success": true
}

Change Log

| Version | Description | | :— | :— | | 0.48.0 | Added |