CreateLiveMessageApp - - Alibaba Cloud Dokümantasyon Merkezi

Operation description

Diğer etkileşimli mesajlaşma API işlemlerini çağırırken, veri merkezi etkileşimli mesajlaşma uygulamasını oluşturmak için kullanılan veri merkeziyle aynı olmalıdır.
Tek bir Alibaba Cloud hesabı altında en fazla 300 etkileşimli mesajlaşma uygulaması oluşturabilirsiniz.

QPS limiti

Bu API işlemi için tek kullanıcı QPS limiti saniyede 50 çağrıdır. Limit aşılırsa API çağrıları kısıtlanır ve bu durum işlerinizi etkileyebilir. Bu işlemi uygun şekilde çağırın.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:CreateLiveMessageApp

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppName	string	No	Uygulama adı. Ad 2 ila 16 karakter uzunluğunda olmalıdır.	testApp
AuditType	integer	No	Güvenlik denetimi modu. Geçerli değerler: 0: varsayılan değer. Güvenlik denetimi devre dışıdır. 1: Yerleşik güvenlik denetimi. 2: Özel güvenlik denetimi. Valid values: 0 : güvenlik denetimi devre dışı. 1 : yerleşik güvenlik denetimi. 2 : özel güvenlik denetimi.	2
AuditUrl	string	No	Özel güvenlik denetimi URL'si. Bu parametre, özel güvenlik denetimi seçildiğinde (AuditType=2) gereklidir. URL http:// veya https:// ile başlamalı, özel IP adresları içermemeli ve bağlantı noktası numaraları içermemelidir. Özel güvenlik denetimi içeriğinin formatı için aşağıdaki bölüme bakın.	http://demo.aliyundoc.com/exampleaudit
EventCallbackUrl	string	No	İstemci oturum açma, oturum kapatma, gruba katılma ve gruptan ayrılma olayları için olay geri çağırma URL'si. Bu parametre boşsa olay geri çağırmaları devre dışı bırakılır. Geri çağırmaları tetikleyen API işlemleri için İstemci erişimi konusuna bakın. Olay geri çağırma URL'si http:// veya https:// ile başlamalı, özel IP adresları içermemeli ve bağlantı noktası numaraları içermemelidir. Olay geri çağırma formatı ve geri çağırma kimlik doğrulama mantığı için aşağıdaki bölüme bakın.	http://demo.aliyundoc.com/examplecallback
DataCenter	string	No	Veri merkezi. Geçerli değerler: cn-shanghai: varsayılan değer. Şanghay. ap-southeast-1: Singapur. Not Diğer etkileşimli mesajlaşma API işlemlerini çağırırken, veri merkezi etkileşimli mesajlaşma uygulamasını oluşturmak için kullanılan veri merkeziyle aynı olmalıdır.	cn-shanghai
MsgLifeCycle	integer	No	Uygulama içindeki grup mesajları için depolama süresi kademesi. Geçerli değerler: 0: varsayılan değer. Mesajlar 30 gün boyunca saklanır. 1: Mesajlar 90 gün boyunca saklanır. 2: Mesajlar 180 gün boyunca saklanır.	1

Özel güvenlik denetimi içeriği açıklaması:

İstek protokolü: HTTP
İstek yöntemi: POST
İstek örneği:

{
  "content": "testaudit"
}

Yanıt örneği:

{
  "pass": true,
  "reason":"****"    |pass true ise denetim geçilir. Aksi takdirde denetim geçilmez. reason başarısızlığın nedenini belirtir.
}

Not

200 HTTP durum kodu başarıyı gösterir. 200 olmayan bir durum kodu hizmetin kullanılamadığını gösterir ve sistem mesaj denetimini atlamaya geri döner.

Olay geri çağırma

HTTP/HTTPS POST. Gövde, aşağıdaki formatta bir JSON UTF-8 dizesidir. Olay geri çağırma örneği:

{
  "appid":"demo",
  "eves":[{
  "uid":"uid1",
  "sid":"sessionid",
  "events":[{
     "e": 3, |Olay türü. Sabit listesi. 1: oturum açma, 2: oturum kapatma, 3: gruba katılma, 4: gruptan ayrılma, 5: ağ bağlantısı kesildikten sonra istemcinin yeniden bağlanması
     "r": 1, |Oturum kapatma nedeni. Bu öznitelik diğer olaylar için mevcut değildir. Sabit listesi. 1: normal çağrı, 3: zaman aşımı, 4: başka bir cihazdan oturum açma
     "g": "testgroup", |Grup kimliği. Bu değer gruba katılma ve gruptan ayrılma olayları için mevcuttur. Bu öznitelik oturum açma ve oturum kapatma olayları için mevcut değildir.
     "gs":["testgroupid"] |Grup kimliği listesi. Ağ bağlantısı kesildikten sonra istemci yeniden bağlandığında, bu liste istemcinin katıldığı grupları içerir. Bu öznitelik diğer olaylar için mevcut değildir.
  }]
  }]
}

Not

200 HTTP durum kodu başarıyı gösterir. Diğer durum kodları başarısızlığı gösterir ve sistem teslimatı yeniden dener.

Geri çağırma kimlik doğrulama açıklaması

Hizmet bir istek başlattığında, HTTP(S) istek üst bilgisi, geri çağırma mesajı alan sunucunun imza kimlik doğrulaması gerçekleştirmesi için Ali-Live-Timestamp ve Ali-Live-Signature alanlarını içerir. Ali-Live-Signature değeri şu şekilde hesaplanır: Ali-Live-Signature=sha256(CONTENT), burada CONTENT = geri çağırma etki alanı adı + Ali-Live-Timestamp değeri + kimlik doğrulama anahtarı. Geri çağırma etki alanı adı, yapılandırılan geri çağırma URL'sinin etki alanı adıdır. Kimlik doğrulama anahtarı, AppId oluşturulduğunda üretilen AppKey'dir.

Response elements

Element	Type	Description	Example
	object	Yanıt parametreleri.
RequestId	string	İstek kimliği.	65EEDBEB-43FE-1E15-976F-3DDD753A****
AppId	string	Gruba katılma gibi sonraki işlemlerde kullanılan uygulama kimliği.	demo
AppKey	string	Bu AppId ile ilgili çeşitli işlemler için kimlik doğrulama oluşturmakta kullanılan AppKey.	**********************************
AppSign	string	Uygulama imzası. Etkileşimli mesajlaşma hizmeti SDK'sı bu bilgiyi gerektirir.	**************************************************************************
DataCenter	string	Veri merkezi.	cn-shanghai

Examples

Success response

JSON format

{
  "RequestId": "65EEDBEB-43FE-1E15-976F-3DDD753A****",
  "AppId": "demo",
  "AppKey": "**********************************",
  "AppSign": "**************************************************************************",
  "DataCenter": "cn-shanghai"
}

Error codes

HTTP status code	Error code	Error message
400	InputInvalid	%s.
400	ErrorInvalidAppName	%s.
400	ErrorTooManyApps	%s.
400	ErrorInvalidEventCallbackUrl	%s.
400	ErrorInvalidAuditUrl	%s.
500	ServerError	%s.
403	NoAuth	%s.
404	ResourceNotExist	%s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.