Get Agent Settings

GET

/customer_service/202309/agents/settings

This API is used to get agent settings. This API allows the agent to see whether the agent can accept chats from buyers. This API is a read-only endpoint. There will be no side effects, and can be retried safely. Note: 1. The current API version can only get settings on behalf of the shop, or the owner account holder on Seller Center. The owner in this case is acting as the customer service agent. In the future, we plan to make this API available to subaccount holders (who has customer service role) in Seller Center. 2. This API is to allow the agent to get his/her own setting. See more information in API overview

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

can_accept_chat

Whether the current agent can accept chat. If true, the agent will receive auto-assigned chats. The agent can manually select chats to respond. If false, the agent will receive manually assigned chats only.

boolean

Example

{
  "code": 0,
  "data": {
    "can_accept_chat": true
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}