Points de terminaison pour les utilisateurs finaux

Les points de terminaison de l'API des utilisateurs finaux permettent d'accéder aux objets des utilisateurs finaux. Un objet d'utilisateur final est créé pour chaque utilisateur final de Contact Center AI Platform (CCAI Platform).

Voici les points de terminaison de l'API d'appel :

Mettre à jour l'utilisateur final

Ce point de terminaison vous permet de mettre à jour les informations d'un utilisateur final, y compris les suivantes :

  • vous@votre-entreprise.com

  • nom

  • numéro de téléphone

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

Point de terminaison :

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

Titres :

Clé Valeur Description
Content-Type application/json
Accepter application/json

Corps :

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

Exemples de requêtes et de réponses

Les sections suivantes fournissent des exemples de requêtes au point de terminaison.

ID et identifiant de l'utilisateur final

Cet exemple montre comment mettre à jour un utilisateur final en fournissant son ID.

Requête

Titres :

Clé Valeur Description
Content-Type application/json

Corps :

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}
Réponse
{
    "id": "integer",
    "identifier": "string"
}

Code d'état : 200

Obtenir l'utilisateur final

Ce point de terminaison permet de récupérer un utilisateur final à l'aide de l'id ou identifier.

Point de terminaison :

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

Titres :

Clé Valeur Description
Content-Type application/json

Requête :

Clé Valeur Description
id entier ID interne de l'utilisateur final
identifiant chaîne Identifiant externe de l'utilisateur final

Exemples de requêtes et de réponses

Les sections suivantes fournissent des exemples de requêtes au point de terminaison.

Obtenir par ID

Cet exemple montre comment récupérer un utilisateur final en fournissant son ID.

Requête

Titres :

Clé Valeur Description
Content-Type application/json

Requête :

Clé Valeur Description
id entier ID interne de l'utilisateur final
Réponse
{
    "id": "integer",
    "identifier": "string"
}

Code d'état : 200

Obtenir par identifiant

Cet exemple montre comment récupérer un utilisateur final en fournissant son identifiant.

Requête

Titres :

Clé Valeur Description
Content-Type application/json

Requête :

Clé Valeur Description
identifier chaîne Identifiant externe de l'utilisateur final
Réponse
{
    "id": "integer",
    "identifier": "string"
}

Code d'état : 200