Skip to main content

List Reply

This endpoint retrieves a list of all replies (chat bubble) for a msg_id which is owned by a shop_id.x

Path​

get

/v1/chat/fs/:fs_id/messages/:msg_id/replies?shop_id=:shop_id

Request Parameters​

ParameterTypeRequiredLocationDescription
fs_id
Integer
Required
path
Fulfillment service unique identifier
msg_id
Integer
Required
query
Message service unique identifier
shop_id
Integer
Required
query
Shop service unique identifier
page
Integer
Required
query
Determine which page the order list should start. Start from 1. You can get the next page when the previous page has have_next_page value true
per_page
Integer
Required
query
Determine how many orders will be shown per page. The maximum value is 15

Example Request​

curl -X GET \
https://fs.tokopedia.net/v1/chat/fs/12345/messages/54321/replies?shop_id=234567 \
-H 'Authorization: Bearer OoHgyxcgQ5a1uCbmbbXjjA'

Response Parameters​

NameTypeDemo ValueDescription
msg_id
Integer
54321
Message Unique Identifier
sender_id
Integer
13579
Sender User Unique Identifier
role
String
User
User Role
msg
String
Message Payload
reply_time
Integer
1564741529630
Reply Time in UNIX format
reply_id
Integer
98765
Reply Unique Identifier
sender_name
String
Owen
Sender Name
read_status
Integer
2
Read Status
read_time
Integer
1564741529221
Read Time in UNIX format
status
Integer
1
Reply Status
attachment_id
Integer
77777
Attachment Unique Identifier
message_is_read
Boolean
true
Is message has been read?
is_opposite
Boolean
true
Is the message from buyer?
is_first_reply
Boolean
false
Is the beginning of your reply (first reply)?
is_reported
Boolean
false
Is the chat bubble reported?

Success Response Examples​

{
"header": {
"process_time": 0,
"messages": "success",
"reason": "",
"error_code": 0
},
"data": [
{
"msg_id": 54321,
"sender_id": 13579,
"role": "User",
"msg": "<a rel=\"nofollow\" target=\"_blank\" href=\"https://staging.tokopedia.com/fuados-tiga/test-product\">https://staging.tokopedia.com/fuados-tiga/test-product</a>",
"reply_time": 1564741529630,
"reply_id": 98765,
"sender_name": "Owen",
"read_status": 2,
"read_time": 1564741529221,
"status": 1,
"attachment_id": 77777,
"message_is_read": true,
"is_opposite": true,
"is_first_reply": false,
"is_reported": false
}
]
}

Error Response Examples​

{
"header": {
"process_time": 0.001552878,
"messages": "Your request format or parameters have some problem.",
"reason": "invalid shop_id format",
"error_code": 0
},
"data": null
}

Error Codes​

Error CodeError MessageDescription
SHP_GRPC_001
Failed Send GRPC Request
Failed sending request to upstream
SHP_GRPC_003
Data Not Found
Failed finding data from upstream

Notes​

Response field explanation:

  1. Field attachment_id is an identic key for an attachment.
  2. Field is_opposite is to identify if the value is true, the message is from the buyer (if you’re the seller).
  3. Field is_reported is to identify whether the chat bubble is reported or not.
  4. Field is_first_reply is to identify the chat is the beginning of your reply (first reply) or not.

Have a feedback?