appel : updateRecordingStatus

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Mettre à jour le status d’enregistrement de l’application associé à un appel. Cela nécessite l’utilisation de la solution d’enregistrement basée sur la stratégie Teams .

Restriction supplémentaire : vous ne pouvez PAS utiliser l’API d’accès aux médias pour enregistrer ou conserver le contenu multimédia des appels ou des réunions auxquels votre application accède, ou les données dérivées de ce contenu multimédia (« enregistrement » ou « enregistrement »), sans appeler au préalable l’API updateRecordingStatus pour indiquer que l’enregistrement a commencé, et sans recevoir une réponse de réussite de cette API. Si votre application commence à enregistrer une réunion, elle doit mettre fin à l’enregistrement avant d’appeler l’API updateRecordingStatus pour indiquer que l’enregistrement est terminé.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Non prise en charge. Non prise en charge.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Calls.AccessMedia.All Calls.JoinGroupCall.All

Requête HTTP

POST /app/calls/{id}/updateRecordingStatus
POST /communications/calls/{id}/updateRecordingStatus

Remarque : le chemin d’accès /app est obsolète. À l’avenir, utilisez le chemin d’accès /communications.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, indiquez un objet JSON avec les paramètres suivants.

Paramètre Type Description
clientContext String Chaîne de contexte client unique. La limite maximale est de 256 caractères.
status String Le status de l’enregistrement. Les valeurs possibles sont : notRecording, recording, ou failed.

Réponse

Cette méthode renvoie un 200 OK code de réponse et un en-tête Location avec un URI à l’objet updateRecordingStatusOperation créé pour cette requête.

Exemple

L’exemple ci-après montre comment appeler cette API.

Demande

L’exemple suivant illustre la demande.

POST https://graph.microsoft.com/beta/communications/calls/{id}/updateRecordingStatus
Content-Type: application/json
Content-Length: 79

{
  "clientContext": "clientContext-value",
  "status": "notRecording | recording | failed"
}

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Location: https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5

{
  "@odata.type": "#microsoft.graph.updateRecordingStatusOperation",
  "clientContext": "clientContext-value",
  "id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",
  "resultInfo": null,
  "status": "completed"
}