Aperçu des articles on ~.UcClient.~ Unified Communications

Obtenir des articles

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

Obtenir des articles #

Obtient tous les éléments de répertoire correspondant au filtre fourni.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items ?filter={FILTRE}& fields={CHAMPS}

warning
N'oubliez pas de URL Encodez tous les paramètres transmis dans le ' filtre' paramètre.

note
Lors d'une recherche sur ' phoneX' champs, les numéros sont stockés dans E.164 format.

Exemple #

Cette requête interrogera tous les éléments dont le champ de téléphone contient +44XXXXXXXXXX

Obtenir l'article

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

Obtenir l'article #

Obtient un élément de répertoire spécifique.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Exemple #

Cette requête obtiendra un élément spécifique d'un répertoire dont l'identifiant est utilisé.

Demander #

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

Réponse #

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
	« page_size » : 1,
	« données » : [ {
            « id » : « 00000000-0000-0000-0000-0000000123 »,
            « champs » : {
                « title » : « Monsieur »,
                « fullName » : « CRM2 »,
                « companyName » : « Société »,
                « jobTitle » : « Titre du poste »,
                « phone1 » : « +44XXXXXXXXXX »,
                « email » : « Adresse e-mail »,
                « field1 » : « field1 »,
                « field2 » : « field2 »,
                « crmId » : « 00000000-0000-0000-0000-00000000001 »
            }
        }
    ][{
            "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 » : « succès »,
	« timestamp » : « 2019-01-01T10:00:00.2890319Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé

Créer un élément

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

Créer un élément #

Crée un nouvel élément de répertoire dans le répertoire fourni.

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

Exemple #

Cette demande créera un nouvel élément de répertoire.

Demander #

POST <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : keep-alive
{
	« champs » : {
        « title » : « Monsieur »,
        « fullName » : « CRM3a »,
        « companyName » : « Société »,
        « jobTitle » : « Titre du poste »,
        « phone1 » : « +44XXXXXXXXXX »,
        « email » : « Adresse e-mail »,
        « field1 » : « field1 »,
        « field2 » : « field2 »,
        « crmId » : « 00000000-0000-0000-0000-00000000001 »
    }
}

Réponse #

HTTP/1.1 201 Créé
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
Lieu : <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items>
{
	« données » : {
        « id » : « 00000000-0000-0000-0000-0000000123 »,
        « champs » : {
            « title » : « Monsieur »,
            « fullName » : « CRM3a »,
            « companyName » : « Société »,
            « jobTitle » : « Titre du poste »,
            « phone1 » : « +44XXXXXXXXXX »,
            « email » : « Adresse e-mail »,
            « field1 » : « field1 »,
            « field2 » : « field2 »,
            « crmId » : « 00000000-0000-0000-0000-00000000001 »
        }
    },
	« status » : « succès »,
	« timestamp » : « 2019-11-29T16:03:23.9251680Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé

Remplacer l'article

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

Remplacer l'article #

Remplace un élément de répertoire existant.

PUT /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Exemple #

Cette demande mettra à jour un élément d'annuaire existant.

Demander #

PUT <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : keep-alive
{
    « champs » : {
        « title » : « Monsieur »,
        « fullName » : « CRM3a »,
        « companyName » : « Société »,
        « jobTitle » : « Titre du poste »,
        « phone1 » : « +44XXXXXXXXXX »,
        « email » : « Adresse e-mail »,
        « field1 » : « field1 »,
        « field2 » : « field2 »,
        « crmId » : « 00000000-0000-0000-0000-00000000001 »
    }
}

Réponse #

HTTP/1.1 201 Créé
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
Lieu : <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123>
{
	« données » : {
        « id » : « 00000000-0000-0000-0000-0000000123 »,
        « champs » : {
            « title » : « Monsieur »,
            « fullName » : « CRM3a »,
            « companyName » : « Société »,
            « jobTitle » : « Titre du poste »,
            « phone1 » : « +44XXXXXXXXXX »,
            « email » : « Adresse e-mail »,
            « field1 » : « field1 »,
            « field2 » : « field2 »,
            « crmId » : « 00000000-0000-0000-0000-00000000001 »
        }
    },
	« status » : « succès »,
	« timestamp » : « 2019-11-29T16:03:23.9251680Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé

Objet du patch

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

Objet du patch #

Met à jour un ensemble spécifique de propriétés d'un élément de répertoire. Cette commande utilise le JSON Format du correctif pour toute modification.

PATCH /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Exemple #

Cette demande ajoutera un nouveau champ de téléphone à un élément d'annuaire existant.

Demander #

PATCH <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : keep-alive
{
    « path » : « /champs/phone2 »,
    « op » : « ajouter »,
    « value » : « +44YYYYYYYYYYY »
}

Réponse #

HTTP/1.1 201 Créé
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
Lieu : <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123>
{
	« données » : {
        « id » : « 00000000-0000-0000-0000-0000000123 »,
        « champs » : {
            « title » : « Monsieur »,
            « fullName » : « CRM3a »,
            « companyName » : « Société »,
            « jobTitle » : « Titre du poste »,
            « phone1 » : « +44XXXXXXXXXX »,
            « phone2 » : « +44YYYYYYYYYY »,
            « email » : « Adresse e-mail »,
            « field1 » : « field1 »,
            « field2 » : « field2 »,
            « crmId » : « 00000000-0000-0000-0000-00000000001 »
        }
    },
	« status » : « succès »,
	« timestamp » : « 2019-11-29T16:03:23.9251680Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé

Supprimer l'élément

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

Supprimer l'élément #

Supprime un élément existant d'un répertoire.

Demander #

DELETE /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Exemple #

Cette demande supprimera l'élément spécifique dans l'annuaire.

Demander #

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

Réponse #

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{ 
	« données » : {
        « id » : « 00000000-0000-0000-0000-0000000123 »,
        « champs » : {
            « title » : « Monsieur »,
            « fullName » : « CRM3a »,
            « companyName » : « Société »,
            « jobTitle » : « Titre du poste »,
            « phone1 » : « +44XXXXXXXXXX »,
            « email » : « Adresse e-mail »,
            « field1 » : « field1 »,
            « field2 » : « field2 »,
            « crmId » : « 00000000-0000-0000-0000-00000000001 »
        }
    },
	« status » : « succès »,
	« timestamp » : « 2019-01-01T10:00:00.2890319Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé