webchat_push
Last Updated: 18 Apr 2025
Basics
| Property | Value |
|---|---|
| Category | Webchat Push |
| Push Mechanism Name | webchat_push |
| Push Mechanism Code | 10 |
| Push Mechanism Description | Get the chat message |
| Push Mechanism Subscription Rules | Seller In House System/Customer Service/Original/Ads Service App |
| Time Out Seconds | 2s |
| Sequence Guaranteed | Yes |
| Can Repeated Same Message | Yes |
| Retry Seconds | 1s,2s,3s |
Push Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| data | object | ||
| type | string | Can be notification / message | |
| region | string | The region info. | |
| content | object | The detailed message. | |
| user_id | string | Returned when the type = notification. | |
| conversation_id | string | Shopee's unique identifier for a conversation. | |
| type | string | Returned when the type = notification. | |
| timestamp | timestamp | Returned when the type = notification. | |
| msg_id | int64 | Returned when the type = notification. | |
| biz_id | int64 | Returned when the type = notification. | |
| message_id | string | Returned when type= message. Shopee's unique identifier for a message. | |
| shop_id | int64 | Returned when type= message. The shop_id of the shop message sent to (to_shop_id) | |
| request_id | string | Returned when type= message. The identifier for an request for error tracking. | |
| from_user_name | string | Returned when type= message. The user name for the message sender in the conversation. | |
| from_id | int64 | The user id for the message sender in the conversation. | |
| to_id | int64 | Returned when type= message. The user id for the message recipient in the conversation. | |
| to_user_name | string | Returned when type= message. The user name for the message recipient in the conversation. | |
| message_type | string | Returned when type= message. text / video / image / item / faq_liveagent | |
| content | object | ||
| text | timestamp | Returned when message type=text or faq_liveagent, specific dialog text information. | |
| translation | object | Returned when message type=text. | |
| text | string | ||
| source | string | ||
| target_language | string | ||
| source_language | string | ||
| mid | object | Returned when message type=text. | |
| text | string | ||
| source | string | ||
| target_language | string | ||
| source_language | string | ||
| url | string | Returned when message type=image. | |
| thumb_url | string | Returned when message type=image or video. | |
| thumb_height | int64 | Returned when message type=image or video. | |
| thumb_width | int64 | Returned when message type=image or video. | |
| file_server_id | int64 | Returned when message type=image. | |
| video_url | string | Returned when message type=video. | |
| duration_seconds | int64 | Returned when message type=video. | |
| shop_id | int64 | Returned when message type=item. The shop_id of the shop message sent to (to_shop_id) | |
| item_id | int64 | Returned when message type=item. | |
| pass_through_data | string | Returned when message type=faq_liveagent. | |
| messages | string[] | ["23234234234","234232423"] | Returned when type=bundle_message. return all the message_id in the bundle_message |
| shopee_chatbot_replied | boolean | true | Return when message_type=bundle_message if there is Shopee Chatbot session in the bundle message We recommend transfer to manual reply mode if shopee_chatbot_replied=true(Shopee Chatbot already involved) |
| created_timestamp | timestamp | Returned when type= message. The creation time of conversation. | |
| region | string | Returned when type= message. The region where the conversation take places. | |
| is_in_chatbot_session | boolean | Returned when type= message. | |
| source_content | object | Returned when type= message. | |
| item_id | int | Returned when message type= item. | |
| sub_account_id | int64 | if the message is sent from sub-account/main account, then will indicate the sub_account_id If not, =0 | |
| sub_account_name | string | if the message is sent from sub-account/main account, then will indicate the sub_account_id If not, =0 | |
| quoted_msg | object[] | ||
| message_id | int64 | Return message_id when a quoted message is present. If there is no quoted message, message_id will be empty. | |
| business_type | int32 | business_type=0 means it is a conversation chat between buyer and seller business_type=11 means it is a conversation chat between affiliate and seller | |
| to_shop_id | int64 | shopee shop id who receive the message | |
| from_shop_id | int64 | shopee shop id who send the message | |
| status | string | The message status, the possible values are: normal; auto_reply; blocked; user_chat; web_chat; censored_whitelist; censored_blacklist; offwork_autoreply | |
| shop_id | int | shop_id of shop receives the push message Shopee's unique identifier for a shop. | |
| code | int | Shopee's unique identifier for a push notification. | |
| timestamp | timestamp | Timestamp that indicates the message was sent. |
If it is notification type:
Json
{
"msg_id": null,
"data": {
"type": "notification",
"region": "PH",
"content": {
"user_id": 12252079,
"conversation_id": "4670954831706433",
"type": "mark_as_replied",
"content": {
"conversation_id": "4670954310906433"
},
"timestamp": 1719883961,
"msg_id": 0,
"biz_id": 0,
"from_id": 0
}
If it is message type and message including text:
Json
{"msg_id":"","data":{"type":"message","region":"ID","content":{"message_id":"2302748948493123953","shop_id":165103149,"request_id":"35f9478b-7482-46eb-a268-8f828fedb673","from_id":165105353,"from_user_name":"vn_cstoreponorogo","to_id":947151379,"to_user_name":"keelatofficial","message_type":"text","content":{"text":"Baik kak .. 🤗"},"conversation_id":"709122092476686867","created_timestamp":1726044721,"region":"ID","is_in_chatbot_session":false,"source_content":{},"quoted_msg":{"message_id":""},"sub_account_id":0,"sub_account_name":0}},"shop_id":947042923,"code":10,"timestamp":1726044722}
If it is message type and message including video
Json
{"data":{"type":"message","region":"VN","content":{"message_id":"2165920666211451249","shop_id":123456789,"request_id":"1091617252119662617","from_id":161057467,"from_user_name":"hyhy2606","to_id":213245905,"to_user_name":"sixhd.vn","message_type":"video","content":{"video_url":"cf03c9e1fe2c0992cdb51c3cb6eab2bd","thumb_url":"6c710d7679c9f3a9a7287250421d17d3_dynamic_tn","thumb_width":399,"thumb_height":713,"duration_seconds":15},"conversation_id":"691736553754845137","created_timestamp":1660799912,"region":"VN","is_in_chatbot_session":false,"source_content":{},"quoted_msg":{"message_id":""},"sub_account_id":0,"sub_account_name":0}},"shop_id":123456789,"code":10,"timestamp":1660799912}
If it is message type and message including image
Json
{"data":{"type":"message","region":"VN","content":{"message_id":"2165920671942967665","shop_id":123456789,"request_id":"313F2D/BTMessage/p108","from_id":679422730,"from_user_name":"thutrang290402","to_id":6343861,"to_user_name":"thanhnga_hcm","message_type":"image","content":{"url":"https://cf.shopee.vn/file/09591ecdc9f1dc7bd507817797d826fe_dynamic","thumb_url":"b9591ecdc9f1dc7bd507817797d826fe_dynamic_tn","thumb_height":711,"thumb_width":400,"file_server_id":0},"conversation_id":"27246676204792586","created_timestamp":1660799915,"region":"VN","is_in_chatbot_session":false,"source_content":{},"quoted_msg":{"message_id":""},"sub_account_id":0,"sub_account_name":0}},"shop_id":123456789,"code":10,"timestamp":1660799915}
If it is message type and message including item info
Json
{"data":{"type":"message","region":"ID","content":{"message_id":"2165920670806327665","shop_id":123456789,"request_id":"389465101372418716","from_id":163219823,"from_user_name":"fadlyjo.","to_id":119159078,"to_user_name":"zhousijia","message_type":"item","content":{"shop_id":109157255,"item_id":9112503530},"conversation_id":"511784343194732911","created_timestamp":1660799914,"region":"ID","is_in_chatbot_session":false,"quoted_msg":{"message_id":""},"sub_account_id":0,"sub_account_name":0,"source_content":{"item_id":4112503530}}},"shop_id":123456789,"code":10,"timestamp":1660799915}
If it is message type and message including faq_liveagent
Json
{"data":{"type":"message","region":"ID","content":{"message_id":"2165920670296736113","shop_id":123456789,"request_id":"4600339818579251427","from_id":172765311,"from_user_name":"bundhakevinabizar","to_id":94311357,"to_user_name":"madamegieofficial","message_type":"faq_liveagent","content":{"text":"Chat dengan Penjual","pass_through_data":""},"conversation_id":"405064194129145983","created_timestamp":1660799914,"region":"ID","is_in_chatbot_session":false,"quoted_msg":{"message_id":""},"sub_account_id":0,"sub_account_name":0,"source_content":{"order_sn":"220818EGS328B9"}}},"shop_id":123456789,"code":10,"timestamp":1660799915}
Update Log
| Date | Update Details |
|---|---|
| 2025-04-18 | Add from_shop_id, to_shop_id, status |
| 2024-11-05 | Add business_type for affiliate marketing solution chat Add bundle_message for FAQ and chatbot message Add shopee_chatbot_replied to indicate if Shopee Chatbot involved |
| 2024-09-23 | Add sub_account_id and sub_account_name; Add quoted_message |
| 2024-09-04 | Update the definition of the shop_id inside "content" |
| 2022-09-24 | roll back retry config |