Login
    Contents x
    Hold a Call
      • Dark
        Light
      Contents

      Hold a Call

        • Dark
          Light
        Article summary

        Overview

        This API allows an Agent to hold a call that is currently active.

        Pre-requisite

        The agent must be on an active a call.

        Sequence Diagram

        Message Structure

        Request Parameters

        Value

        channel

        Cisco

        topic

        InboundCall or OutboundCall

        subtopic

        SetHOLD

        source

        «app-name-broadcasting-this-message»

        data

        «JSON Object»

        Data Parameters

        Parameter

        Data Type

        Description

        Sample Value

        MediaAddress

        String

        The extension that the user is currently signed in to, used to locate the participant to target with the action request.

        5069

        CallID

        String

        The active connection ID of the user/customer.

        167786021

        Sample Request

        {
    "channel": "Cisco",
    "topic": "InboundCall",
    "subtopic": "SetHOLD",
    "data ": {
        "MediaAddress ": "5069",
        "CallID": "16786021"
    }
}

        Sample Response

        No sample response

        Was this article helpful?
        What's Next
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        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.
        Logout