Pre-requisites for Getting Started

Get API Key ID/Secret

CustomerRedirectUrl

  • We have an existing CUSTOMER_REDIRECT_URL company setting that, if set, CV2 will use to redirect the user after their call completes.
  • For Click-to-Video, this company setting will be required to be set.
  • The URL can have optional placeholders that will be substituted by CV2 on redirect:
    • {roomSid}
    • {reservationSid}
    • {statusCode}
      customerRedirectUrl: {$customerRedirectUrl}?roomId={$roomIdValue}&reservationId={$reservationIdValue}&statusCode={$statusCodeValue}

Status Code Values:

OK = 'OK',  
LOGIN_ERROR = 'LOGIN_ERROR',  
BAD_REQUEST = 'BAD_REQUEST',  
DECLINED_TCS = 'DECLINED_TCS',  
CALL_RESTART_FAILED = 'CALL_RESTART_FAILED',  
CALL_REJECTED = 'CALL_REJECTED',  
CALL_TIMED_OUT = 'CALL_TIMED_OUT',  
CALL_CANCELLED = 'CALL_CANCELED',
GROUP_RESERVATION_EXPIRED = 'GROUP_RESERVATION_EXPIRED',