MessageBody Introduction

ZIM server supports developers to send different types of messages to the session through the server API, and the supported types are shown in the table below:

When you call the ZIM server interface to send messages, you need to pass the message content through the parameter MessageBody. The format of MessageBody varies depending on the message type. This article will introduce the corresponding parameters for each message type.

Text message, custom message and pop-up message

MessageBody structure 

The MessageBody structure is the same for text messages, custom messages and pop-up messages, as described below:

OfflinePush introduction (inapplicable for room messages)

MessageBody example

{
    "MessageBody": {
        "Message":"hello world",
        "ExtendedData":"extendedData",
        "OfflinePush" :{
            "Enable":0, 
            "Title":"Title",
            "Content":"Content", 
            "Payload":"data"
        },
        "HasReceipt": 1
    }
}

Command message

MessageBody structure

MessageBody example

{
    "MessageBody": {
        "Message":"hello world",
        "ExtendedData":"extendedData",
        "IsBase64":0
    }
}

Picture message

MessageBody structure

Message structure

Message example

{
    "Uid":"343649807833778782", 
    "Origin": {
        "Url":"https:xxx", 
        "Width":100,
        "Height":200
    },
    "FileName":"FileName.jpg", 
    "Size":1024
}

MessageBody example

{
    "MessageBody": {
        "Message":"", // The content of the image message is a JSON byte string generated according to the Message structure of the image message.
        "ExtendedData":"extendedData",
        "OfflinePush" :{
                "Enable":0, 
                "Title":"Title",
                "Content":"Content", 
                "Payload":"data"
        },
        "HasReceipt": 1
    }
}

File message

MessageBody structure

Message structure

Message example

{
      "Uid":"343649807833778782", 
      "Url":"https:xxx", 
      "FileName":"FileName.txt", 
      "Size":1024
}

MessageBody example

{
    "MessageBody": {
        "Message":"", // The content of the file message, which is a JSON byte string generated according to the Message structure of the file message.
        "ExtendedData":"extendedData",
        "OfflinePush" :{
            "Enable":0, 
            "Title":"Title",
            "Content":"Content", 
            "Payload":"data"
        },
        "HasReceipt": 1
    }
}

Audio message

MessageBody structure

Message structure

Message example

{
    "Uid":"343649807833778782", 
    "Url":"https:xxx", 
    "FileName":"FileName.mp3", 
    "Size":1024,
    "MediaDuration":30
}

MessageBody example

{
    "MessageBody": {
        "Message":"", // The content of the audio message, a JSON byte string generated according to the Message structure of the audio message.
        "ExtendedData":"extendedData",
        "OfflinePush" :{
            "Enable":0, 
            "Title":"Title",
            "Content":"Content", 
            "Payload":"data"
        },
        "HasReceipt": 1
    }
}

Video message

MessageBody structure

Message structure

Message example

{
    "Uid":"343649807833778782", 
    "Url":"https:xxx", 
    "FileName":"FileName.mp4", 
    "Size":1024,
    "MediaDuration":300,
    "Thumbnail": {
        "Url":"https:xxx", 
        "Width":100,
        "Height":200
    }
}

MessageBody example

{
    "MessageBody": {
        "Message":"", // The content of the video message as a JSON byte string generated from the Message structure of the audio message.
        "ExtendedData":"extendedData",
        "OfflinePush" :{
            "Enable":0, 
            "Title":"Title",
            "Content":"Content", 
            "Payload":"data"
        },
        "HasReceipt": 1
    }
}