Crear Sesión

Permite generar un link el cual al ser compartido conecta un cliente con un agente de manera inmediata de acuerdo a una categoria especifica o mediante un userId.

POST /v1/access/external/cammer/generate-session

Crea un link de sesion.

Endpoint#

https://api.ocularsolution.com/api/v1/access/external/cammer/generate-session

Headers#

AuthorizationSTRING OBLIGATORIO

Valores de ejemplo: 123456789

X-Requested-WithSTRING OBLIGATORIO

Valores de ejemplo: XMLHttpRequest

Parámetros#

nameSTRING OBLIGATORIO

Valores de ejemplo: Abraham, David

emailSTRING OPCIONAL

Valores de ejemplo: example@example.com

cellphone STRING OBLIGATORIO

Valores de ejemplo: +5804145554433

categoryCode STRING OPCIONAL

NO enviar userCode si envio esta propiedad.

Valores de ejemplo: a7d3a90f-6050-476f-8814-6779f54b3caa

userCode STRING OPCIONAL

NO enviar categoryCode si envio esta propiedad.

Valores de ejemplo: 'a7d3a90f-6050-476f-8814-6779f54b3caa'

ticket OBJECT[] OPCIONAL

Mostrar propiedades

title STRING OBLIGATORIO

Valores de ejemplo: Promoción del día del padre

description STRING OBLIGATORIO

Valores de ejemplo: 20% de descuento en todos los productos

Ejemplo de Parámetros#

params

{
  "name": "Abraham",
  "email": "abraham@ocularsolution.com",
  "cellphone": "+584141315854",
  "categoryCode": "a7d3a90f-6050-476f-8814-6779f54b3caa",
  "ticket": {
    "title": "Promoción   del día del padre",
    "description": "20% de descuento en todos los productos"
  }
}

Respuestas del servicio#

Respuesta exitosa#

{
  "statusCode": 0,
  "message": "Success",
  "data": {
    "link": "https://widgetappdev.ocularsolution.com/session/l1z-kfb-dmj-70",
    "customer": {
      "name": "Abraham",
      "email": "abraham@ocularsolution.com",
      "cellphone": "+584141315854"
    }
  }
}

Respuesta fallida#

{
  "statusCode": 2,
  "message": "Campos no cumplen",
  "detail": {
    "cellphone": [
      "SessionLinkControllerValidator: cellphone is required."
    ]
  }
}

{
  "statusCode": 2,
  "message": "Campos no cumplen",
  "detail": {
    "ticket.title": [
      "SessionLinkControllerValidator: ticket.title is required."
    ]
  }
}

Respuesta con errores de validación#

{
  "statusCode": 9,
  "message": "No Authorization token"
}