Share Url

The Share Conversation URL endpoint can be used to generate a unique Share URL for a given conversation. The URL created with this method follows the very same rules applied to the Action counterpart or the conversation command.

Request

The following request will generate a new Share URL:

curl --location --request GET 'https://publicapi.xenioo.com/peoples/conversation/share/<mode>/<user_id>/<duration>' \
--header 'Authorization: Bearer <BOT_AUTH_TOKEN>' \

The mode parameter can have the following values

Value	Description
view	The Share URL will be created as a view URL. This is the default value.
takeover	The Share URL will be created as a take over URL.
auto	The Share URL will be created as a take over URL and conversation will be handed over on expiration.

The duration parameter represent the validity of the generated url in hours.

Response

If the call is successful, a payload containing the generated url will be returned.

{
    "Url":"<shared_url>"
}

Response Codes

This endpoint will reply with the following standard HTTP codes.

Code	Meaning
200	Ok. The request has been successfully fulfilled.
400	Bad Request. The call does not contain the data required to be fulfilled.
401	Unauthorized. The account associated to the token is not authorized
404	Not Found. The specified conversation has not been found