Check Scheduled Callback Overlap
    • Dark
      Light

    Check Scheduled Callback Overlap

    • Dark
      Light

    Article summary

    Overview

    This API provides details of a scheduled Callback being overlapping another previously scheduled callback request.

    Pre-requisite

    The Agent must be on an active Outbound Call or logged in to the application.

    Sequence Diagram

    Message Structure

    Request Parameters

    Value

    channel

    LCM

    topic

    Webservice

    subtopic

    ScheduledCallBackOverlap

    source

    «app-name-broadcasting-this-message»

    data

    NA

    Data Parameters

    Parameter

    Mandatory

    Data Type

    Description

    callid

    Yes

    String

    Call ID.

    AccountNumber

    Yes

    String

    LCM Key.

    StartFromDate

    Yes

    String

    Start date.

    StartToDate

    Yes

    String

    End date.

    StartFromTime

    Yes

    String

    Start time.

    StartToTime

    Yes

    String

    End time.

    UserID

    Yes

    String

    Agent ID.

    Response Parameters

    Value

    channel

    LCM

    topic

    Outbound

    subtopic

    ScheduledCallBackOverlap

    message

    «JSON Object»

    Message Parameters

    Parameter

    Mandatory

    Data Type

    Description

    RequestResult

    Yes

    Boolean

    Status of request.

    IsOverlap

    Yes

    Boolean

    Does the callback overlap another request?

    Sample Request

    {   
        "channel": "LCM",
        "topic": "WebService",
        "subtopic": "ScheduledCallBackOverlap",
        "data": 
        {
            "callid": "12345",
            "AccountNumber": "137|1|3|0|0|84|",
            "StartFromDate": "13/01/2021",
            "StartToDate": "13/01/2021",
            "StartFromTime": "13:45",
            "StartToTime": "13:45",
            "UserID": "testagent"
        }
    }

    Sample Response

    {
        "channel": "LCM",
        "topic": "WebService",
        "subtopic": "ScheduledCallBackOverlapResult",
        "message": 
        {
            "RequestResult": true,
            "IsOverlap": false
        }
    }


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence