Notice: The subdomain parameter must be added when calling the API

Get Outbound Task List

This interface is used to obtain a list of all manual outbound tasks under the company.

Request Method

GET /open_api_v1/outbound_task

Request Parameters

Parameter Name	Required	Description
pageNum	No	Page number, default to the first page
pageSize	No	Page size, default to 100

Response Data

Attribute Name	Type	Description
succeed	Boolean	Whether the execution was successful
message	String	"OK" for successful execution, otherwise returns the corresponding error message
paging	Object	Paging information
data	Array of Objects	Outbound task list information, including task ID, task name, and creation time

Example

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

Response

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 100,
        "total": 100
    },
    "data": [
        {
            "id": 271,
            "name": "Outbound Task 1",
            "createdAt": "2020-07-07T16:53:45.000+08:00"
        },
        {
            "id": 272,
            "name": "Customer and Outbound Business Field Mapping",
            "createdAt": "2020-07-07T16:57:28.000+08:00"
        }
    ]
}

Get Outbound Task Details

This interface is used to obtain information for the specified ID of an outbound task.

Request Method

GET /open_api_v1/outbound_task/\{id\}

Request Parameters (URL)

Parameter Name	Required	Description
id	Yes	Outbound task ID

Response Data

Attribute Name	Type	Description
succeed	Boolean	Whether the execution was successful
message	String	"OK" for successful execution, otherwise returns the corresponding error message
data	Object	Outbound task details

data

Attribute Name	Type	Description
id	Integer	Unique identifier
name	String	Name
description	String	Description
startAt	DateTime	Task start time
endAt	DateTime	Task end time
createdAt	DateTime	Creation time
status	String	Status, not_start for not started, processing for in progress, expired for expired, pause for paused
importMethod	String	Import strategy - import method, open for importing to customer center, close for not importing to customer center
holdImportRepeat	String	Import strategy, update for updating duplicate parts in the import form, not_update for discarding duplicate parts in the import form
distributionStrategy	String	Customer seat distribution strategy, average for average distribution (default), balance for load balancing distribution, manual for manual distribution
hideNumber	Boolean	Whether to mask, true for masking, false for not masking (default)
taskFilter	Object	Outbound task filter, as follows
agentIds	Array	Customer service ID array
customerCount	Integer	Number of customers
executedCount	Integer	Number of task executions, each customer in the contact form is counted once
connectedCount	Integer	Number of task connections, each customer in the contact form is counted once
sucRate	Float	Execution success rate
numberFilterStrategy	String	Number strategy - filter setting, defaults to repeatNumber
questionnaireId	Integer	ID of the survey questionnaire template bound to the outbound task
calloutNoteTemplateId	Integer	ID of the outbound business information template associated with the outbound task

taskFilter

Attribute Name	Type	Description
calloutTaskId	Integer	The outbound task to which the filter belongs
conditions	Array of Objects	Filter condition information, as follows
defaultCondition	Object	Default filter, as follows

conditions｜defaultCondition

Attribute Name	Type	Description
id	Integer	Filter ID
name	String	Filter name
agentIds	Array	Seats using this filter
option	String	Filter type, all_condition for meeting all conditions, any_condition for meeting any condition, defaultCondition does not have this value
condition	Object	Filter condition, defaultCondition does not have this value

condition

Attribute Name	Type	Description
fieldName	String	Field required by the filter
operation	String	Condition type
value	String	Condition value

Example

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

Response

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 570,
        "name": "Task Name",
        "startAt": "2021-03-23T15:23:23.000+08:00",
        "endAt": "2021-03-24T15:23:23.000+08:00",
        "createdAt": "2021-03-22T15:26:12.000+08:00",
        "status": "not_start",
        "taskId": 570,
        "customerId": 8915,
        "cellphone": "13812344321",
        "agentIds": [
            19,
            57
        ],
        "questionnaireId": 1,
        "distributionStrategy": "average",
        "calloutNoteTemplateId": 8,
        "hideNumber": true,
        "description": "Description",
        "numberFilterStrategy": "repeatNumber",
        "customerCount": 0,
        "importMethod": "open",
        "holdImportRepeat": "update",
        "sucRate": 0.0,
        "taskFilter": {
            "calloutTaskId": 570,
            "active": 1,
            "permission": "",
            "permissionId": null,
            "groupName": null,
            "creator": null,
            "conditions": [
                {
                    "name": "Customer Name Filter",
                    "id": 2,
                    "agentIds": [
                        19,
                        57
                    ],
                    "option": "all_condition",
                    "condition": [
                        {
                            "fieldName": "name",
                            "operation": "is",
                            "value": "Customer Name"
                        }
                    ]
                }
            ],
            "defaultCondition": {
                "name": "Customer Data",
                "id": 1,
                "agentIds": [
                    19,
                    57
                ],
                "option": null,
                "condition": null
            }
        },
        "executedCount": 0,
        "connectedCount": 0
    }
}

---

Create Outbound Task

This interface is used to create an outbound task.

Request Method

POST /open_api_v1/outbound_task

Request Parameters (Request Body)

Attribute Name	Type	Required for New	Description
name	String	Yes	Name
description	String	Optional	Description
startAt	DateTime	Yes	Start time
endAt	DateTime	Yes	End time
numberFilterStrategy	String	Optional	Number strategy - filter setting, defaults to repeatNumber
distributionStrategy	String	Yes	Customer seat distribution strategy, average for average distribution (default), balance for load balancing distribution, manual for manual distribution
hideNumber	Boolean	Optional	Whether to mask, true for masking, false for not masking (default)
agentIds	Array	Optional	Customer service ID array
questionnaireId	Integer	Optional	ID of the survey questionnaire template bound to the outbound task
calloutNoteTemplateId	Array	Optional	ID of the outbound business information template associated with the outbound task
taskFilter	Object	Optional	Outbound task filter

taskFilter

Attribute Name	Type	Description
calloutTaskId	Integer	The outbound task to which the filter belongs
conditions	Array of Objects	Filter condition information, as follows
defaultCondition	Object	Default filter, as follows

conditions｜defaultCondition

Attribute Name	Type	Description
name	String	Filter name
agentIds	Array	Seats using this filter
option	String	Filter type, all_condition for meeting all conditions, any_condition for meeting any condition, defaultCondition does not have this value
condition	Object	Filter condition, defaultCondition does not have this value

condition

Attribute Name	Type	Description
fieldName	String	Field required by the filter
operation	String	Condition type
value	String	Condition value

Response Data

The same as Get Outbound Task Details.

Example

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task?company_id=1000002&subdomain=demo&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": "Outbound missions in 20211229175404",
    "description": "None",
    "agentIds": [
        573
    ],
    "distributionStrategy": "average",
    "hideNumber": false,
    "numberFilterStrategy": "repeatNumber",
    "calloutNoteTemplateId": 3,
    "questionnaireId": 101,
    "startAt": "2021-12-07 09:00:00",
    "endAt": "2021-12-25 09:07:44",
    "taskFilter": null
}'

Response

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 988,
        "userId": 18,
        "name": "Outbound missions in 20211229175404",
        "startAt": "2021-12-07 09:00:00",
        "endAt": "2021-12-25 09:07:44",
        "taskType": null,
        "agentType": null,
        "status": "not_start",
        "agentIds": [
            573
        ],
        "queueIds": null,
        "questionnaireId": 101,
        "customFieldId": null,
        "distributionStrategy": "average",
        "calloutNoteTemplateId": 3,
        "hideNumber": false,
        "isRepeatCustomerTask": null,
        "focusCalloutNoteFieldId": null,
        "distributionBasis": null,
        "isNumberMask": null,
        "description": "nothing",
        "customDistribution": null,
        "numberFilterStrategy": "repeatNumber",
        "calloutTaskCustomerFilter": null,
        "customerCount": null,
        "sucRate": 0.0,
        "importMethod": "open",
        "holdImportRepeat": "update",
        "taskFilter": null,
        "connectedCount": 0,
        "executedCount": 0
    }
}

---

Update Outbound Task

This interface is used to modify an outbound task.

Request Method

PUT /open_api_v1/outbound_task/\{id\}

Request Parameters (URL)

Parameter Name	Required	Description
id	Yes	Outbound task ID

Request Parameters (Request Body)

Attribute Name	Type	Required for New	Description
name	String	Yes	Name
description	String	Optional	Description
startAt	DateTime	Yes	Start time
endAt	DateTime	Yes	End time
distributionStrategy	String	Yes	Customer seat distribution strategy, average for average distribution (default), balance for load balancing distribution, manual for manual distribution
hideNumber	Boolean	Optional	Whether to mask, true for masking, false for not masking (default)
agentIds	Array	Optional	Customer service ID array
taskFilter	Object	Optional	Outbound task filter

taskFilter

Attribute Name	Type	Description
calloutTaskId	Integer	The outbound task to which the filter belongs
conditions	Array of Objects	Filter condition information, as follows
defaultCondition	Object	Default filter, as follows

conditions｜defaultCondition

Attribute Name	Type	Description
name	String	Filter name
agentIds	Array	Seats using this filter
option	String	Filter type, all_condition for meeting all conditions, any_condition for meeting any condition, defaultCondition does not have this value
condition	Object	Filter condition, defaultCondition does not have this value

condition

Attribute Name	Type	Description
fieldName	String	Field required by the filter
operation	String	Condition type
value	String	Condition value

Response Data

The same as Get Outbound Task Details.

Example

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/1?company_id=1000002&subdomain=demo&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": "Outbound task n",
    "description": "Create a new outbound task",
    "agentIds": [
        19,
        57
    ],
    "distributionStrategy": "balance",
    "hideNumber": true,
    "startAt": "2021-03-22 16:46:15",
    "endAt": "2021-03-24 16:46:15"
    
}'

Response

{
    "succeed": true,
    "code": 200,
"bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 121,
        "name": "Outbound call task",
        "startAt": "2021-03-22T16:46:15.000+08:00",
        "endAt": "2021-03-24T16:46:15.000+08:00",
        "createdAt": "2021-03-22T18:07:19.000+08:00",
        "status": "not_start",
        "taskId": 112,
        "customerId": 8915,
        "cellphone": "13812344321",
        "agentIds": [
            19,
            57
        ],
        "queueIds": null,
        "questionnaireId": 6,
        "distributionStrategy": "balance",
        "calloutNoteTemplateId": 4,
        "hideNumber": true,
        "description": "Create new outbound call task",
        "customDistribution": null,
        "numberFilterStrategy": "repeatNumber",
        "customerCount": 0,
        "importMethod": "open",
        "holdImportRepeat": "update",
        "sucRate": 0.0,
        "taskFilter": null,
        "executedCount": 0,
        "connectedCount": 0
    }
}

---

Delete Outbound Task

This interface is used to delete the specified outbound task by ID.

Request Method

DELETE /open_api_v1/outbound_task/\{id\}

Request Parameters (URL)

Parameter Name	Required	Description
id	Yes	Outbound task ID

Response Data

Attribute Name	Type	Description
succeed	Boolean	Whether the execution was successful
message	String	"OK" for successful execution, otherwise returns the corresponding error message

Example

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
-X DELETE

Response

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false
}

---

Get Outbound Task Contact List

This interface is used to obtain a list of all contact lists under a specified outbound task.

Request Method

GET /open_api_v1/outbound_task/{taskId}/contact_lists

Request Parameters (URL)

Parameter Name	Required	Description
taskId	Yes	Outbound task ID

Request Parameters

Attribute Name	Required	Description
pageNum	No	Pagination page number, default to 1
pageSize	No	Pagination size, default to 10
keyword	No	Search by contact list keyword

Response Data

Attribute Name	Type	Description
succeed	Boolean	Whether the execution was successful
message	String	"OK" for successful execution, otherwise returns the corresponding error message
paging	Object	Pagination information
data	Array of Objects	Contact list information, as follows

data

Attribute Name	Type	Description
id	Integer	Contact list ID
name	String	Contact list name
status	String	Contact list status, not_start for not started, processing for in progress, expired for expired, pause for paused
taskId	Integer	ID of the outbound task to which the contact list belongs
customerCount	Integer	Number of customers under the contact list
connectRate	String	Success rate of customers in the contact list

Example

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/1/contact_lists?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

Response

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 4,
        "total": 4
    },
    "data": [
        {
            "id": 28,
            "name": "Contact List 28",
            "status": "processing",
            "taskId": 112,
            "customerCount": 0,
            "connectRate": "0%"
        }
    ]
}

---

Get Outbound Task Customer List

This interface is used to obtain customer information for a specified outbound task ID.

Request Method

GET /open_api_v1/outbound_task/customers

Request Parameters (Query String)

Parameter Name	Required	Description
taskId	Yes	Outbound task ID
contactListId	No	Contact list ID
pageNum	No	Page number, default to 1
pageSize	No	Page size, default to 10, max to 100

Response Data

Attribute Name	Type	Description
succeed	Boolean	Whether the execution was successful
message	String	"OK" for successful execution, otherwise returns the corresponding error message
paging	Object	Pagination information
data	Object	Task data

data Element Data Structure

Attribute Name	Type	Description
taskId	Integer	ID of the sub-task within the outbound task
id	Integer	Task data ID, different from customer ID, used when assigning seats
name	String	Customer name
cellphones	Array	Customer mobile phone list
agentId	Integer	Customer service ID
executedCount	Integer	Number of executions
executedResult	String	Execution result
contactListId	Integer	Contact list ID
cellphones Element Structure

Attribute Name	Type	Description
name	String	Corresponding letter
content	String	Phone number
title	String	Contact method name

Example

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/customers?company_id=1000002&subdomain=demo&taskId=1&pageNum=1&pageSize=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

Response

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 10,
        "total": 1
    },
    "data": [
        {
            "id": 391,
            "taskId": 112,
            "contactListId": 26,
            "customerId": 8915,
            "name": "This is a customer",
            "cellphone": "13812344321",
            "cellphones": null,
            "agentId": null,
            "executedCount": null,
            "executedResult": null
        }
    ]
}

Get Outbound Task Customer Service List

This interface is used to obtain customer service information for a specified outbound task ID.

Request Method

GET /open_api_v1/outbound_task/callout_tasks/agents

Request Parameters (Query String)

Parameter Name	Required	Description
taskId	Yes	Outbound task ID

Response Data

Attribute Name	Type	Description
succeed	Boolean	Whether the execution was successful
message	String	"OK" for successful execution, otherwise returns the corresponding error message
data	Array of Objects	Customer service data, as follows

agents Element Data Structure

Attribute Name	Type	Description
id	Integer	Customer service ID
name	String	Customer service name
customerCount	Integer	Number of customers

Example

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/agents?company_id=1000002&subdomain=demo&taskId=1&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

Response

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": [
        {
            "id": 114,
            "name": "xxx",
            "customerCount": 0
        }
    ]
}

Create Contact List

This interface is used to create a contact list.

Request Method

POST /open_api_v1/outbound_task/contact_list

Request Parameters

Attribute Name	Required	Description
taskId	Yes	Outbound task ID
contactListName	Yes	Contact list name
customers	Yes	Customer information array, can be customer ID, token, email, mobile number; also supports complex object arrays
agentIds	No	Customer service IDs to be assigned tasks
customerSource	No	Customer source channel: email (email), mobile number (phone), ID (id), token (apiToken), default to mobile number

customers Parameter

Attribute Name	Required	Description
value	Yes	Can be customer ID, token, email, mobile number
title	No	Customer name
TextField_1	No	Custom text field, corresponding to the field ID in the custom fields of 'Customer Management'
SelectField_1	No	Custom field, corresponding to the field ID in the custom fields of 'Customer Management'; If the field is a drop-down field, the value is the value of the drop-down option; If the field is multi-select, multiple values are separated by English commas; If the field is a cascading field, values are separated by English "

Response Data

Attribute Name	Type	Description
Id	Integer	Contact list ID
contactListName	String	Contact list name
taskId	Integer	ID of the outbound task to which the contact list belongs
status	String	Contact list status, 0 for not started, 1 for in progress, 2 for expired, 3 for paused

Example

curl -X POST \
  https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/contact_list?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
  -H 'content-type: application/json' \
  -d '{
    "taskId": 988,
    "contactListName": "Contact list name",
    "agentIds": [
        348
    ],
    "customers": [
        {
            "value": "aa@email.com",
            "title": "Customer name",
            "TextField_8": "Single line text field",
            "SelectField_12": "Option D",
            "TextField_9": "2022-08-03 13:23",
            "SelectField_13": "Top lan, Jungler",
            "TextField_16": "13:23:45",
            "TextField_17": "618001",
            "TextField_18": "31400101001",
            "SelectField_17": "Tianjin City, Heping District"
        }
    ],
    "customerSource": "email"
}'

Response Result

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 1094,
        "contactListName": "Contact form created in 20211229175404",
        "status": "not_start",
        "taskId": 988
    }
}

Update Contact List

This interface is used to update a contact list.

Request Method

PUT /open_api_v1/outbound_task/contact_list/\{id\}

Request Parameters

Attribute Name	Required	Description
id	Yes	Contact list ID
customers	Yes	Customer information array, can be customer ID, token, email, mobile number; also supports complex object arrays
customerSource	No	Customer source channel: email (email), mobile number (phone), ID (id), token (apiToken), default to mobile number

customers Parameter

Attribute Name	Required	Description
value	Yes	Can be customer ID, token, email, mobile number
title	No	Customer name
TextField_1	No	Custom text field, corresponding to the field ID in the custom fields of 'Customer Management'
SelectField_1	No	Custom field, corresponding to the field ID in the custom fields of 'Customer Management'; If the field is a drop-down field, the value is the value of the drop-down option; If the field is multi-select, multiple values are separated by English commas; If the field is a cascading field, values are separated by English "

Response Data

Attribute Name	Type	Description
Id	Integer	Contact list ID
status	String	Contact list status, 0 for not started, 1 for in progress, 2 for expired, 3 for paused

Example

curl -X PUT \
  https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/contact_list/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
  -H 'content-type: application/json' \
  -d '{
    "customers": [
        {
            "value": "24097",
            "title": "Customer name",
            "TextField_8": "Single line text field",
            "SelectField_12": "Option D",
            "TextField_9": "2022-08-03 13:23",
            "SelectField_13": "Top lan, Jungler",
            "TextField_16": "13:23:45",
            "TextField_17": "618001",
            "TextField_18": "31400101001",
            "SelectField_17": "Tianjin City, Heping District"
        }
    ],
    "customerSource": "id"
}'

Response Result

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 1094,
        "status": "not_start"
    }
}

Delete Contact List

This interface is used to delete a contact list.

Request Method

DELETE /open_api_v1/outbound_task/contact_list/\{id\}

Request Parameters

Attribute Name	Required	Description
id	Yes	Contact list ID

Example

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

Response Result

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 1094,
        "contactListName": "Contact form created in 20211229175404",
        "status": "not_start",
        "taskId": 988
    }
}

Get Outbound Business Information Template List

This interface is used to obtain a list of outbound business information templates.

Request Method

GET /open_api_v1/outbound_task/template/call_out_notes

Request Parameters

Attribute Name	Required	Description
pageNum	No	Pagination page number
pageSize	No	Pagination size, default to 10, max to 100

Response Data

Attribute Name	Type	Description
succeed	Boolean	Whether the execution was successful
message	String	"OK" for successful execution, otherwise returns the corresponding error message
paging	Object	Pagination information
data	Array of Objects	Outbound business template, as follows

data Element Data Structure

Attribute Name	Type	Description
id	Integer	Outbound business template ID
name	String	Outbound business template name

Example

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/template/call_out_notes?company_id=1000002&subdomain=demo&pageNum=1&pageSize=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

Response

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 10,
        "total": 1
    },
    "data": [
        {
            "id": 1,
            "name": "Test"
        }
    ]
}

Assign Customers to Seats

This interface is used to assign customers to customer service seats.

Request Method

PUT /open_api_v1/outbound_task/distribution

Request Parameters

Attribute Name	Required	Description
agents	Yes	Array of customer service seats to be assigned
customerTaskIds	Yes	Array of customer task IDs to be assigned
taskId	No	Outbound task ID
assignOption	No	Assignment method, 1 for average assignment (default), 4 for direct assignment

Example

curl -X PUT \
  https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/distribution?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
  -H 'content-type: application/json' \
  -d '{
    "taskId": "988",
    "customerTaskIds": [
        60673
    ],
    "agentIds": [
        573
    ]
}'

Response Result

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false
}

---