Modifies the callback settings of an interactive messaging application.
Operation description
You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
live:ModifyLiveMessageAppCallback |
update |
*Rtc
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AppId |
string |
Yes |
The ID of the interactive messaging application whose callback settings you want to modify. |
demo |
| EventCallbackUrl |
string |
No |
The callback URL for events such as user logon, logoff, joining a group, and leaving a group. If you leave this parameter empty, callbacks are disabled. The callback URL must start with http:// or https:// and cannot contain a private IP address or a port number. |
http://example.aliyundoc.com/examplecallback |
| DataCenter |
string |
No |
The data center. It must be the same as the data center that was specified when you called the CreateLiveMessageApp operation to create the interactive messaging application. Valid values: cn-shanghai and ap-southeast-1 (Singapore). |
cn-shanghai |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
1F0FFEAD-B7D5-1D4A-A6B9-8C63ADF6**** |
| AppId |
string |
The ID of the interactive messaging application. |
demo |
| AppSign |
string |
The signature of the interactive messaging application. It is required by the interactive messaging SDK. |
************************************************************************** |
| EventCallbackUrl |
string |
The callback URL for events such as user logon, logoff, joining a group, and leaving a group. This parameter is not returned if it has an empty value. |
http://example.aliyundoc.com/examplecallback |
| EventCallbackNeedAuthentication |
boolean |
Indicates whether authentication is required for event callbacks. Default value: true. |
true |
Examples
Success response
JSON format
{
"RequestId": "1F0FFEAD-B7D5-1D4A-A6B9-8C63ADF6****",
"AppId": "demo",
"AppSign": "**************************************************************************",
"EventCallbackUrl": "http://example.aliyundoc.com/examplecallback",
"EventCallbackNeedAuthentication": true
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InputInvalid | %s. | Illegal input parameters |
| 400 | ErrorInvalidEventCallbackUrl | %s. | The EventCallbackUrl is invalid, please check and try again. |
| 500 | ServerError | %s. | Unknown error, please try again later or submit a ticket for consultation. |
| 403 | NoAuth | %s. | No permission |
| 404 | ResourceNotExist | %s. | The requested resource does not exist, please check and try again |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.