{
  "opencollection": "1.0.0",
  "info": {
    "name": "PureCloud Platform Agent Assistants Voicemail API",
    "version": "v2"
  },
  "items": [
    {
      "info": {
        "name": "Voicemail",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List voicemail messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/groups/:groupId/messages",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Group ID"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              }
            ]
          },
          "docs": "List voicemail messages"
        },
        {
          "info": {
            "name": "List voicemail messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/queues/:queueId/messages",
            "params": [
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "Queue ID"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              }
            ]
          },
          "docs": "List voicemail messages"
        },
        {
          "info": {
            "name": "List voicemail messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/users/:userId/messages",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User ID"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              }
            ]
          },
          "docs": "List voicemail messages"
        },
        {
          "info": {
            "name": "Get a group's voicemail policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/groups/:groupId/policy",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ]
          },
          "docs": "Get a group's voicemail policy"
        },
        {
          "info": {
            "name": "Update a group's voicemail policy",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/voicemail/groups/:groupId/policy",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Group ID"
              }
            ]
          },
          "docs": "Update a group's voicemail policy"
        },
        {
          "info": {
            "name": "Get the current user's mailbox information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/mailbox"
          },
          "docs": "Get the current user's mailbox information"
        },
        {
          "info": {
            "name": "Get the current user's mailbox information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/me/mailbox"
          },
          "docs": "Get the current user's mailbox information"
        },
        {
          "info": {
            "name": "Get the group's mailbox information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/groups/:groupId/mailbox",
            "params": [
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "groupId"
              }
            ]
          },
          "docs": "Get the group's mailbox information"
        },
        {
          "info": {
            "name": "Get a user's mailbox information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/users/:userId/mailbox",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "userId"
              }
            ]
          },
          "docs": "Get a user's mailbox information"
        },
        {
          "info": {
            "name": "List voicemail messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/me/messages",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              }
            ]
          },
          "docs": "List voicemail messages"
        },
        {
          "info": {
            "name": "Get the current user's voicemail policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/me/policy"
          },
          "docs": "Get the current user's voicemail policy"
        },
        {
          "info": {
            "name": "Update the current user's voicemail policy",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/voicemail/me/policy"
          },
          "docs": "Update the current user's voicemail policy"
        },
        {
          "info": {
            "name": "Get a voicemail message",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/messages/:messageId",
            "params": [
              {
                "name": "messageId",
                "value": "",
                "type": "path",
                "description": "Message ID"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "If the caller is a known user, which fields, if any, to expand"
              }
            ]
          },
          "docs": "Get a voicemail message"
        },
        {
          "info": {
            "name": "Update a voicemail message",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/voicemail/messages/:messageId",
            "params": [
              {
                "name": "messageId",
                "value": "",
                "type": "path",
                "description": "Message ID"
              }
            ]
          },
          "docs": "A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with."
        },
        {
          "info": {
            "name": "Update a voicemail message",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/voicemail/messages/:messageId",
            "params": [
              {
                "name": "messageId",
                "value": "",
                "type": "path",
                "description": "Message ID"
              }
            ]
          },
          "docs": "A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with."
        },
        {
          "info": {
            "name": "Delete a voicemail message.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/voicemail/messages/:messageId",
            "params": [
              {
                "name": "messageId",
                "value": "",
                "type": "path",
                "description": "Message ID"
              }
            ]
          },
          "docs": "A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission."
        },
        {
          "info": {
            "name": "Get media playback URI for this voicemail message",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/messages/:messageId/media",
            "params": [
              {
                "name": "messageId",
                "value": "",
                "type": "path",
                "description": "Message ID"
              },
              {
                "name": "formatId",
                "value": "",
                "type": "query",
                "description": "The desired media format."
              }
            ]
          },
          "docs": "API should migrate to use GET api/v2/voicemail/messages/{messageId}/downloads"
        },
        {
          "info": {
            "name": "List voicemail messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/messages",
            "params": [
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "An optional comma separated list of VoicemailMessage ids"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "If the caller is a known user, which fields, if any, to expand"
              }
            ]
          },
          "docs": "List voicemail messages"
        },
        {
          "info": {
            "name": "Copy a voicemail message to a user or group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/voicemail/messages"
          },
          "docs": "Copy a voicemail message to a user or group"
        },
        {
          "info": {
            "name": "Delete all voicemail messages",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/voicemail/messages"
          },
          "docs": "Delete all voicemail messages"
        },
        {
          "info": {
            "name": "Get a policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/policy"
          },
          "docs": "Get a policy"
        },
        {
          "info": {
            "name": "Update a policy",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/voicemail/policy"
          },
          "docs": "Update a policy"
        },
        {
          "info": {
            "name": "Get a user's voicemail policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/userpolicies/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Get a user's voicemail policy"
        },
        {
          "info": {
            "name": "Update a user's voicemail policy",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/voicemail/userpolicies/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Update a user's voicemail policy"
        },
        {
          "info": {
            "name": "Update a user's voicemail policy",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/voicemail/userpolicies/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Update a user's voicemail policy"
        },
        {
          "info": {
            "name": "Search voicemails using the q64 value returned from a previous search",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/voicemail/search",
            "params": [
              {
                "name": "q64",
                "value": "",
                "type": "query",
                "description": "q64"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "expand"
              }
            ]
          },
          "docs": "Search voicemails using the q64 value returned from a previous search"
        },
        {
          "info": {
            "name": "Search voicemails",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/voicemail/search"
          },
          "docs": "Search voicemails"
        }
      ]
    }
  ],
  "bundled": true
}