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
    • iOS SDK
    • WeChat Mini Program
    • Flutter、DCloud、APICloud
    • CRM Docking Scheme
  • 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
    • 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:

    When a user exits PC and H5 chat windows, Sobot system will push agent 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
        "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

    # Merchant Chat List Message

    API type:

    Callback API

    API function:

    When customer is on the chat list page, Sobot will send the merchant agent chat messages to your designated server.

    Request method:

    POST

    Request format:

    {
        "sysNum": "",          // Company id
        "visitorId": "",          // Visitor ID
        "partnerId": "" ,        // Docking ID
        "lastCid": "" ,          // Chat ID
        "lastMsgContent": "" ,  // Message Content
        "lastMsgTime":  1608198322000 ,   // Message time, ms
        "lastMsgType": 0,     // Message type. 0: text; 1: image; 2: voice; other: rich text
        "unReadNum": 1      // Unread messages
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    Last Updated: 11/15/2024, 2:00:53 PM

    ← iOS SDK Online Message Forwarding API→

    Update Date
    01
    Operations Support API
    04-03
    02
    CRM Docking Scheme
    12-05
    03
    AI Agent API
    09-09
    More Articles>
    Theme by Vdoing
    • Follow Sys
    • Line
    • Dark
    • Read