Expand All Collapse All

/icws/web-callback/status/{participantId}

GET

/icws/web-callback/status/{participantId}

Gets the current callback status with statistics.

Feature Version
web-callback 2

Request

Parameters
Type
Name
Comments
Template
participantId

Required

The participant ID on which the request is being made on behalf of.

    Response

    202 - Accepted
    The request to get the callback status has been accepted for processing.
    callbackStatusResponse
    Provides data about the current state of the callback session and target queue statistics.
    Expand AllCollapse All
    Property
    Value
    Comments
    __type
    "urn:inin.com:webCallback:callbackStatusResponse"

    Required

    The JSON type representing this option.
    state
    String

    Required

    The state of the callback session.

    queueWaitTime
    Int
    The current queue wait time of this callback session.
    queuePosition
    Int
    The current queue position of this callback session in the queue.
    400 - Bad Request
    This may indicate that the get status request was not able to be processed.

    Error Responses

    Error Identifier
    Error Type
    Error Description
    error.request.webCallback.invalidParticipantId
    Type: urn:inin.com:common:error
    The request failed because the participant ID is unknown or invalid.
    error
    Provides additional detail for an error.
    Expand AllCollapse All
    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.
    Expand AllCollapse All
    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.
    Expand AllCollapse All
    Property
    Value
    Comments
    errorId
    String
    The error identifier that describes the current error.
    message
    String

    Required

    A message that describes the current error.