Démarrez aujourd'hui et bénéficiez de 20% de réduction sur votre première facture. Disponible sur toutes les formules.

Cette page décrit les méthodes d'API disponibles pour manipuler des groupes d'opérateurs. Les groupes d'opérateurs servent à organiser les opérateurs (comptes d'utilisateur) dans votre compte. Cette API fournit des méthodes pour gérer chaque groupe, pour ajouter des opérateurs au groupe ou pour en supprimer..

Description de l'objet du groupe d'opérateurs

L'objet OperatorGroup suivant est utilisé dans les méthodes de l'API décrites ci-dessous :

Nom Description Type de données
OperatorGroupGuid Identifiant unique pour ce groupe d'opérateurs. Guid
Description Une chaîne contenant un nom descriptif. String
IsEveryone Indique s'il s'agit du groupe système « Everyone ». Boolean
IsAdministratorGroup Indique s'il s'agit du groupe système « Administrators » Boolean

Le groupe « Everyone » (tout le monde) est un groupe automatique créé par le système. Ce groupe ne peut pas être modifié : chaque opérateur est automatiquement ajouté à ce groupe.

Le groupe « Administrators » est également un groupe créé par le système, mais vous pouvez y ajouter des opérateurs individuels ou les supprimer. Lorsqu'un opérateur est ajouté en tant que membre du groupe Administrateurs, tous les privilèges d'administrateur lui sont automatiquement attribués.

Endpoints pour l’OperatorGroup

Les endpoints d'API suivants sont disponibles pour l'extraction, la création, la mise à jour et la suppression de groupes d'opérateurs :

Type de requête Endpoint Utilisation
GET /OperatorGroup Obtient tous les groupes d'opérateurs.
GET /OperatorGroup/{operatorGroupGuid} Obtient les détails d'un groupe d'opérateurs.
POST /OperatorGroup Crée un nouveau groupe d'opérateurs.
PUT /OperatorGroup/{operatorGroupGuid} Met à jour un groupe d'opérateurs existant.
DELETE /OperatorGroup/{operatorGroupGuid} Supprime un groupe d'opérateurs existant.
GET /OperatorGroup/{operatorGroupGuid}/Member Liste les horaires de service pour un opérateur existant.
POST /OperatorGroup/{operatorGroupGuid}/DutySchedule Ajoute un horaire de service à tous les opérateurs du groupe spécifié.
PUT /OperatorGroup/{operatorGroupGuid}/DutySchedule/{dutyScheduleId} Met à jour l'horaire de service spécifié.
DELETE /OperatorGroup/{operatorGroupGuid}/DutySchedule/{dutyScheduleId} Supprime l'horaire de service spécifié.

GET OperatorGroup

Cette requête GET renverra une collection contenant tous les groupes d'opérateurs, y compris les groupes système spéciaux.

[
 {
  "operatorGroupGuid": "36fad910-6e9f-4886-b1a7-9b4637362cb8",
  "FullName": "First Operator",
  "Email": "FirstOperator@acme.com",
  "MobilePhone": "",
  "IsAccountAdministrator": true,
  "BackupEmail": " FirstOperator@gmail.com ",
  "IsOnDuty": true,
  "SmsProvider": "UseAccountSetting",
  "PhoneProvider": "UseAccountSetting",
  "AllowNativeLogin": "UseAccountSetting",
  "AllowSingleSignon": "UseAccountSetting"
 },
 {
  "operatorGroupGuid": "23a75d1f-0dec-4963-86d8-0cee21267db4",
  "UserName": "SecondOperator@acme.com",
  "FullName": "Second Operator",
  "Email": "SecondOperator@acme.com",
  "MobilePhone": "",
  "IsAccountAdministrator": false,
  "BackupEmail": "",
  "IsOnDuty": false,
  "SmsProvider": "SmsProviderEurope",
  "UseNumericSender": false,
  "PhoneProvider": "UseAccountSetting",
  "AllowNativeLogin": "UseAccountSetting",
  "AllowSingleSignon": "UseAccountSetting"
 }
]

GET OperatorGroup/{operatorGroupGuid}

Cette requête GET renverra les détails du groupe d’opérateurs identifié par le GUID spécifié.

Exemple :

{
 "operatorGroupGuid": "d2782d76-62e7-4946-a41c-fc7f86c96300",
 "FullName": "Third Operator",
 "Email": "ThirdOperator@acme.com",
 "MobilePhone": "+31612345678",
 "OutgoingPhoneNumber": "",
 "IsAccountAdministrator": false,
 "BackupEmail": "",
 "IsOnDuty": false,
 "CultureName": "",
 "TimeZoneId": 56,
 "SmsProvider": "SmsProviderUSA",
 "UseNumericSender": false,
 "PhoneProvider": "UseAccountSetting",
 "AllowNativeLogin": "UseAccountSetting",
 "AllowSingleSignon": "UseAccountSetting"
}

POST OperatorGroup

Créera un nouveau groupe d'opérateurs avec les détails fournis.

Exemple de données d'entrée :

{
 "FullName": "Third Operator",
 "Email": "ThirdOperator@acme.com",
 "MobilePhone": "+31612345678",
 "OutgoingPhoneNumber": "",
 "IsAccountAdministrator": false,
 "BackupEmail": "",
 "IsOnDuty": false,
 "CultureName": "",
 "TimeZoneId": 56,
 "SmsProvider": "SmsProviderUSA",
 "UseNumericSender": false,
 "PhoneProvider": "UseAccountSetting",
 "AllowNativeLogin": "UseAccountSetting",
 "AllowSingleSignon": "UseAccountSetting"
}

La réponse contiendra le groupe d'opérateurs créé, y compris le GUID attribué :

{
 "operatorGroupGuid": "d2782d76-62e7-4946-a41c-fc7f86c96300",
 "FullName": "Third Operator",
 "Email": "ThirdOperator@acme.com",
 "MobilePhone": "+31612345678",
 "OutgoingPhoneNumber": "",
 "IsAccountAdministrator": false,
 "BackupEmail": "",
 "IsOnDuty": false,
 "CultureName": "",
 "TimeZoneId": 56,
 "SmsProvider": "SmsProviderUSA",
 "UseNumericSender": false,
 "PhoneProvider": "UseAccountSetting",
 "AllowNativeLogin": "UseAccountSetting",
 "AllowSingleSignon": "UseAccountSetting"
}

PUT OperatorGroup/{operatorGroupGuid}

Cette méthode met à jour le groupe d’opérateurs identifié par le GUID spécifié, à l'aide des données fournies dans la requête.

Exemple de données d'entrée :

{
 "operatorGroupGuid": "d2782d76-62e7-4946-a41c-fc7f86c96300",
 "FullName": "Third Operator",
 "Email": "ThirdOperator@acme.com",
 "MobilePhone": "+31612345678",
 "OutgoingPhoneNumber": "",
 "IsAccountAdministrator": false,
 "BackupEmail": "",
 "IsOnDuty": false,
 "CultureName": "",
 "TimeZoneId": 56,
 "SmsProvider": "SmsProviderUSA",
 "UseNumericSender": false,
 "PhoneProvider": "UseAccountSetting",
 "AllowNativeLogin": "UseAccountSetting",
 "AllowSingleSignon": "UseAccountSetting"
}

DELETE OperatorGroup/{operatorGroupGuid}

Cette méthode supprimera le groupe d’opérateurs identifié par le GUID spécifié, à l'aide des données fournies dans la requête.