Resumen de artículos on ~.UcClient.~ Unified Communications

Obtener artículo

Mon, 01 Jan 0001 00:00:00 +0000

Obtener artículo #

Obtiene un elemento de directorio específico.

GET /v1.0/directorios de contactos/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Ejemplo #

Esta solicitud obtendrá un elemento específico de un directorio con su identificación.

Pedir #

GET <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Autorización: Portador {TOKEN}

Respuesta #

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
{
	"page_size": 1,
	"Datos": [ {
            "id": "00000000-0000-0000-0000-000000000123",
            "campos": {
                "title": "Sr",
                "fullName": "CRM2",
                "companyName": "Empresa",
                "jobTitle": "Título del trabajo",
                "phone1": "+44XXXXXXXXXX",
                "email": "Dirección de correo electrónico",
                "campo1": "campo1",
                "campo2": "campo2",
                "crmId": "00000000-0000-0000-0000-00000000000001"
            }
        }
    ][{
            "id": "00000000-0000-0000-0000-000000000123",
            "fields": {
                "title": "Mr",
                "fullName": "CRM2",
                "companyName": "Company",
                "jobTitle": "Job Title",
                "phone1": "+44XXXXXXXXXX",
                "email": "Email Address",
                "field1": "field1",
                "field2": "field2",
                "crmId": "00000000-0000-0000-0000-000000000001"
            }
        }
    ],
	"status": "éxito",
	"marca de tiempo": "2019-01-01T10:00:00.2890319Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado

Obtener artículos

Mon, 01 Jan 0001 00:00:00 +0000

Obtener artículos #

Obtiene los elementos de directorio que coincidan con el filtro proporcionado.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items?filter={FILTER}& campos={CAMPOS}

warning
Recuerde URL Codifique los parámetros que se pasan en el archivo ' filtro' parámetro.

note
Al buscar en ' phoneX' campos, los números se almacenan en E.164 formato.

Ejemplo #

Esta solicitud consultará todos los elementos con un campo de teléfono que contenga +44XXXXXXXXXX

Crear artículo

Mon, 01 Jan 0001 00:00:00 +0000

Crear artículo #

Crea un nuevo elemento de directorio en el directorio proporcionado.

POST /v1.0/directorios/{DIRECTORY_ID}/items

Ejemplo #

Esta solicitud creará un nuevo elemento de directorio.

Pedir #

POST <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items> HTTP/1.1
Tipo de contenido: application/json
accept-charges: true
Autorización: Portador {TOKEN}
Conexión: keep-alive
{
	"campos": {
        "title": "Sr",
        "fullName": "CRM3a",
        "companyName": "Empresa",
        "jobTitle": "Título del trabajo",
        "phone1": "+44XXXXXXXXXX",
        "email": "Dirección de correo electrónico",
        "campo1": "campo1",
        "campo2": "campo2",
        "crmId": "00000000-0000-0000-0000-0000000000000000001"
    }
}

Respuesta #

HTTP/1.1 201 Creado
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
Ubicación: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items>
{
	"datos": {
        "id": "000000000-0000-0000-0000-00000000000123",
        "campos": {
            "title": "Sr",
            "fullName": "CRM3a",
            "companyName": "Empresa",
            "jobTitle": "Título del trabajo",
            "phone1": "+44XXXXXXXXXX",
            "email": "Dirección de correo electrónico",
            "campo1": "campo1",
            "campo2": "campo2",
            "crmId": "00000000-0000-0000-0000-0000000000000000001"
        }
    },
	"status": "éxito",
	"marca de tiempo": "2019-11-29T16:03:23.9251680Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado

Reemplazar artículo

Mon, 01 Jan 0001 00:00:00 +0000

Reemplazar artículo #

Reemplaza un elemento de directorio existente.

PUT /v1.0/directorios de contactos/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Ejemplo #

Esta solicitud actualizará un elemento de directorio existente.

Pedir #

PUT <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Tipo de contenido: application/json
accept-charges: true
Autorización: Portador {TOKEN}
Conexión: keep-alive
{
    "campos": {
        "title": "Sr",
        "fullName": "CRM3a",
        "companyName": "Empresa",
        "jobTitle": "Título del trabajo",
        "phone1": "+44XXXXXXXXXX",
        "email": "Dirección de correo electrónico",
        "campo1": "campo1",
        "campo2": "campo2",
        "crmId": "00000000-0000-0000-0000-0000000000000000001"
    }
}

Respuesta #

HTTP/1.1 201 Creado
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
Ubicación: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123>
{
	"datos": {
        "id": "000000000-0000-0000-0000-00000000000123",
        "campos": {
            "title": "Sr",
            "fullName": "CRM3a",
            "companyName": "Empresa",
            "jobTitle": "Título del trabajo",
            "phone1": "+44XXXXXXXXXX",
            "email": "Dirección de correo electrónico",
            "campo1": "campo1",
            "campo2": "campo2",
            "crmId": "00000000-0000-0000-0000-0000000000000000001"
        }
    },
	"status": "éxito",
	"marca de tiempo": "2019-11-29T16:03:23.9251680Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado

Objeto de parche

Mon, 01 Jan 0001 00:00:00 +0000

Objeto de parche #

Actualiza un conjunto específico de propiedades de un elemento de directorio. Para ello, se utiliza el atributo JSON Formato de parche para cualquier cambio.

PATCH /v1.0/directorios de contactos/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Ejemplo #

Esta solicitud agregará un nuevo campo de teléfono a un elemento de directorio existente.

Pedir #

PATCH <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Tipo de contenido: application/json
accept-charges: true
Autorización: Portador {TOKEN}
Conexión: keep-alive
{
    "ruta": "/campos/teléfono2",
    "op": "agregar",
    "valor": "+44YYYYYYYYYYYY"
}

Respuesta #

HTTP/1.1 201 Creado
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
Ubicación: <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123>
{
	"datos": {
        "id": "000000000-0000-0000-0000-00000000000123",
        "campos": {
            "title": "Sr",
            "fullName": "CRM3a",
            "companyName": "Empresa",
            "jobTitle": "Título del trabajo",
            "phone1": "+44XXXXXXXXXX",
            "phone2": "+44YYYYYYYYYYYYYYY",
            "email": "Dirección de correo electrónico",
            "campo1": "campo1",
            "campo2": "campo2",
            "crmId": "00000000-0000-0000-0000-0000000000000000001"
        }
    },
	"status": "éxito",
	"marca de tiempo": "2019-11-29T16:03:23.9251680Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado

Eliminar elemento

Mon, 01 Jan 0001 00:00:00 +0000

Eliminar elemento #

Elimina un elemento existente de un directorio.

Pedir #

DELETE /v1.0/directorios de contactos/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Ejemplo #

Esta solicitud eliminará el elemento específico dentro del directorio.

Pedir #

DELETE <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Autorización: Portador {TOKEN}

Respuesta #

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
{ 
	"datos": {
        "id": "00000000-0000-0000-0000-000000000123",
        "campos": {
            "title": "Sr",
            "fullName": "CRM3a",
            "companyName": "Empresa",
            "jobTitle": "Título del trabajo",
            "phone1": "+44XXXXXXXXXX",
            "email": "Dirección de correo electrónico",
            "campo1": "campo1",
            "campo2": "campo2",
            "crmId": "00000000-0000-0000-0000-00000000000001"
        }
    },
	"status": "éxito",
	"marca de tiempo": "2019-01-01T10:00:00.2890319Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado