Set Phone Mode

Article summary

Did you find this summary helpful?

Thank you for your feedback

This API allows a user to set phone mode to either a Softphone or Desk phone.

The Agent must be in the LoggedIn state.

Request Parameters	Value
channel	Amazon
topic	Agent
subtopic	SetPhoneMode
source	<<app-name-broadcasting-this-message>>
data	JSON Object

Parameters	Data Type	Description	Example Data
type	String	Phone type.	Softphone or Desk Phone.
extension	JSON Object	Deskphone number in E.164 format.

Error Type	Code	Message
SET_PHONE_MODE	Amazon Connect Failure Error Message.	Failed to set phone mode.

{
    "channel": "Amazon",
    "topic": "Agent",
    "subTopic": "SetPhoneMode",
    "source": "myapp"
}

{
    "channel": "Amazon",
    "topic": "Agent",
    "subtopic": "SetPhoneModeSuccess",
    "message": null
}

Was this article helpful?

Table of contents