This api is used to let a user to join an existing space. Mainly used to retrieve the current information of a space: media server url, members, etc.

URL Parameters

NameDescriptionLocationRequiredDefault Value
spaceIdThe ID of the spacePathYes

Headers

NameDescriptionRequiredDefault Value
spaces-x-space-passwordPassword for protected spacesNo

Body Parameters

None.

Authentication

JwtAuthenticator, Oauth2Authenticator, AnonymousAuthenticator4001

Authorization

PERM_TOPIC_READ

Example Request

URL

For Production: GET https://spacesapis.avayacloud.com/api/spaces/{spaceId}/join
For Staging: GET https://loganstagingapis.esna.com/api/spaces/{spaceId}/join

Headers

Authorization: "jwt eyJhbGciOiJSUzI1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX2lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Example Response

{
  "topic": {
    "_id": "58c8c44fe6cc5917b8ffa83c",
    "cid": "5890b1243bab0e18ff044943",
    "title": "tt1",
    "description": "",
    "restrict": [],
    "status": 0,
    "members": [
      {
        "member": "5890b1243bab0e18ff044...",
        "memberType": "userId",
        "role": "admin",
        "joinTime": "2017-03-15T04:34:23.858Z",
        "username": "example.user1@esna.com",
        "displayname": "Patrick-123 Han-han",
        "picture_url": "https://www.onesna.com/norevimages/noimage.jpg"
      }
    ],
    "parents": [],
    "settings": {
      "confId": "230212035",
      "confPin": "1234",
      "mdOpts": [
        "video",
        "audio"
      ],
      "mdSrv": "ams",
      "mdLic": [
        "video",
        "audio"
      ]
    },
    "created": "2017-03-15T04:34:23.859Z",
    "type": "group"
  },
  "attendeeInfo": {
    "type": "admin"
  },
  "requiredAction": "join",
  "mediaServer": {
    "url": "wcs-production1.onesna.com",
    "port": "443"
  }
}