Answer Call
    • Dark
      Light

    Answer Call

    • Dark
      Light

    Article summary

    This API allows an Agent to answer an incoming call.

    Pre-requisite

    The agent gets an incoming call and in PendingBusy State.

    Sequence Diagram

    The following figure illustrates the workflow of answer call failure:

    Message Structure

    Request Parameters

    Value

    channel

    Amazon

    topic

    InboundCall

    subtopic

    Answer

    source

    <<app-name-broadcasting-this-message>>

    Response Parameters

    Value

    channel

    Amazon

    topic

    InboundCall

    subtopic

    InboundCallStateChange

    message

    Refer Call Event Parameters

    Message Parameters

    Parameters

    Data Type

    Description

    Example Data

    label

    String

    Label of agent state.

    Not Ready, Available, Offline

    code

    String

    Given code of agent state.

    Not Ready, Available, Offline

    type

    String

    Type of agent state.

    Not Routable, Routable, Offline

    Possible Error Cases

    Error Type

    Code

    Message

    ANSWER_CALL_FAILED

    Amazon Connect Failure Error Message.

    Answering call failed.

    Sample Request

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

    Sample Response

    {
        "channel": "Amazon",
        "topic": "InboundCall",
        "subtopic": "InboundCallStateChange",
        "message": {
            "call": {
                "ButtonStates": {
                    "items": {
                        "answer": "Hide",
                        "reject": "Hide",
                        "disconnect": "Hide",
                        "hold": "Hide",
                        "resume": "Hide",
                        "clearContact": "Hide",
                        "consult": "Enable",
                        "numberpad": "Enable",
                        "swap": "Hide",
                        "transfer": "Hide",
                        "conference": "Hide"
                    },
                    "count": 11
                },
                "ActionsAllowed": null,
                "ResponseType": 0,
                "ResponseText": "Success",
                "ResponseActual": {
                    "connectionId": "1233dc5f-6d09-4752-85a0-cfca6fc445e7",
                    "contactId": "836c56f3-07c2-418f-99e7-2565b75b575c",
                    "phoneNumber": null,
                    "status": "connected",
                    "statusTimestamp": "2020-04-09T09:14:58.955Z",
                    "type": "agent",
                    "buttonStates": {
                        "answer": false,
                        "reject": false,
                        "disconnect": false,
                        "hold": false,
                        "resume": false,
                        "clearContact": false,
                        "consult": true,
                        "numberpad": true,
                        "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-09T09:14:58.955Z"
                    },
                    "fromAddress": null,
                    "CallState": "connected",
                    "Type": "agent",
                    "CurrentStateTime": "2020-04-09T09:14:58.955Z",
                    "Campaign": "",
                    "DN": "InboundTest"
                },
                "id": "1233dc5f-6d09-4752-85a0-cfca6fc445e7",
                "event": "connected",
                "CallType": "agent"
            },
            "source": "event"
        }
    }


    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.