Get Reserved Non-PEWC Contact
    • Dark
      Light

    Get Reserved Non-PEWC Contact

    • Dark
      Light

    Article summary

    Overview

    The GetReservedNonPEWCContact API provides a non-PEWC contact already reserved for an Agent.

    Note

    The Manual Dial Widget replaces the Non-PEWC widget eventually. Non-PEWC is compatible up to the Campaign Manager version 2308.

    Pre-requisite

    The agent must be logged in to the application.

    Sequence Diagram

    Message Structure

    Request Parameters

    Value

    channel

    LCM

    topic

    Webservice

    subtopic

    GetReservedContactOD

    source

    «app-name-broadcasting-this-message»

    data

    «JSON Object»

    Data Parameters

    Parameter

    Mandatory

    Data Type

    Description

    UserID

    Yes

    String

    The agent ID.

    Response Parameters

    Value

    channel

    LCM

    topic

    Webservice

    subtopic

    ContactOD

    message

    «JSON Object»

    Message Parameters

    Parameter

    Mandatory

    Data Type

    Description

    response

    Yes

    JSON Object

    Response object.

    Response Parameters

    PhoneNumber

    Yes

    String

    The contact phone number.

    AccountNumber

    Yes

    String

    The LCM Key.

    CampaignId

    Yes

    String

    The campaign ID.

    Mode

    Yes

    String

    The contact mode.

    ContactID

    Yes

    Number

    The contact ID as generated by the application.

    ExpiryTime

    Yes

    String

    The contact expiry date and time.

    CallbackTime

    Yes

    String

    The Callback time.

    CallType

    Yes

    Number

    The call type - regular, regular callback, or personal callback.

    Prefix

    Yes

    String

    The prefix added to the contact value (phone number).

    Suffix

    Yes

    String

    The suffix added to the contact value (phone number).

    Queue

    Yes

    String

    The queue name to which the contact belongs to.

    Sample Request

    {
        "channel": "LCM",
        "topic": "WebService",
        "subtopic": "GetReservedContactOD",
        "data": 
        {
            "UserID": "testagent”
        }
    }

    Sample Response

     {
        "channel": "LCM",
        "topic": "WebService",
        "subtopic": "ContactOD",
        "message": 
        {
            "response":
            {
                "PhoneNumber": "9873635",
                "AccountNumber": "137|1|3|0|0|84|1",
                "CampaignId": "SamplePreviewCampaign-ACQ",
                "Mode": "Home",
                "ContactId": "137",
                "ExpiryTime": "Oct 7 2020 11:59PM",
                "CallbackTime": "Oct 7 2020 11:59PM",
                "CallType": "Regular Call",
                "Prefix": "",
                "Suffix": "",
                "Queue": "Queue1"
            }
        }
    }


    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.