Service Agent

Get the push notification settings

Changed on

Returns which push notification kinds the calling agent receives and which chats the agent muted. The settings always belong to the authenticated agent. Everything is on and nothing is muted until the agent changes it, so an agent who never changed anything gets every kind as true and an empty muted_chat_ids.

The kinds that can be switched are chat_mentioned, chat_message, conversation_message, case_assigned and case_note. Incoming call notifications cannot be switched off and are not part of the settings.

get/service_agents/me/push_settings

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • Auth
    none declared

Response

The push notification settings of the calling agent.

kindsobject required

Every kind the agent can switch with true for on and false for off: chat_mentioned, chat_message, conversation_message, case_assigned and case_note.

muted_chat_idsstring[] required

The chats the agent muted, the oldest mute first. Empty when no chat is muted.

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