Contacto

Actualizado el 4 de septiembre de 2026APIDescargar PDF

Usar con IA

Ver como Markdown Abrir en Claude Abrir en ChatGPT

En esta página

POST /contact
Parámetros
Cuerpo de la solicitud
Respuestas
PATCH /contact
Parámetros
Cuerpo de la solicitud
Respuestas
DELETE /contact
Parámetros
Respuestas
GET /contact/all
Parámetros
Respuestas

Operaciones sobre recursos de contacto. 4 endpoints, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado como se describe en Autenticación.

POST /contact

Agregar un nuevo contacto.

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
hierarchyId	query	string	sí	Identificador de nivel de jerarquía como Site, Cliente o ID del proveedor de servicios en el que se crea el contacto.

Cuerpo de la solicitud

Carga útil de Contacto

json

{
  "name": "string (required)",
  "description": "string",
  "email": "string",
  "codeword": "string",
  "available": "boolean",
  "type": "STANDARD",
  "phones": [
    {
      "number": "string",
      "phoneType": "MAIN | MOBILE | HOME | WORK | CUSTOM",
      "customType": "string"
    }
  ]
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "errorCode": 0,
  "errorMessage": "Success",
  "id": "8a81fc4581c99094018224c3d431"
}

Ejemplo 400 respuesta:

json

{
  "errorCode": "ERR001",
  "errorDesc": "Invalid Request"
}

PATCH /contact

Actualizar un contacto por ID de contacto

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
contactId	query	string	yes	ID de Contacto en el que se requiere el parche.
hierarchyId	query	string	sí	ID de jerarquía en la que el contacto está asociado. Por ejemplo, ID de sitio, cliente o proveedor de servicio.

Cuerpo de la solicitud

Carga útil de Contacto

json

{
  "name": "string",
  "description": "string",
  "email": "string",
  "codeword": "string",
  "available": "boolean",
  "phones": [
    {
      "id": "string",
      "number": "string",
      "phoneType": "MAIN | MOBILE | HOME | WORK | CUSTOM",
      "customType": "string"
    }
  ]
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "errorCode": 0,
  "errorMessage": "Success"
}

Ejemplo 400 respuesta:

json

{
  "errorCode": "ERR001",
  "errorDesc": "Invalid Request"
}

DELETE /contact

Eliminar un contacto por ID de contacto

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
contactId	query	cadena	sí	ID de contacto requerido para eliminar.
hierarchyId	query	cadena	sí	ID de nivel jerárquico con el que está asociado el contacto. Por ejemplo, ID de sitio, Cliente o Proveedor de servicio.

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

GET /contact/all

Obtener lista de contactos asociados a un ID de nivel jerárquico como sitio, Cliente o Proveedor de servicio.

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
hierarchyId	query	cadena	sí	ID de nivel jerárquico como sitio, Cliente o Proveedor de servicio.

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
400	Entrada inválida
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "errorCode": 0,
  "message": [
    {
      "id": "8a81b56781c990bb0181d22466bb007e",
      "name": "Axxon test",
      "description": "Site Contact - Automatically created",
      "email": null,
      "codeword": null,
      "available": true,
      "type": "MANAGED",
      "phones": []
    },
    {
      "id": "8a81fc4581c9909401822538dbc70653",
      "name": "John",
      "description": "nxgen user contact",
      "email": "test@nx.com",
      "codeword": "NXG",
      "available": true,
      "type": "STANDARD",
      "phones": [
        {
          "id": "8a81fc4581c9909401822538dbc70654",
          "number": "+919842999112",
          "phoneType": "MAIN",
          "customType": null
        }
      ]
    }
  ]
}

Ejemplo 400 respuesta:

json

{
  "errorCode": "ERR001",
  "errorDesc": "Invalid Request"
}

¿Le ha resultado útil esta página?

Gracias — sus comentarios llegan al equipo responsable de esta página.