{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Features:  Paging Group API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Features:  Paging Group",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Read the List of Paging Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/telephony/config/paging",
            "params": [
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "List paging groups for this organization."
              },
              {
                "name": "max",
                "value": "5",
                "type": "query",
                "description": "Limit the number of objects returned to this maximum count. Default is 2000"
              },
              {
                "name": "start",
                "value": "0",
                "type": "query",
                "description": "Start at the zero-based offset in the list of matching objects. Default is 0"
              },
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
                "type": "query",
                "description": "Return only paging groups with matching location ID. Default is all locations"
              },
              {
                "name": "name",
                "value": "PagingGroup",
                "type": "query",
                "description": "Return only paging groups with the matching name."
              },
              {
                "name": "phoneNumber",
                "value": "+15558675309",
                "type": "query",
                "description": "Return only paging groups with matching primary phone number or extension."
              }
            ]
          },
          "docs": "List all Paging Groups for the organization.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
        },
        {
          "info": {
            "name": "Create a new Paging Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/paging",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
                "type": "path",
                "description": "Create the paging group for this location."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Create the paging group for this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Paging Group for the given location.\n\nGroup Paging allows a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nCreating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
        },
        {
          "info": {
            "name": "Get Details for a Paging Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/paging/:pagingId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
                "type": "path",
                "description": "Retrieve settings for a paging group in this location."
              },
              {
                "name": "pagingId",
                "value": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE",
                "type": "path",
                "description": "Retrieve settings for the paging group with this identifier."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Retrieve paging group settings from this organization."
              }
            ]
          },
          "docs": "Retrieve Paging Group details.\n\nGroup Paging allows a person, place or virtual line a one-way call or group page to up to 75 people and/or workspaces and/or virtual line by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nRetrieving paging group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
        },
        {
          "info": {
            "name": "Update a Paging Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/paging/:pagingId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
                "type": "path",
                "description": "Update settings for a paging group in this location."
              },
              {
                "name": "pagingId",
                "value": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE",
                "type": "path",
                "description": "Update settings for the paging group with this identifier."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Update paging group settings from this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the designated Paging Group.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nUpdating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
        },
        {
          "info": {
            "name": "Delete a Paging Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/paging/:pagingId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Location from which to delete a paging group."
              },
              {
                "name": "pagingId",
                "value": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE",
                "type": "path",
                "description": "Delete the paging group with the matching ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Delete the paging group from this organization."
              }
            ]
          },
          "docs": "Delete the designated Paging Group.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nDeleting a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
        },
        {
          "info": {
            "name": "Get Paging Group Primary Available Phone Numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/paging/availableNumbers",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg",
                "type": "path",
                "description": "Return the list of phone numbers for this location within the given organization. The maximum length is 36."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "List numbers for this organization."
              },
              {
                "name": "max",
                "value": "5",
                "type": "query",
                "description": "Limit the number of phone numbers returned to this maximum count. The default is 2000."
              },
              {
                "name": "start",
                "value": "0",
                "type": "query",
                "description": "Start at the zero-based offset in the list of matching phone numbers. The default is 0."
              },
              {
                "name": "phoneNumber",
                "value": "+12056852221,+12056852222",
                "type": "query",
                "description": "Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array."
              }
            ]
          },
          "docs": "List the service and standard PSTN numbers that are available to be assigned as the paging group's primary phone number.\nThese numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.\n\nThe available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features.\n\nRetrieving this list requires a full, read-only or location administrator auth token "
        }
      ]
    }
  ],
  "bundled": true
}