Create a callback call in a queue

POST {{httptype}}://{{IP}}/mot/{{miralixAccount}}/queues/{{callsQueueId}}/calls/callbacks

Create a callback call in a queue. The call is linked to an outbound campaign.
Note! Please note that the callback number (the number of the caller) is validated according to the Callback Number Rules as defined in the Miralix OfficeTeam settings via Miralix Wrench.
HTTP GET: /queues/{queueId}/calls/callbacks

Parameter	Value	Description
queueId	Integer	Id for the queue where the callback call is created in.

JSON payload

Parameter	Value	Description	Required
CallbackNumber	String	The number to call	Yes
OutboundCampaignName	String	A name indicating the campaign that the call will be part of. All created callback calls are currently associated with outboundCampaignId 0.	Yes
Culture	String	Specifies which language to associate with the call. E.g. da-DK. If not specified, the default language for the OfficeTeam configuration is used.	No
Tags	String	Comma-separated list of words describing the call. E.g. Tags=Error message,Sales	No
EntryMenuId	Integer	Entry menu ID. The Entry menu needs to be of the type: Outbound campaign	No
EntryMenuParameters	String	Comma-separated list of entry menu parameters. For example: “CrmId=197,CostumerNo=654” The parameters replace parameters (like <@CrmId@> and <@CostumerNo@>) specified in the entry menu URL or specified in the Arguments for a process.	No

JSON payload Example

{
   "OutboundCampaignName":"Wintersale",
   "Culture":"da-DK",
   "Tags":"Error message,Sales",
   "CallbackNumber":"+4583654321",
   "EntryMenuId":"109",
   "EntryMenuParameters":"CrmId=201020,CustomerNo=657562"
}

Example

https://192.168.1.10/mot/greenbox/queues/12/calls/callbacks - Create a callback call in the queue with ID 12

Result

200 OK - The callback call is created and added to the queue.
400 Bad Request - One or more parameters are not valid.
403 Forbidden - Missing required License to access this request.
404 Not Found - Queue could not be found.
500 Internal Server Error - Internal processing error.

JSON result

Parameter	Value	Description
queueCallId	{Integer}	Queue Caller ID (queueCallId) in Miralix Office Team

Request Body

{"OutboundCampaignName"=>"{{outboundCampaignName}}", "Culture"=>"da-DK", "Tags"=>"Error message,Sales", "CallbackNumber"=>"+4587654321", "EntryMenuId"=>"{{outboundEntryMenuId}}", "EntryMenuParameters"=>"CrmId=201020,CustomerNo=657562"}

RESPONSES

status: OK

{&quot;QueueCallId&quot;:104226}