Udesk-Customer service solution leader

Get agent group list

This interface is used to retrieve information about multiple customer service groups in one request.

Request Method

GET /user_groups

Request Parameters (Query String)

Parameter Name	Required	Type	Description	Limitations
page	No	Integer	Page number, starting from 1, default is 1
per_page	No	Integer	Number of items per page, default is 20, maximum is 100

Return Data

Attribute Name	Type	Description
code	Integer	Execution result code, 1000 represents success
meta	Object	Pagination information, see Common Data
user_groups	Array	List of customer service groups, see details below

Customer Service Group Data

Attribute Name	Type	Description
id	Integer	Unique identifier
name	String	Name
agents	Array	Includes customer service agents
agents element structure

Value	Description
id	Customer service unique identifier
nick_name	Customer service name

Example

curl https://demo.udesk.cn/open_api_v1/user_groups?page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

Response

{
    "code": 1000,
    "user_groups": [
        {
            "id": 1,
            "name": "Agent Group 1",
            "agents": [
                {"id": 1, "nick_name": "Test Agent1"}
            ]
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1
    }
}

Get agents under agent group

This interface is used to retrieve information about customer service agents under multiple customer service groups in one request.

Request Method

GET /user_groups/:id/agents

Request Parameters (Query String)

Parameter Name	Required	Type	Description	Limitations
page	No	Integer	Page number, starting from 1, default is 1
per_page	No	Integer	Number of items per page, default is 20, maximum is 100

Return Data

Attribute Name	Type	Description
code	Integer	Execution result code, 1000 represents success
user_group	Object	Customer service group details

Customer Service Group Data

Attribute Name	Type	Description
id	Integer	Unique identifier
name	String	Name
agents	Array	Includes customer service agents
agents element structure

Value	Description
id	Customer service unique identifier
nick_name	Customer service name
email	Customer service email
cellphone	Customer service phone number
work_id	Job number
im_ability_value	Dialogue skill value
profile	Employee type
aliase	External nickname
role_name	Account type
duty	Position
user_group_ids	List of group IDs to which the agent belongs
disable_status	Status (enable: enabled, disable: disabled)
avatar	Avatar
lang	Language preference
availability	Whether to accept automatic work order assignment
im_welcomes	Welcome language
user_groups	Employee groups to which the agent belongs
agent_roles	Roles of the employees
departments	Departments to which the employee belongs
agent_callout_display_number	External calling display number
number	SIP information
password	SIP information

Example

curl http://demo.udesk.cn/open_api_v1/user_groups/1/agents?page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

Response

{
    "code": 1000,
    "user_groups": [
        {
            "id": 1,
            "name": "Agent Group 1",
            "agents": [
                {
                    "id": 1,
                    "nick_name": "Test Agent1",
                    "cellphone": 12345678901,
                    "work_id": 1,
                    "profile": "all",
                    "aliase": "Test Agent1",
                    "role_name": "agent",
                    "duty": null,
                    "user_group_ids": [1],
                    "im_ability_value": 10,
                    "disable_status": "enable",
                    "avatar": "http://attachments.gfan.com/forum/attachments2/201302/03/11281446n2st1its4152n5.jpg",
                    "lang": "en-us",
                    "availability": true,
                    "im_welcomes": "",
                    "user_groups": [
                        {"id":2,"name":"Agent Group 1"}
                    ],
                    "agent_roles": [
                        {"id": 1, "name": "role 1", "description": ""}
                    ],
                    "departments": [
                        {"id":1,"name":"Department 1"},
                        {"id":3,"name":"Department 3"}
                    ],
                    "agent_callout_display_number": "",
                    "number": "",
                    "password": ""
                }
            ]
        }
    ]
}

create agent group

This interface is used to create a customer service group.

Request Method

POST /user_groups

Request Parameters (request body)

Parameter	Required	Type	Description	Limitations	Default
name	Yes	String	Customer service group name	No more than 255 characters	None

Return Data

Attribute Name	Type	Description
code	Integer	Execution result code, 1000 represents success
id	Integer	Created customer service group ID

Example

Request

curl https://demo.udesk.cn/open_api_v1/user_groups?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type:application/json' \
-d '{
"name":"Agent Group 1"
}'

Response

{
    "id": 1,
    "code": 1000
}

Update Agent Group

This interface is used to modify a customer service group.

Request Method

PUT /user_groups/:id

Request Parameters (request body)

Parameter	Required	Type	Description	Limitations	Default
name	Yes	String	Customer service group name	No more than 255 characters	None

Return Data

Attribute Name	Type	Description
id	Integer	ID of the customer service group modified by this operation
code	Integer	Execution result code, 1000 represents success
user_group	Object	Customer service group information, structure as follows

user_group structure

Attribute Name	Type	Description
id	Integer	Unique identifier
name	String	Name
agents	Array	Includes customer service agents

Example

Request

curl https://demo.udesk.cn/open_api_v1/user_groups/1?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type:application/json' \
-d '{
"name":"Agent Group 2"
}'

Response

{
    "code": 1000,
    "user_group": {
      "id": 1,
      "name": "Agent Group 2",
      "agents": [
                {"id": 1, "nick_name": "Test Agent1"},
                {"id": 2, "nick_name": "Test Agent2"}
            ]
    }
}

Delete Agent Group

This interface is used to delete a customer service group.

Request Method

DELETE /user_groups/:id

Request Parameters (url)

Parameter Name	Type	Required	Description	Limitations
id	Integer	Yes	Customer service group ID

Request Parameters (request body)

None

Return Data

Attribute Name	Type	Description
code	Integer	Execution result code, 1000 represents success
message	String	Execution result description

Example

Request

curl https://demo.udesk.cn/open_api_v1/user_groups/1?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
-X DELETE \
-H 'content-type: application/json' \

Response

{
    "message": "The customer service group with ID 1 was successfully deleted",
    "code": 1000
}

Code Error Code Description

Error Code	Description of message information	Description of exception: message information	Description
2000	Unknown error	Validation failed: Group name cannot be an empty string	Required parameter name cannot be empty
	name cannot be empty	None	Parameter name must not be empty
2005	Resource not found	Couldn't find UserGroup with id=xxx [WHERE `user_groups`.`company_id` = ? AND `user_groups`.`category` = 'General customer service group']	Parameter id does not match any value

Get agent group list

Request Method

Request Parameters (Query String)

Return Data

Customer Service Group Data

Example

Get agents under agent group

Request Method

Request Parameters (Query String)

Return Data

Customer Service Group Data

Example

create agent group

Request Method

Request Parameters (request body)

Return Data

Example

Update Agent Group

Request Method

Request Parameters (request body)

Return Data

Example

Delete Agent Group

Request Method

Request Parameters (url)

Request Parameters (request body)

Return Data

Example

Code Error Code Description

Products

Solutions

Resources