Coopération API
En utilisant l'API Chat&Messenger, vous pouvez facilement vous connecter à des systèmes et programmes externes.
L'intégration de l'API permet le traitement suivant.
- Se connecte au système interne et notifie les données de l'entreprise au salon de discussion
- Détecter les erreurs du système et informer les parties liées
- Lien vers des conférences Web à partir d'un logiciel de groupe interne
- Obtenez des informations sur les horaires et les réservations de salles de conférence et établissez des liens avec d'autres systèmes.
Jeton API et interface API
Obtention d'un jeton API depuis l'écran de gestion
Lors de l'intégration de l'API, obtenez d'abord un jeton API.
Veuillez transmettre l'apiToken/serverURL obtenu à JavaScript/curl comme décrit dans « Interface API » ci-dessous.
Interface API
La ligne de commande JavaScript/curl peut être utilisée comme interface API. Les deux exemples ci-dessous peuvent obtenir des informations d’inscription à une salle de conférence au format JSON.
Javascript
let config = { "apiToken": "QIQVOSvRJHrQElDwj20x******", "serverURL": "https://*****************" } let client = new CAMAPIClient(config); let réponse = wait client.getConferenceRooms();
ligne de commande curl
curl -H "x-cam-apiToken:token******" ${serverURL}/getConferenceRooms
*L'URL du serveur pour l'environnement sur site est le port HTTP 8080.
Tout programme d'accès HTTP
Il peut également être lié à n’importe quel programme d’accès HTTP.
Exemple d'écran d'API
Il existe un exemple d'URL où vous pouvez facilement tester l'exécution de l'API. Si vous souhaitez l'utiliser pour des tests, veuillez nous contacter à partir du formulaire de demande.
API
envoyer le message
Envoyer un message.
échantillon
- Envoyer en spécifiant l'ID utilisateur dans Messenger
let réponse = attendre getAPIClient().sendMessage( "messenger", // Spécifier un message direct avec messager "Bonjour!", // Message à envoyer faux, // Enveloppe désactivée ["user1@xxx.com", "user2@ xxx.com"] // Adresse e-mail de destination );
curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"messenger\",\"message\":\"Bonjour\",\" isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessage
- Spécifiez la salle de discussion et envoyez
let réponse = wait getAPIClient().sendMessage( "Nom de la salle", "Hello!", false, ["user1@xxx.com", "user2@xxx.com"] // Spécifier l'adresse e-mail comme mention );
curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"Nom de la salle\",\"message\":\"Bonjour\",\ "isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessage
argument
envoyer |
|
utilisateurs |
|
message |
|
joint |
|
envoyer des messages
Envoyez des messages en masse à partir d'un fichier json.
échantillon
- ligne de commande curl
curl -H "x-cam-apiToken:token******" -d @messages.json ${serverURL}/sendMessages
- Exemple de fichier messages.json lors de l'envoi par message direct
messages=[ {"message": "Bonjour 1", "property": {"users": "user1@test.com, user2@test.com"}}, {"message": "Bonjour 2", "property ":{"users": "user1@test.com, user2@test.com"}}, {"message": "Bonjour 3", "property": {"users": "user1@test.com, user2 @test.com"}}, {"message":"Bonjour 4","property":{"users":"user1@test.com,user2@test.com"}}, ]
- Exemple de fichier messages.json lors de l'envoi à toutes les personnes participant au test du salon de discussion
messages=[ {"envoyer": "test", "message": "Test 1"} ]
créer un appel rapide
conférence Web rapide Créez une URL.
échantillon
- Créez une URL de réunion rapide.
let réponse = wait getAPIClient().createQuickCall( 1624368868714, // Date limite de réunion rapide (UnixTime mm) "mot de passe!", // Spécifiez le mot de passe de la réunion rapide );
argument
date d'expiration |
|
mot de passe |
|
mettre à jourChatRoom
Créer/mettre à jour une salle de discussion
échantillon
let chatRoom = { "id": "1564831284702237059", "name": "Réunion secrète" "createUserId": "11u1pu9d32p8vuvjoZdd", "adminUserId": "11u1pu9d32p8vuvjoZdd", "isMessageThread": true, "isPublic": false, "memberUids }, } let réponse = wait getAPIClient().updateChatRoom(chatRoom); let erreurs = réponse['erreurs']; if (erreurs) { console.log(erreurs); return; } console.log(response["chatRoom" ]);
argument
tchat |
|
getConferenceMaster
Obtenez la liste principale des salles de conférence.
échantillon
Obtenez la liste principale des salles de conférence
let réponse = attendre getAPIClient().getConferenceMaster(); laisser erreurs = réponse['erreurs']; if (erreurs) { console.log(erreurs); retour; } console.log(response["conferenceRooms"]);
argument
aucun
getConferenceRoomStatus
Obtenir une liste des statuts de réservation de salles de conférence
échantillon
let réponse = attendre getAPIClient().getConferenceRoomStatus("201908"); laisser erreurs = réponse['erreurs']; if (erreurs) { console.log(erreurs); retour; } console.log(response["conferenceRoomStatus"] );
argument
aaaaMMjj |
|