POST /api/apps/spaces/discover

This endpoint is hit when Room application joins a space from calendar invite. The space invite link is passed in the body of this request. Spaces validates the invite link, parses it and returns space information (including SIP information).

Header

NameDescriptionData TypeRequiredDefault Value
AuthorizationJwt auth tokenStringYes
spaces-x-space-passwordSpaces passwordStringYes (for password protected spaces)

URL Parameters

NameDescriptionLocationRequiredDefault Value

Body Parameters

NameDescriptionJSON typeRequiredDefault Value
spaceUrlSpace URLStringYes
appIdApplication IdStringYes

Authentication

JwtAuthenticator, Oauth2Authenticator, AnonymousAuthenticator

Example Request

URL

For Production: POST https://spacesapis.avayacloud.com/api/apps/spaces/discover
For Staging: POST https://loganstagingapis.esna.com/api/apps/spaces/discover

Headers

Authorization: "jwt eyJhbGciOiJSUzI1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX2lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"
spaces-x-space-password: "123456"

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"
spaces-x-space-password: "123456"

Body

{
    "spaceUrl": SPACE_URL,
    "appId": "GQ6KK8H1G99X43CD"
}

Example Response

Error Response: 

{
    "isSpaceValidated": false,
    "isAppValidated": false
}

Success Response: 

{
    "isSpaceValidated": true,
    "isAppValidated": true,
    "channel": {
        "type": "topic",
        "_id": "TOPIC_ID"
        "isPrivate": "true"
    },
    "sipInfo": {
        "sipURI": "sips:_PT_d8f4deb6c34833a4af30f37ac2f926fafe1b8640411e7ce556f0db0896655ecb@spaces.sip.mpaas.avayacloud.com:5061"
    }
}