Calltasks

A calltask in our dialer system is a predefined set of instructions for initiating and managing outbound calls as part of a specific campaign. These campaigns could be sales outreach, customer surveys, appointment reminders, or any other type of telecommunication initiative. The dialer system, equipped with a dialer robot, autonomously dials one or multiple numbers simultaneously, maximizing efficiency.

Once a call is answered, the system automatically connects the agent with the first call. Furthermore, calltasks offer versatility by supporting both automated and manual call handling.

Calltasks can be easily managed through the user interface, allowing users to import contact lists from Excel files for efficient campaign setup. Additionally, an API is available for more advanced users to integrate calltask management into their existing workflows, providing flexibility and scalability for diverse telecommunication needs.

Create calltask(s)

POST ​/itxdialer/calltaskimport

Query Parameters

Name	Type	Description	Default
returnImportedCallTasks	Boolean	True if all created call tasks should be returned in the response	false
importAsync	Boolean	True if the request should return immediately and create call tasks in the background	false

JSON Body Attributes

Name	Type	Example	Description	Required
systemCode	String	MY_SYSTEM	A constant describing the system that is creating the call tasks	Yes
callCode	Integer	123	The code for the call code/campaign that the call tasks will be added to	Yes
maxCallAttempts	Integer	3	Max. number of calls without answer that will be attempted for each call task	Yes
minCallIntervalHours	Integer	12	Min. number of hours between call attempts for a given call task	Yes
callTasks	List of Objects	[{...}]	List of call task objects	Yes
callTasks[*].callReceiverName	String	John Doe	Call receiver name	Yes
callTasks[*].callNumberList	List of Strings	["+4787654321"]	List of numbers that will be called. The dialer will start at the first number and go through the list for each new call attempt.	Yes
callTasks[*].extCustId	String	5123	Unique customer number in the system that is creating the call tasks	No
callTasks[*].systemLookupCode	String	5123	Code to send as an argument when opening this call task in the system that is creating the call tasks	No
callTasks[*].properties	Object	{...}	List of information properties that should be added to call task/entity	No
callTasks[*].properties.emprId	Integer	216	ID of the existing Info field (Informasjonsfelt) in ITX Portal	Yes if properties is used
callTasks[*].properties.value	String	Oslo	A value that will be set for the specified Info field, or added to the calltask name Portal	Yes if properties is used
callTasks[*].properties.addToCallTaskName	Boolean	true / false	Specifies if the "value" should be added to the call task "Call receiver name"	No

Example request

{
	"systemCode": "MY_SYSTEM",
	"callCode": 123,
	"maxCallAttempts": 3,
	"minCallIntervalHours": 12,
	"callTasks": [
		{
			"callReceiverName": "John Doe",
			"extCustId": "5124",
			"systemLookupCode": "5123",
			"properties": [
				{
					"emprId": 216,
					"value": "Oslo",
					"addToCallTaskName": true
				}
			],
			"callNumberList": ["+4712345678", "+4787654321"]
		},
		{
			"callReceiverName": "Jane Doe",
			"extCustId": "5124",
			"systemLookupCode": "5124"
		}
	]
}

API Response

200 OK

The general request has been successfully handled, and statusCode and statusText will be missing in the response. Please note that one or more of the provided call tasks may still not be imported if an invalid call task was provided. Make sure to check that the callTasksErrors list is missing or empty in the response. The callTasksErrors list provides information for each call task that was not imported.

Example response

{
	"callTaskErrors": [
		{
			"callTaskIndex": 1,
			"errorCodes": [102],
			"errorText": "callNumberList is missing/empty"
		}
	]
}

Response body

Name	Type	Description	Required
statusCode	Integer	A constant describing the result of the request in case of an error	In case of an HTTP status other than 200
statusText	String	Human readable description of the result of the request in case of an error	In case of an HTTP status other than 200
callTaskErrors	List	List of objects for each call task that could not be imported	When 200 OK
$callTaskErrors.callTaskIndex	Integer	Zero-based index of the failed call task in the provided list of call tasks	In case of a call task error
$callTaskErrors.errorCodes	List of Integers	List of constants describing the error	In case of a call task error
$callTaskErrors.errorText	String	Human readable description of the call task error	In case of a call task error

API status/error codes

Name	Value
STATUS_CODE_UNKNOWN_ERROR	1
STATUS_CODE_REQUEST_MISSING	2
STATUS_CODE_SYSTEM_CODE_MISSING	3
STATUS_CODE_INVALID_SYSTEM_CODE	4
STATUS_CODE_CALL_CODE_MISSING	5
STATUS_CODE_INVALID_CALL_CODE	6
STATUS_CODE_MAX_CALL_ATTEMPTS_MISSING	7
STATUS_CODE_INVALID_MAX_CALL_ATTEMPTS	8
STATUS_CODE_CALL_INTERVAL_MISSING	9
STATUS_CODE_INVALID_CALL_INTERVAL	0
STATUS_CODE_CALL_TASKS_MISSING	1
STATUS_CODE_INCOMPLETE_SETUP	12
STATUS_CODE_CALL_RECEIVER_NAME_MISSING	101
STATUS_CODE_CALL_NUMBER_MISSING	102
STATUS_CODE_CALL_NUMBER_INVALID	103

400 Bad Request

The provided request was not valid, and no call tasks were imported.

500 Internal Server Error

An unexpected error occurred, and no call tasks were imported. Contact the service provider if the problem persists.