Service Agent

Mutes the chat for the calling agent: the chat_message notifications of the chat stop. Mentions (chat_mentioned) of the agent in the chat are still delivered. The call is idempotent: muting a muted chat returns 200 with the settings.

The chat must belong to the customer of the calling agent. The agent does not have to be a participant. A chat that does not exist, that belongs to another customer, or that cannot be read is reported identically as 404 CHAT_NOT_FOUND.

The mute stays when the chat is deleted or the agent leaves it; it has no effect then.

put/service_agents/me/push_mutes/{chat_id}

Request

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

Path parameters

chat_idstring uuid required
Example:5d7f9b1c-3e4a-4c68-8a0e-2c4e6a8c0e11

The chat ID returned from GET /service_agents/talk_chats.

Response

The push notification settings after the change.

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