Event message body examples and parameter descriptions - Intelligent Media Services

Intelligent Media Services (IMS) propose des événements de rappel pour le téléchargement de ressources multimédias, le traitement multimédia et le montage dans le cloud. Vous pouvez configurer des événements de rappel spécifiques afin de recevoir des mises à jour en temps réel sur la progression et l'état des tâches. Les sections suivantes présentent des exemples de corps de message pour chaque type d'événement, accompagnés de la description des champs.

Utilisation

Pour une requête HTTP(S), le corps du message correspond au corps de la requête. Pour une file d'attente MNS, il s'agit du contenu du message reçu.

Liste des événements

Tableau 1. Téléchargement de ressources multimédias

Événement

Description

FileUploadComplete

Un fichier audio ou vidéo est téléchargé.

UploadByURLComplete

Un fichier est téléchargé depuis une URL.

ImageUploadComplete

Une image est téléchargée.

AttachedMediaUploadComplete

Une ressource multimédia auxiliaire est téléchargée.

RegisterStreamComplete

Un flux multimédia est enregistré.

StreamUploadComplete

Un flux multimédia est téléchargé.

UploadStreamByURLComplete

Un flux multimédia est téléchargé depuis une URL.

Tableau 2. Gestion des ressources multimédias

Événement

Description

CreateAuditComplete

Une révision manuelle est terminée.

RegisterMediaComplete

Une ressource multimédia est enregistrée.

DeleteMediaComplete

Une ressource multimédia est supprimée.

MediaBaseChangeComplete

Les informations de base d'une ressource multimédia sont mises à jour.

Événement

FileUploadComplete

Exemple de corps de message :

{
    "EventType": "FileUploadComplete",
    "UserId": 183322097756****,
    "EventTime": "2022-07-15T08:48:14Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "http://outin-***.oss-cn-shanghai.aliyuncs.com/sv/93ad7c5-182010aa3dc/93ad7c5-182010a****.mp4",
        "MediaId": "c321b3a0041a71eda1590674a2ce****",
        "AppId": "app-1000000",
        "Size": "5510872",
        "MediaType": "video"
    }
}

Paramètres du corps de message :

Parameter		Type	Required	Description
EventType		String	Yes	Le type d'événement.
UserId		Long	Yes	L'ID utilisateur.
EventTime		String	Yes	Heure de l'événement (heure UTC), au format `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	-	Le corps du message.
	MediaId	String	Yes	L'ID de la ressource multimédia.
	MediaType	String	Yes	Le type de ressource multimédia. Valeurs possibles : `audio` `video`
	FileUrl	String	Yes	L'URL du fichier.
	Size	String	Yes	La taille du fichier.
	AppId	String	Yes	L'ID de l'application.
	UserData	String	No	Les données définies par l'utilisateur.
	Status	String	Yes	Le statut de l'événement. Valeurs possibles : `Success` et `Fail`.

UploadByURLComplete

Exemple de corps de message :

{
    "EventType": "UploadByURLComplete",
    "UserId": 183322097756****,
    "EventTime": "2022-07-15T08:48:14Z",
    "MessageBody": {
        "Status": "Success",
        "SourceURL": "http://***/big_buck_bunny.mp4",
        "MediaId": "c321b3a0041a71eda1590674a2ce****",
        "AppId": "app-1000000",
        "MediaType": "video",
        "JobId": "88aabd2461ec4ad389f439f6ff92****"
    }
}

Le tableau suivant décrit les paramètres du corps de message.

Parameter		Type	Required	Description
EventType		String	Yes	Le type d'événement.
UserId		Long	Yes	L'ID utilisateur.
EventTime		String	Yes	L'heure à laquelle l'événement s'est produit, en UTC. Le format est `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	-	Le corps du message.
	MediaId	String	Yes	L'ID de la ressource multimédia.
	MediaType	String	Yes	Le type de ressource multimédia. Valeurs possibles : `audio` `video`
	SourceURL	String	Yes	L'URL du fichier source.
	JobId	String	Yes	L'ID de la tâche.
	AppId	String	Yes	L'ID de l'application.
	UserData	String	No	Les données définies par l'utilisateur.
	Status	String	Yes	Le statut de la tâche. Valeurs possibles : `Success` et `Fail`.

ImageUploadComplete

Exemple de corps de message :

{
    "EventType": "ImageUploadComplete",
    "UserId": 183322097756****,
    "EventTime": "2022-07-06T08:27:52Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "https://outin-***.oss-cn-shanghai.aliyuncs.com/image/default/E81B931FA75246B3972844D35291****-6-2.jpg",
        "MediaId": "7e976e80fd0571ec82115523919d****",
        "AppId": "app-1000000",
        "Size": "132066",
        "MediaType": "image"
    }
}

Le corps du message contient les paramètres suivants :

Paramètre		Type	Obligatoire	Description
EventType		String	Oui	Le type d'événement.
UserId		Long	Oui	L'ID utilisateur.
EventTime		String	Oui	L'heure à laquelle l'événement s'est produit, au format UTC. Le format est `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	-	Le corps du message.
	MediaId	String	Oui	L'ID de la ressource multimédia.
	MediaType	String	Oui	Le type de ressource multimédia. Valeur valide : `image`.
	FileUrl	String	Oui	L'URL du fichier.
	Size	String	Oui	La taille du fichier.
	AppId	String	Oui	L'ID de l'application.
	UserData	String	Non	Les données définies par l'utilisateur.
	Status	String	Oui	L'état. Valeurs valides : `Success` et `Fail`.

AttachedMediaUploadComplete

Exemple de corps de message :

{
    "EventType": "AttachedMediaUploadComplete",
    "UserId": 183322097756****,
    "EventTime": "2022-07-15T06:38:33Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "https://outin-***.oss-cn-shanghai.aliyuncs.com/subtitle/4C3C3021EC704639A9F2F55BB0C9****-3-3.ass",
        "MediaId": "b3e59350040871ed9d535532918c****",
        "AppId": "app-1000000",
        "Size": "34758",
        "MediaType": "text"
    }
}

Le corps du message contient les paramètres suivants.

Paramètre		Type	Obligatoire	Description
EventType		String	Oui	Le type d'événement.
UserId		Long	Oui	L'ID utilisateur.
EventTime		String	Oui	L'heure à laquelle l'événement s'est produit, au format UTC. Le format est `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Oui	Le corps du message.
	MediaId	String	Oui	L'ID de la ressource multimédia.
	MediaType	String	Oui	Le type de ressource multimédia. Valeur valide : `text`.
	FileUrl	String	Oui	L'URL du fichier.
	Size	String	Oui	La taille du fichier.
	AppId	String	Oui	L'ID de l'application.
	UserData	String	Non	Les données définies par l'utilisateur.
	Status	String	Oui	L'état du téléchargement. Valeurs valides : `Success` et `Fail`.

RegisterStreamComplete

Exemple de corps de message :

{
    "EventType": "RegisterStreamComplete",
    "UserId": 127753575120****,
    "EventTime": "2022-07-13T09:34:39Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "https://***.oss-cn-shenzhen.aliyuncs.com/InterfaceTest/900d1-b****.aac",
        "MediaId": "fa04bee0028e71edb10f81848c01****",
        "UserData": "{\"MessageCallback\":{\"CallbackURL\":\"***\",\"CallbackType\":\"http\"}}"
    }
}

Le tableau suivant répertorie les paramètres du corps du message.

Parameter		Type	Required	Description
EventType		String	Yes	Le type d'événement.
UserId		Long	Yes	L'ID utilisateur.
EventTime		String	Yes	L'heure à laquelle l'événement s'est produit, au format UTC. L'heure est au format `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	Le corps du message.
	MediaId	String	Yes	L'ID du média.
	FileUrl	String	Yes	L'URL du fichier.
	UserData	String	No	Données définies par l'utilisateur (facultatives).
	Status	String	Yes	Le statut. Les valeurs valides sont `Success` et `Fail`.

StreamUploadComplete

Exemple de corps de message :

{
    "EventType": "StreamUploadComplete",
    "UserId": 174809843091****,
    "EventTime": "2022-07-05T12:53:30Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "http://***.aliyuncs.com/vod-f1e0dd/stream/b37ff450fc6071ec9c5e472190a9****/a0c69a523724cc432c897dcaa6f3****-fd.mp4",
        "MediaId": "b37ff450fc6071ec9c5e472190a9****",
        "UserData": "{\"MessageCallback\":\"{\\\"CallbackURL\\\":\\\"***\\\",\\\"CallbackType\\\":\\\"http\\\"}\"}"
    }
}

Champs du corps du message :

Parameter		Type	Required	Description
EventType		String	Yes	Le type d'événement.
UserId		Long	Yes	L'ID utilisateur.
EventTime		String	Yes	L'heure de l'événement au format UTC. Le format est `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	Le corps du message.
	MediaId	String	Yes	L'ID de la ressource multimédia.
	FileUrl	String	Yes	L'URL du fichier.
	UserData	String	No	Les données définies par l'utilisateur.
	Status	String	Yes	Le statut. Valeurs valides : `Success` et `Fail`.

UploadStreamByURLComplete : Téléchargement de l'URL du flux multimédia terminé

Exemple de corps de message :

{
    "EventType": "UploadStreamByURLComplete",
    "UserId": 174809843091****,
    "EventTime": "2022-07-07T08:09:14Z",
    "MessageBody": {
        "Status": "Success",
        "SourceURL": "http://***/example/html5/mov_bbb.mp4",
        "MediaId": "0f65faa0fdcc71ecbfcd472190a9****",
        "UserData": "{\"MessageCallback\":\"{\\\"CallbackURL\\\":\\\"***\\\",\\\"CallbackType\\\":\\\"http\\\"}\"}",
        "JobId": "7f0d49297cb0fa50ab7341fd60f4****"
    }
}

Ce tableau répertorie les paramètres du corps du message.

Parameter		Type	Required	Description
EventType		String	Yes	Le type d'événement.
UserId		Long	Yes	L'ID utilisateur.
EventTime		String	Yes	L'heure à laquelle l'événement s'est produit, en UTC. Le format est `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	Le corps du message.
	MediaId	String	Yes	L'ID de la ressource multimédia.
	SourceURL	String	Yes	L'URL du fichier source.
	JobId	String	Yes	L'ID de la tâche.
	UserData	String	No	Les données utilisateur.
	Status	String	Yes	L'état de la tâche. Valeurs valides : Success ou Fail.

CreateAuditComplete : révision manuelle terminée

Exemple de corps de message :

{
    "EventType": "CreateAuditComplete",
    "UserId": 183320223010****,
    "EventTime": "2022-06-23T13:11:33Z",
    "MessageBody": {
        "Status": "Success",
        "Auditor": "auditor",
        "Comment": "test",
        "AuditStatus": "Normal",
        "MediaId": "71151b80f2d471ecb21b472190a9****",
        "CreationTime": "2022-06-23T13:11:33Z",
        "Reason": "test"
    }
}

Le corps du message contient les paramètres suivants :

Parameter		Type	Required	Description
EventType		String	Yes	Le type d'événement.
UserId		Long	Yes	L'ID utilisateur.
EventTime		String	Yes	L'heure à laquelle l'événement s'est produit, en UTC. Le format est `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	Le corps du message.
	MediaId	String	Yes	L'ID de la ressource multimédia.
	AuditStatus	String	Yes	L'état de la révision. Valeurs valides : Init : la ressource multimédia est en cours d'initialisation pour la révision manuelle. Normal : la ressource multimédia a passé la révision manuelle. Blocked : la ressource multimédia a été bloquée par la révision manuelle.
	Auditor	String	Yes	Le réviseur qui a effectué la révision manuelle.
	Reason	String	Yes	La raison du résultat de la révision.
	Comment	String	Yes	Le commentaire du réviseur.
	CreationTime	String	Yes	L'heure de création de la tâche de révision manuelle.
	Status	String	Yes	L'état de la tâche de révision manuelle. Valeurs valides : Success : la tâche est terminée. Failed : la tâche a échoué.

RegisterMediaComplete

Description de l'événement :

Pour enregistrer une ressource multimédia dans la bibliothèque de contenu, appelez RegisterMediaInfo. Un rappel est déclenché une fois l'analyse de la ressource multimédia terminée.

Exemple de corps de message :

{
    "EventType": "RegisterMediaComplete",
    "UserId": 183320223010****,
    "EventTime": "2022-06-23T13:11:33Z",
    "MessageBody": {
        "Status": "Success",
        "MediaId": "71151b80f2d471ecb21b472190a9****"
    }
}

Le corps du message inclut les paramètres suivants :

Parameter		Type	Required	Description
EventType		String	Yes	Le type d'événement.
UserId		Long	Yes	L'ID de l'utilisateur.
EventTime		String	Yes	L'heure de l'événement au format UTC, selon la norme ISO 8601 : `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	Le corps du message.
	MediaId	String	Yes	L'ID de la ressource multimédia.
	Status	String	Yes	Le statut de la tâche d'enregistrement. Les valeurs valides incluent : `Success` : La tâche a réussi. `Failed` : La tâche a échoué.
	UserData	String	No	Données définies par l'utilisateur.
	ErrorCode	String	No	Le code d'erreur renvoyé en cas d'échec de la tâche.
	ErrorMessage	String	No	Le message d'erreur renvoyé en cas d'échec de la tâche.

DeleteMediaComplete

Événement

Ce rappel est déclenché lorsque vous appelez l'une des opérations OpenAPI suivantes :

Exemple de corps de message :

{
    "EventType": "DeleteMediaComplete",
    "UserId": 183320223010****,
    "EventTime": "2022-06-23T13:11:33Z",
    "MessageBody": {
        "Status": "Success",
        "MediaId": "71151b80f2d471ecb21b472190a9****",
        "DeleteType": "all"
    }
}

Le corps du message contient les paramètres suivants.

Parameter		Type	Required	Description
EventType		String	Yes	Le type d'événement.
UserId		Long	Yes	L'ID de l'utilisateur.
EventTime		String	Yes	L'heure à laquelle l'événement s'est produit, au format UTC `yyyy-MM-ddTHH:mm:ssZ` (ISO 8601).
MessageBody	-	Object	Yes	Le corps du message.
	MediaId	String	Yes	L'ID de la ressource multimédia.
	Status	String	Yes	Le statut de la tâche de suppression de la ressource multimédia. Valeurs valides : `Success` : La tâche a réussi. `Failed` : La tâche a échoué.
	DeleteType	String	Yes	Le type de ressource à supprimer. Valeurs valides : `all` : Supprime toutes les informations relatives à la ressource multimédia, y compris le fichier source. `stream` : Supprime les informations relatives au flux transcodé. `info` : Effectue uniquement une suppression logique.
	FileURLs	String	No	Ce paramètre est présent uniquement si `DeleteType` est défini sur `stream`.
	ErrorCode	String	No	Le code d'erreur.
	ErrorMessage	String	No	Le message d'erreur.

MediaBaseChangeComplete : Mise à jour des informations de base d'une ressource multimédia

Description de l'événement :

L'appel de l'une des opérations OpenAPI suivantes déclenche ce rappel :

Exemple de corps de message :

{
  "EventType": "MediaBaseChangeComplete",
  "UserId": 183320223010****,
  "EventTime": "2022-06-23T13:11:33Z",
  "MessageBody": {
    "Status":"Success",
    "MediaId":"3b46b391419aj294m83b459f7435****",
    "MediaType":"video",
    "OperateMode":"update",
    "MediaContent":"{\"CoverURL\":\"{\\\"OldValue\\\":\\\"https://outin-8e7b1c7d2a3811eb83da00163e00****.oss-cn-shanghai.aliyuncs.com/0202342e8ae944d09695fd7dbc6d69dc/snapshots/4a6c26eb46a841a3b60c1d56acce****-00005.jpg\\\",\\\"NewValue\\\":\\\"http://cdn.com/ee.png\\\"}\"}"
  }
}

Le corps du message contient les paramètres suivants :

Paramètre			Type	Obligatoire	Description
EventType			String	Oui	Le type d'événement.
UserId			Long	Oui	L'ID utilisateur.
EventTime			String	Oui	L'heure à laquelle l'événement s'est produit, au format UTC. Le format doit être `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-		Object	Oui	Le corps du message.
	Status		String	Oui	Le statut de la tâche de mise à jour de l'élément multimédia. Valeurs possibles : `Success` : La tâche a réussi. `Failed` : La tâche a échoué.
	MediaType		String	Oui	Le type de média. Valeurs possibles : `video` : Vidéo. `audio` : Audio. `image` : Image. `text` : Fichier de sous-titres ou de police. `material` : Package de ressources.
	MediaId		String	Oui	L'ID du média.
	OperateMode		String	Oui	Le mode d'opération. Valeurs possibles : `create` : Crée les informations de base d'un élément multimédia. Le champ `OldValue` du paramètre `MediaContent` est vide. `update` : Met à jour les informations de base d'un élément multimédia. Le champ `OldValue` du paramètre `MediaContent` correspond à la valeur avant la mise à jour, et le champ `NewValue` correspond à la valeur après la mise à jour. `delete` : Supprime les informations de base d'un élément multimédia. Le champ `NewValue` du paramètre `MediaContent` est vide.
	MediaContent	-	Object	Oui	Le contenu de la modification de l'élément multimédia. Cet objet contient les informations de base des fichiers audio et vidéo.
		Title	String	Non	Le titre, formaté sous forme de chaîne JSON. Exemple : `{"OldValue": "OldTitle", "NewValue": "NewTitle"}`.
		Description	String	Non	La description, formatée sous forme de chaîne JSON. Exemple : `{"OldValue": "OldDesc", "NewValue": "NewDesc"}`.
		CoverURL	String	Non	L'URL de l'image miniature, formatée sous forme de chaîne JSON. Exemple : `{"OldValue": "OldCoverURL", "NewValue": "NewCoverURL"}`.
		CateId	String	Non	L'ID de catégorie, formaté sous forme de chaîne JSON. Exemple : `{"OldValue": 123, "NewValue": 456}`.
		Tags	String	Non	Les tags, formatés sous forme de chaîne JSON. Exemple : `{"OldValue": "OldTag", "NewValue": "NewTag"}`.