Send a call invitation

Overview

This interface is used to create a call invitation in general mode.

After the call invitation is successfully created, the user who sent the invitation (caller) will receive a notification that the invitation has been created through the following ZIM SDK callback interface:

The user who is invited (callee) will receive a notification of the invitation:

Request method and endpoint

• Request method: POST
• Request endpoint: https://zim-api.zego.im/?Action=CallInvite
• Protocol: HTTPS
• Rate limit: 20 times/second

Request parameters

The following list only shows the request parameters for this interface and some public parameters. For a complete list of public parameters, please refer to Accessing Server APIs - Public parameters.

Sample request

• Request URL:

  https://zim-api.zego.im/?Action=CallInvite
  &<Public Parameters>

• Request Body:

  {
      "FromUserId": "user0",
      "UserIds": [
          "uid1",
          "uid2"
      ],
      "Timeout": 90,
      "ExtendedData": "ExtendedData",
      "OfflinePush": {
          "Enable": 1,
          "Title": "title",
          "Content": "content",
          "Payload": "payload"
      }
  }

Response Parameters

Response Example

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "CallId": "12261423186766631832",
    "CreateTime": "1713249504000",
    "ErrorUsers":[
        {
            "UserId": "uid2",
            "SubCode": 660500002
        }
    ] 
}

Return Codes

The following list only shows the return codes related to the business logic of the interface. For a complete list of return codes, please refer to Return codes.