Developer Documentation Developer Documentation
Help Center (opens new window)
Help Center (opens new window)
  • Channel Access

    • Web Link Access Description
    • Web-JS Access Description
    • Android SDK V6
    • Android SDK V7
    • iOS SDK V6
    • iOS SDK V7
    • WeChat Mini Program
    • Flutter、DCloud、APICloud、OpenHarmony
    • CRM Docking Scheme
    • Message Compliance Inspection API
  • Live Chat API
  • Chatbot API
  • Agent Component SDK

  • Message Push
    • Online Message Forwarding API
    • Knowledge Base V6 API
    • Chatbot Statistics API
    • Enterprise actively sends offline message API
    • Rule Engine API
    • AI Agent API
    • Live Chat Statistics API
    • Knowledge Center API
    • Text Product API
    Sobot
    2022-05-19
    Menus

    Message Push

    # Message Push

    # Offline Message

    API type:

    Callback API

    API function:

    Sobot system will push agent offline messages to the user's pre-configured callback URL.

    Request method:

    POST

    Request format:

    {
         "type": 202, // Message type, indicates agent sending messages to customer
         "partnerId": "", // Enterprise's user ID
         "msgId": "" ,// Message ID
         "content": "" ,// Agent sending content
         "msgType": "" ,// Message type, text, image
         "aname": "", // Agent Nickname
         "aface": "",// Agent Avatar
         "params": ""// Custom Param
     }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10

    # Customer Unread Message

    API type:

    Callback API

    API function:

    1. PC / H5 During the period from when the user closes the session page for more than 1 minute until the session ends, the system will push messages sent by customer service agents to the enterprise-configured callback address in real time.
    2. SDK (Android Only) If the Android client fails to receive messages normally or does not confirm the received messages within 5 seconds, the system will push the corresponding messages to the enterprise-configured callback address.

    Request method:

    POST

    Request format:

    {
        "type": 202, // Message type, indicates agent sending messages to customer
        "partnerId": "", // Enterprise's user ID
        "msgId": "" ,// Message ID
        "params": "" ,// Custom Param
        "content": "" ,// Agent sending content
        "msgType": "", // Message type, text, image, file, voice, video
        "aname": "",// Agent Nickname
        "aface": "",// Agent Avatar
        "sysNum": "",// Company id 
        "createChatTime": 1608192372781,// Chat Creation Time
        "channelFlag": 1,// Sub-channel ID
        "appName": "",// Sub-channel name 
        "aid": "",// Agent ID
        "ts":  1608192578781 ,// Message sending time
        "cid": "",// Chat ID
        "uid": "" // Sobot customer ID 
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    Last Updated: 7/20/2026, 1:52:52 PM

    ← iOS SDK Online Message Forwarding API→

    Update Date
    01
    CallCapability(Android-SDK)
    07-24
    02
    Message Compliance Inspection API
    05-28
    03
    Android SDK V7
    10-22
    More Articles>
    Theme by Vdoing
    • Follow Sys
    • Line
    • Dark
    • Read