CallAccept

GET

https://zim-api.zego.im/

This API allows a user to accept a call invitation.

After the user accepts the invitation and enters the call, other users in the call will receive a notification of the call user status change through the following ZIM SDK callback:

iOS	Android	macOS	Windows
callUserStateChanged	onCallUserStateChanged	callUserStateChanged	onCallUserStateChanged

Web	Mini Program	Flutter	React Native
callUserStateChanged	callUserStateChanged	onCallUserStateChanged	callUserStateChanged

Unity3D	uniapp \| uniapp x	HarmonyOS
OnCallUserStateChanged	callUserStateChanged	callUserStateChanged

Note

The parameter FromUserId only supports numbers, English characters, and {'!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', '{', '}', '|', '~'}.

QPS Limit

20 times/s

Request

Query Parameters

Action stringrequired

Possible values: [CallAccept]

API prototype parameter

https://zim-api.zego.im/?Action=CallAccept

AppId uint32required

💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

SignatureNonce stringrequired

💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.

Timestamp int64required

💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡Public parameter. Signature version number.

Signature stringrequired

💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

FromUserId stringrequired

Possible values: <= 32 characters

Accept the invitation for the user with this ID (who has logged in to the ZIM service by calling the login method on the client, or has completed registration by calling the Server API).

CallId stringrequired

Possible values: <= 32 characters

Call ID.

ExtendedData string

Possible values: <= 2048 characters

Extended field, with a maximum length of 2 KB.

Responses

application/json

Schema
Example (from schema)

Schema

Code integer

Return code.

The following only lists the return codes related to the API business logic. For the complete return codes, please refer to Return codes.

Return code	Description	Suggested Solution
660000002	Parameter error.	Please check the request parameters.
660300005	The call frequency exceeds the AppID-level limit.	Please try again later.
660500002	Operator user is not registered.	Please register the operator user with the ZIM service first.
660900004	Failed to get call information.	Please check if the call exists, or try again later.
660900005	The call has ended and cannot be operated on.	No action required.
660900006	The call invitation has timed out and cannot be operated on.	No action required.
660900008	The call did not invite the operator user and cannot be operated on.	No action required.

Message string

Operation result description.

RequestId string

Request ID.

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782"
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782"
}

CallAccept

https://zim-api.zego.im/

Request

Query Parameters

Responses​

Responses