Switch push notification kinds
Changed onSwitches push notification kinds on (true) or off (false) for the calling agent and returns the settings after the change. A kind that is not in kinds is not changed, and an empty kinds changes nothing. The call is idempotent: sending the same body again gives the same result.
The kinds that can be switched are chat_mentioned, chat_message, conversation_message, case_assigned and case_note. Any other key, including the incoming call kinds, is rejected with 400 (INVALID_KIND) before anything is changed.
The kinds are written one by one. When a write fails, the call returns a 5xx error and the kinds written before the failure stay changed; send the same request again to finish the change.
A muted chat does not silence chat_mentioned: a mention is always delivered while that kind is on. An agent who switched chat_mentioned off gets no notification for a message that mentions him, even when chat_message is on.
Request
- Base URLhttps://api.voipbin.net/v1.0
- Authnone declared
Request body
Example request
{
"kinds": {
"chat_message": false,
"case_note": false
}
}Response
The push notification settings after the change.
Example response
{
"kinds": {
"chat_mentioned": true,
"chat_message": false,
"conversation_message": true,
"case_assigned": true,
"case_note": false
},
"muted_chat_ids": [
"5d7f9b1c-3e4a-4c68-8a0e-2c4e6a8c0e11"
]
}Changes
- info
endpoint added
- info