{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Features:  Call Pickup API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Features:  Call Pickup",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Read the List of Call Pickups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Return the list of call pickups for this location."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "List call pickups for this organization."
              },
              {
                "name": "max",
                "value": "5",
                "type": "query",
                "description": "Limit the number of call pickups 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 call pickups. Default is 0."
              },
              {
                "name": "order",
                "value": "ASC",
                "type": "query",
                "description": "Sort the list of call pickups by name, either ASC or DSC. Default is ASC."
              },
              {
                "name": "name",
                "value": "Alaska-Group",
                "type": "query",
                "description": "Return the list of call pickups that contains the given name. The maximum length is 80."
              }
            ]
          },
          "docs": "List all Call Pickups for the organization.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\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`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
        },
        {
          "info": {
            "name": "Create a Call Pickup",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
                "type": "path",
                "description": "Create the call pickup for this location."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Create the call pickup for this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create new Call Pickups for the given location.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nCreating a call pickup requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
        },
        {
          "info": {
            "name": "Get Details for a Call Pickup",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups/:callPickupId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
                "type": "path",
                "description": "Retrieve settings for a call pickup in this location."
              },
              {
                "name": "callPickupId",
                "value": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0",
                "type": "path",
                "description": "Retrieve settings for a call pickup with the matching ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Retrieve call pickup settings from this organization."
              }
            ]
          },
          "docs": "Retrieve the designated Call Pickup details.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nRetrieving call pickup details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
        },
        {
          "info": {
            "name": "Update a Call Pickup",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups/:callPickupId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
                "type": "path",
                "description": "Location in which this call pickup exists."
              },
              {
                "name": "callPickupId",
                "value": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0",
                "type": "path",
                "description": "Update settings for a call pickup with the matching ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Update call pickup settings from this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the designated Call Pickup.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nUpdating a call pickup requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
        },
        {
          "info": {
            "name": "Delete a Call Pickup",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups/:callPickupId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Location from which to delete a call pickup."
              },
              {
                "name": "callPickupId",
                "value": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0",
                "type": "path",
                "description": "Delete the call pickup with the matching ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Delete the call pickup from this organization."
              }
            ]
          },
          "docs": "Delete the designated Call Pickup.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nDeleting a call pickup requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
        },
        {
          "info": {
            "name": "Get available agents from Call Pickups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups/availableUsers",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
                "type": "path",
                "description": "Return the available agents for this location."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Return the available agents for this organization."
              },
              {
                "name": "callPickupName",
                "value": "North Alaska-Pickup",
                "type": "query",
                "description": "Only return available agents from call pickups with the matching name."
              },
              {
                "name": "max",
                "value": "5",
                "type": "query",
                "description": "Limit the number of available agents returned to this maximum count."
              },
              {
                "name": "start",
                "value": "0",
                "type": "query",
                "description": "Start at the zero-based offset in the list of matching available agents."
              },
              {
                "name": "name",
                "value": "John",
                "type": "query",
                "description": "Only return available agents with the matching name."
              },
              {
                "name": "phoneNumber",
                "value": "9075552334",
                "type": "query",
                "description": "Only return available agents with the matching primary number."
              },
              {
                "name": "order",
                "value": "lname|fname|number",
                "type": "query",
                "description": "Order the available agents according to the designated fields. Up to three vertical bar (|) separated sort order fields may be specified. Available sort fields: `fname`, `lname`, `extension`, `number`."
              }
            ]
          },
          "docs": "Retrieve available agents from call pickups for a given location.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nRetrieving available agents from call pickups requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
        }
      ]
    }
  ],
  "bundled": true
}