/icws/web-callback/create

POST

/icws/web-callback/create

Creates a callback interaction.

Feature Version
web-callback 2

Request

This request has no parameters.
Representations
callbackCreateRequest
An object representing a request to initiate a call back.
Property
Value
Comments
__type
"urn:inin.com:webCallback:callbackCreateRequest"

Required

The JSON type representing this option.
targetQueue
String

Required

The target queue for the callback request.
targetQueueType
String

Required

The queue target type, "Workgroup", "User".
telephone
String

Required

The telephone number to use in the callback.
name
String

Required

The name of the callback request participant.
subject
String
The subject of the call back request.

Response

200 - OK

The callback was created successfully.

The response will include information that the client needs to interact with the callback. This includes information such as the participant ID, the callback ID for the callback and the date and time formats to be used client side.

callbackCreateResponse
An object representing a response to initiate a callback.
Property
Value
Comments
__type
"urn:inin.com:webCallback:callbackCreateResponse"

Required

The JSON type representing this option.
participantID
Guid

Required

A unique Guid representing a participant identifier.

dateFormat
String

Required

A date format to display dates.

timeFormat
String

Required

A time format to display times.

callbackID
String

Required

A callback ID representing a callback session.

400 - Bad Request
This may indicate that the callback was not started.
error
Provides additional detail for an error.
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.
410 - Gone
This resource has been deprecated and removed from the API.
error
Provides additional detail for an error.
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.
500 - Internal Server Error
An unexpected error occurred while processing the request.
error
Provides additional detail for an error.
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.