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
 }

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 
}

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
}