Crée une application de messagerie interactive en appelant CreateLiveMessageApp.
Description de l'opération
Lors de l'appel d'autres opérations d'API de messagerie interactive, le centre de données doit être le même que celui utilisé pour créer l'application de messagerie interactive.
Vous pouvez créer jusqu'à 300 applications de messagerie interactive sous un seul compte Alibaba Cloud.
Limite de QPS
La limite de QPS par utilisateur pour cette opération d'API est de 50 appels par seconde. Si cette limite est dépassée, les appels d'API sont limités, ce qui peut affecter votre activité. Appelez cette opération de manière appropriée.
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Test
Autorisation RAM
|
live:CreateLiveMessageApp |
create |
*Toutes les ressources.
|
Aucune | Aucune |
Paramètres de requête
|
Paramètre |
Type |
Requis |
Description |
Exemple |
| AppName |
string |
Non |
Le nom de l'application. Le nom doit comporter entre 2 et 16 caractères. |
testApp |
| AuditType |
integer |
Non |
Le mode d'audit de sécurité. Valeurs valides :
Valeurs valides :
|
2 |
| AuditUrl |
string |
Non |
L'URL pour l'audit de sécurité personnalisé. Ce paramètre est requis lorsque l'audit de sécurité personnalisé est sélectionné (AuditType=2). L'URL doit commencer par http:// ou https://, ne doit pas contenir d'adresses IP privées et ne doit pas inclure de numéros de port. Pour le format du contenu de l'audit de sécurité personnalisé, consultez la section suivante. |
http://demo.aliyundoc.com/exampleaudit |
| EventCallbackUrl |
string |
Non |
L'URL de rappel d'événement pour les événements de connexion, de déconnexion, d'ajout à un groupe et de départ d'un groupe côté client. Si ce paramètre est vide, les rappels d'événement sont désactivés. Pour les opérations d'API qui déclenchent des rappels, consultez Accès client. L'URL de rappel d'événement doit commencer par http:// ou https://, ne doit pas contenir d'adresses IP privées et ne doit pas inclure de numéros de port. Pour le format de rappel d'événement et la logique d'authentification des rappels, consultez la section suivante. |
http://demo.aliyundoc.com/examplecallback |
| DataCenter |
string |
Non |
Le centre de données. Valeurs valides :
Remarque
Lors de l'appel d'autres opérations d'API de messagerie interactive, le centre de données doit être le même que celui utilisé pour créer l'application de messagerie interactive. |
cn-shanghai |
| MsgLifeCycle |
integer |
Non |
Le niveau de durée de stockage des messages de groupe au sein de l'application. Valeurs valides :
|
1 |
Description du contenu de l'audit de sécurité personnalisé :
Protocole de requête : HTTP
Méthode de requête : POST
Exemple de requête :
{
"content": "testaudit"
}
Exemple de réponse :
{
"pass": true,
"reason":"****" |Si pass est true, l'audit est réussi. Sinon, l'audit n'est pas réussi. reason indique la raison de l'échec.
}
Un code d'état HTTP 200 indique un succès. Un code d'état différent de 200 indique que le service n'est pas disponible, et le système revient à ignorer l'audit pour le message.
Rappel d'événement
HTTP/HTTPS POST. Le corps est une chaîne JSON UTF-8 au format suivant. Exemple de rappel d'événement :
{
"appid":"demo",
"eves":[{
"uid":"uid1",
"sid":"sessionid",
"events":[{
"e": 3, |Type d'événement. Énumération. 1 : connexion, 2 : déconnexion, 3 : joingroup, 4 : leavegroup, 5 : client reconnecté après déconnexion du réseau
"r": 1, |Raison de la déconnexion. Cet attribut n'est pas présent pour les autres événements. Énumération. 1 : appel normal, 3 : délai expiré, 4 : connecté depuis un autre appareil
"g": "testgroup", |Identifiant du groupe. Cette valeur est présente pour les événements d'ajout et de départ de groupe. Cet attribut n'est pas présent pour les événements de connexion et de déconnexion.
"gs":["testgroupid"] |Liste des identifiants de groupe. Lorsque le client se reconnecte après une déconnexion du réseau, ceci contient les groupes que le client a rejoints. Cet attribut n'est pas présent pour les autres événements.
}]
}]
}
Un code d'état HTTP 200 indique un succès. Les autres codes d'état indiquent un échec, et le système réessaie la distribution.
Description de l'authentification des rappels
Lorsque le service initie une requête, l'en-tête de requête HTTP(S) inclut les champs Ali-Live-Timestamp et Ali-Live-Signature pour que le serveur de réception des messages de rappel effectue l'authentification de signature. La valeur Ali-Live-Signature est calculée comme suit : Ali-Live-Signature=sha256(CONTENT), où CONTENT = nom de domaine de rappel + valeur Ali-Live-Timestamp + clé d'authentification. Le nom de domaine de rappel est le nom de domaine de l'URL de rappel configurée. La clé d'authentification est l'AppKey générée lors de la création de l'AppId.
Éléments de réponse
|
Élément |
Type |
Description |
Exemple |
|
object |
Les paramètres de réponse. |
||
| RequestId |
string |
L'identifiant de la requête. |
65EEDBEB-43FE-1E15-976F-3DDD753A**** |
| AppId |
string |
L'identifiant de l'application, qui est utilisé dans les opérations ultérieures telles que rejoindre un groupe. |
demo |
| AppKey |
string |
L'AppKey, qui est utilisée pour générer l'authentification pour diverses opérations liées à cet AppId. |
********************************** |
| AppSign |
string |
La signature de l'application. Le SDK du service de messagerie interactive nécessite cette information. |
************************************************************************** |
| DataCenter |
string |
Le centre de données. |
cn-shanghai |
Exemples
JSON format
{
"RequestId": "65EEDBEB-43FE-1E15-976F-3DDD753A****",
"AppId": "demo",
"AppKey": "**********************************",
"AppSign": "**************************************************************************",
"DataCenter": "cn-shanghai"
}
Codes d'erreur
|
Code de statut HTTP |
Code d'erreur |
Message d'erreur |
Description |
|---|---|---|---|
| 400 | InputInvalid | %s. | Les paramètres d'entrée sont invalides. |
| 400 | ErrorInvalidAppName | %s. | L'AppName n'est pas valide. Vérifiez la valeur et réessayez. |
| 400 | ErrorTooManyApps | %s. | Un maximum de 300 applications peuvent être créées simultanément pour chaque compte. |
| 400 | ErrorInvalidEventCallbackUrl | %s. | L'EventCallbackUrl n'est pas valide. Vérifiez la valeur et réessayez. |
| 400 | ErrorInvalidAuditUrl | %s. | L'AuditUrl n'est pas valide. Vérifiez la valeur et réessayez. |
| 500 | ServerError | %s. | Une erreur inconnue s'est produite. Réessayez ultérieurement ou soumettez un ticket. |
| 403 | NoAuth | %s. | Vous ne disposez pas des autorisations requises. |
| 404 | ResourceNotExist | %s. | La ressource demandée n'existe pas. Vérifiez la requête et réessayez. |
Consultez Codes d'erreur pour la liste complète.
Notes de version
Consultez Notes de version pour la liste complète.