Endpoints de usuarios finales

Los extremos de la API de usuarios finales proporcionan acceso a los objetos de usuarios finales. Se crea un objeto de usuario final para cada usuario final de CCAI Platform.

A continuación, se indican los extremos de la API de llamadas:

Actualiza el usuario final

Este endpoint te permite actualizar los detalles de un usuario final, incluidos los siguientes:

  • dirección de correo electrónico

  • nombre

  • número de teléfono

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

Endpoint:

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

Encabezados:

Clave Valor Descripción
Content-Type application/json
Aceptar application/json

Cuerpo:

{
    "identifier": "abc123",
    "email": "joe@mydomain.com",
    "name": "Joe Smith",
    "phone": "+16171231234"
}

Ejemplo de solicitud y respuestas

En las siguientes secciones, se proporcionan ejemplos de solicitudes al extremo.

ID y el identificador del usuario final

En este ejemplo, se muestra cómo actualizar un usuario final proporcionando el ID.

Solicitud

Encabezados:

Clave Valor Descripción
Content-Type application/json

Cuerpo:

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}
Respuesta
{
    "id": "integer",
    "identifier": "string"
}

Código de estado: 200

Obtener usuario final

Este endpoint permite recuperar un usuario final con id o identifier.

Endpoint:

Method: GET
Type:
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

Encabezados:

Clave Valor Descripción
Content-Type application/json

Consulta:

Clave Valor Descripción
id integer ID interno del usuario final
identificador cadena Identificador externo del usuario final

Ejemplo de solicitud y respuestas

En las siguientes secciones, se proporcionan ejemplos de solicitudes al extremo.

Obtener por ID

En este ejemplo, se muestra cómo recuperar un usuario final proporcionando el ID.

Solicitud

Encabezados:

Clave Valor Descripción
Content-Type application/json

Consulta:

Clave Valor Descripción
id integer ID interno del usuario final
Respuesta
{
    "id": "integer",
    "identifier": "string"
}

Código de estado: 200

Obtener por identificador

En este ejemplo, se muestra cómo recuperar un usuario final proporcionando el identificador.

Solicitud

Encabezados:

Clave Valor Descripción
Content-Type application/json

Consulta:

Clave Valor Descripción
identifier cadena Identificador externo del usuario final
Respuesta
{
    "id": "integer",
    "identifier": "string"
}

Código de estado: 200