Aller au contenu

Autorisation de l'opérateur et liens profonds

Ce guide explique comment obtenir un jeton d'autorisation valide pour les opérateurs du système via l'API et comment utiliser des liens profonds pour accéder au panneau de discussion.

URL de base de l'API : https://chatapi.smsbat.com/ Swagger : https://chatapi.smsbat.com/index.html

Remarque : Vous pouvez utiliser l'en-tête X-Authorization-Key avec votre jeton (disponible dans votre profil dans le tableau de bord) au lieu de l'autorisation Bearer pour les demandes au niveau de l'entreprise.

1. Obtenir le jeton de l'entreprise

Pour obtenir le jeton de l'entreprise, envoyez une requête HTTP POST à /api/company/get-token contenant les identifiants de connexion de l'entreprise.

Demande - Méthode : POST - URL : https://chatapi.smsbat.com/api/company/get-token - En-têtes : Content-Type : application/json

Corps : 

{
  "login": "string",
  "password": "string"
}

Réponse - Code d'état : 200 (OK) - Corps : Jeton de chaîne (""votre_token_string"`)

Remarque : Enregistrez le jeton reçu pour les demandes ultérieures.

2. Récupérer la liste des organisations

Envoyez une requête GET à /api/company/organization en utilisant le jeton d'entreprise pour répertorier vos organisations.

Demande - Méthode : OBTENIR - URL : https://chatapi.smsbat.com/api/company/organization - En-têtes : - Autorisation : Porteur {token} - Accepter : texte/plain

Réponse - Code d'état : 200 (OK) - Corps : 

[
  {
    "id": 6,
    "name": "string"
  }
]

3. Récupérer les opérateurs par organisation

Envoyez une requête GET à /api/operator à l'aide du paramètre organizationId.

Demande - Méthode : OBTENIR - URL : https://chatapi.smsbat.com/api/operator?organizationId={id} - En-têtes : - Autorisation : Porteur {token} - Accepter : texte/plain

Réponse - Code d'état : 200 (OK) - Corps : 

[
  {
    "id": 21,
    "name": "string",
    "status": 1,
    "organization": {
      "id": 24,
      "name": "test_costs"
    }
  }
]

4. Ajouter des opérateurs au système

Utilisez le jeton d'entreprise pour accéder à ce point de terminaison et synchroniser les opérateurs avec le système.

Demande - Méthode : POST - URL : https://chatapi.smsbat.com/api/operator/synchronize - En-têtes : - Autorisation : Porteur {token} - Type de contenu : application/json

Corps : 

[
  {
    "organizationId": 24,
    "name": "string"
  }
]

Réponse - Code d'état : 200 (OK) - Corps : 

[
  {
    "id": 21,
    "status": 0,
    "name": "string"
  }
]

Statuts d'opérateur possibles : - Actif : 0 - Inactif : 1 - Supprimé : 2

5. Obtenir le jeton d'opérateur

Autorisez avec le token de l’entreprise pour obtenir un token pour un opérateur spécifique.

Demande - Méthode : POST - URL : https://chatapi.smsbat.com/api/operator/get-token - En-têtes : - Autorisation : Porteur {token} - Type de contenu : application/json

Corps : 

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt est obligatoire et détermine la durée de la session de l'opérateur (max +24 heures).

Réponse - Code d'état : 200 (OK) - Corps : Jeton de chaîne

6. Valider le jeton de l'opérateur

Vérifier la validité du token d'un opérateur.

Demande - Méthode : POST - URL : https://chatapi.smsbat.com/api/operator/validate-token - En-têtes : - Autorisation : Porteur {token} - Type de contenu : application/json

Corps : "operator_token_string"

Réponse valide (200 OK) : 

{
  "isValid": true,
  "operatorId": 0,
  "clientId": 0,
  "expiresAt": "2024-12-28T14:04:15.861Z",
  "error": null
}

7. Lien profond vers le panneau de discussion de l'opérateur

Les systèmes externes (CRM, ERP, sites Web internes) peuvent ouvrir directement le panneau Chat en exploitant les liens profonds en passant le jeton de l'opérateur JWT en paramètre. Si le jeton est invalide ou expiré, l'utilisateur sera redirigé vers l'interface de connexion.

Format 1 : Par ID de chat

https://chat.smsbat.com/?chat_raw_id=<chat_id>&token=<jwt_token>

Format 2 : Par numéro de téléphone

https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
Le numéro de téléphone doit être au format international E.164.

Format 3 : Par nom alpha et téléphone

https://chat.smsbat.com/?from=<bm_id>&phone=<phone_number>&token=<jwt_token>

Format 4 : détails complets de la cible

Spécifiez exactement de quelle source intercepter les messages : 

https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>
Sources de discussion : - '0' - Viber - 1 - ViberBot - 2 - TélégrammeBot - '3' - WhatsApp - 4 - Widget - 5 - Rozetka - '6' - Facebook - '7' -Instagram