Embedding/Custom UI

Friendly URLs

Check URL availability

GET /clients/(string: clientId)/url/available

Checks if a given URL can be assigned to a channel for this client to be used as a Friendly URL This call does not require authentication.

Parameters:

  • clientId (string) – Specifies the client in which a channel should be looked up in

Query Parameters:

  • url (string) – URL to check the availability for

Response JSON Object:

  • uuid (string) – The uuid of channel

Configure friendly URLs

POST /settings/friendly/urls/(string: state)

When enabled, Friendly URLs will be available and assignable to channels.

Parameters:

  • state (string) – Can be one of enable/disable

Find channel by URL

GET /clients/(string: clientId)/find/channel

Looks up for a channel in a given client context by provided Friendly URL This call does not require authentication.

Parameters:

  • clientId (string) – Specifies the client in which a channel should be looked up in

Query Parameters:

  • url (string) – URL to find channel by

Response JSON Object:

  • uuid (string) – The uuid of channel

Remove friendly URL

DELETE /channels/(string: uuid)/friendly/url

Remove Friendly URL from a channel

Parameters:

  • uuid (string) – The channel whose url must be removed.

Set friendly URL

POST /channels/(string: uuid)/friendly/url

Set Friendly URL for a channel

Parameters:

  • uuid (string) – The channel whose url must be updated.

Request JSON Object:

  • url (string) – An URL to set as a Friendly URL

Custom UI

Get allowed origins (CORS)

GET /clients/(string: clientId)/origins

List allowed origins for the specified client. Note: setting origins is only required in the case that the unusual case that the horn conferencing widget is being run outside of an iframe.

Parameters:

  • clientId (string) – The clientId for which allowed origins will be listed

Response: List of Strings

Get allowed redirection domains

GET /clients/(string: clientId)/domains

List domains allowed as post-oAuth redirect targets. Note: this is only required in the case that the unusual case that the horn conferencing widget is being run outside of an iframe.

Parameters:

  • clientId (string) – The clientId for which allowed redirection domains will be set

Response: List of Strings

Set allowed origins (CORS)

POST /clients/(string: clientId)/origins

Set allowed origins for the specified client. Note: setting origins is only required in the case that the unusual case that the horn conferencing widget is being run outside of an iframe.

Parameters:

  • clientId (string) – The clientId for which allowed origins will be set

Request: List of Strings

Set allowed redirection domains

POST /clients/(string: clientId)/domains

Set domains allowed as post-oAuth redirect targets. Note: this is only required in the case that the unusual case that the horn conferencing widget is being run outside of an iframe.

Parameters:

  • clientId (string) – The clientId for which allowed redirection domains will be set

Request: List of Strings

Response: List of Strings