Reject Call
    • Dark
      Light

    Reject Call

    • Dark
      Light

    Article summary

    This API allows an Agent to reject an incoming call.

    Pre-requisite

    The agent gets an incoming call and in PendingBusy State.

    Sequence Diagram

    Message Structure

    Request Parameters

    Value

    channel

    Amazon

    topic

    InboundCall

    subtopic

    Reject

    source

    «app-name-broadcasting-this-message»

    Response Parameters

    Value

    channel

    Amazon

    topic

    InboundCall

    subtopic

    InboundCallStateChange

    message

    Refer Call Event Parameters

    Possible Error Codes

    Error Type

    Code

    Message

    DISCONNECT_CALL_FAILED

    Amazon Connect Failure Error Message.

    Disconnecting call failed.

    Sample Request

    {
        "channel": "Amazon",
        "topic": "InboundCall",
        "subtopic": "Reject",
        "source": "myapp"
    }

    Sample Response - Call Type: Agent

    {
        "channel": "Amazon",
        "topic": "InboundCall",
        "subtopic": "InboundCallStateChange",
        "message": {
            "call": {
                "ButtonStates": {
                    "items": {
                        "answer": "Hide",
                        "reject": "Hide",
                        "disconnect": "Hide",
                        "hold": "Hide",
                        "resume": "Hide",
                        "clearContact": "Enable",
                        "consult": "Hide",
                        "numberpad": "Hide",
                        "swap": "Hide",
                        "transfer": "Hide",
                        "conference": "Hide"
                    },
                    "count": 11
                },
                "ActionsAllowed": null,
                "ResponseType": 0,
                "ResponseText": "Success",
                "ResponseActual": {
                    "connectionId": "9519b7b5-c269-4fd3-a5ea-5867010d1230",
                    "contactId": "bcdb2ec7-bca2-423a-bd64-1688c173d529",
                    "phoneNumber": null,
                    "status": "disconnected",
                    "statusTimestamp": "2020-04-09T12:47:28.901Z",
                    "type": "agent",
                    "buttonStates": {
                        "answer": false,
                        "reject": false,
                        "disconnect": false,
                        "hold": false,
                        "resume": false,
                        "clearContact": true,
                        "consult": false,
                        "numberpad": false,
                        "swap": false,
                        "transfer": false,
                        "conference": false
                    },
                    "previousStatus": "connecting"
                },
                "CallVariables": {
                    "ANI": "+161081111",
                    "DNIS": "+16013261548"
                },
                "ExtendedCallVariables": null,
                "ResponseFields": {
                    "Participants": [],
                    "MediaProperties": {
                        "callType": "agent",
                        "queueName": "InboundTest",
                        "queueTimestamp": "2020-04-09T12:47:28.901Z"
                    },
                    "fromAddress": null,
                    "CallState": "REJECTED",
                    "Type": "agent",
                    "CurrentStateTime": "2020-04-09T12:47:28.901Z",
                    "Campaign": "",
                    "DN": "InboundTest"
                },
                "id": "9519b7b5-c269-4fd3-a5ea-5867010d1230",
                "event": "REJECTED",
                "CallType": "agent"
            },
            "source": "event"    }
    }

    Sample Response - Call Type: Inbound

    {
        "channel": "Amazon",
        "topic": "InboundCall",
        "subtopic": "InboundCallStateChange",
        "message": {
            "call": {
                "ButtonStates": {
                    "items": {
                        "answer": "Hide",
                        "reject": "Hide",
                        "disconnect": "Hide",
                        "hold": "Hide",
                        "resume": "Hide",
                        "clearContact": "Hide",
                        "consult": "Hide",
                        "numberpad": "Hide",
                        "swap": "Hide",
                        "transfer": "Hide",
                        "conference": "Hide"
                    },
                    "count": 11
                },
                "ActionsAllowed": null,
                "ResponseType": 0,
                "ResponseText": "Success",
                "ResponseActual": {
                    "connectionId": "bcdb2ec7-bca2-423a-bd64-1688c173d529",
                    "contactId": "bcdb2ec7-bca2-423a-bd64-1688c173d529",
                    "phoneNumber": "+161081111",
                    "status": "connected",
                    "statusTimestamp": "2020-04-09T12:47:22.901Z",
                    "type": "inbound",
                    "buttonStates": {
                        "answer": false,
                        "reject": false,
                        "disconnect": false,
                        "hold": false,
                        "resume": false,
                        "clearContact": false,
                        "consult": false,
                        "numberpad": false,
                        "swap": false,
                        "transfer": false,
                        "conference": false
                    }
                },
                "CallVariables": {
                    "ANI": "+161081111",
                    "DNIS": "+16013261548"
                },
                "ExtendedCallVariables": null,
                "ResponseFields": {
                    "Participants": [],
                    "MediaProperties": {
                        "callType": "inbound",
                        "queueName": "InboundTest",
                        "queueTimestamp": "2020-04-09T12:47:28.901Z"
                    },
                    "fromAddress": "+161081111",
                    "CallState": "REJECTED",
                    "Type": "inbound",
                    "CurrentStateTime": "2020-04-09T12:47:22.901Z",
                    "Campaign": "",
                    "DN": "InboundTest"
                },
                "id": "bcdb2ec7-bca2-423a-bd64-1688c173d529",
                "event": "REJECTED",
                "CallType": "inbound"
            },
            "source": "event"
        }
    }


    Was this article helpful?

    What's Next
    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.