Guest user token API

Required: You must have a valid, authenticated Api User with the Call share role enabled. To request this role be enabled for you, email Creovai Support.

Guest user token API


URL

https://[INSTANCE NAME]/callshare/v1/token


Request

AttributeTypeDescription
callIDstringCreovai call ID
   
emailstringThe email address of the person accessing the call


Response

AttributeTypeDescription
callUrlstringThe target URL to access the shared call
   
expirationdateWhen the request will expire (default is 8 hours)


Example

POST https://[INSTANCE NAME]/callshare/v1/token 
Authorization: Bearer [TOKEN]
Content-Type: application/json; charset=utf-8

{ "callId": "{CallId}", "email": "{EmailOfWhoWillBeAccessingTheCall}" }


Response

{ "callUrl": "{CallUrl}", "expiration": "{ExpirationDateTime}" }


Once the user navigates to the call URL

  1. They will be asked to either
    1. Sign up and create a password, or
    2. Log in with the created password if they already have signed up with that email.
  2. They will be redirected to the call.
Tip: The user accessing the link needs to own the provided email address in case any password reset or other account related messages are sent during the log in step.



Articles in this section


Was this article helpful?