{
  "opencollection": "1.0.0",
  "info": {
    "name": "PureCloud Platform Agent Assistants Telephony API",
    "version": "v2"
  },
  "items": [
    {
      "info": {
        "name": "Telephony",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve the list of AWS regions media can stream through.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/mediaregions"
          },
          "docs": "Retrieve the list of AWS regions media can stream through."
        },
        {
          "info": {
            "name": "Get the global telephony configuration.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/settings"
          },
          "docs": "Get the global telephony configuration."
        },
        {
          "info": {
            "name": "Update the global telephony configuration.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/telephony/settings"
          },
          "docs": "Update the global telephony configuration."
        },
        {
          "info": {
            "name": "Get an agent's greetings.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/agents/:agentId/greetings",
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Get an agent's greetings."
        },
        {
          "info": {
            "name": "Updates an agent's greetings.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/telephony/agents/:agentId/greetings",
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path",
                "description": "User ID"
              }
            ]
          },
          "docs": "Updates an agent's greetings."
        },
        {
          "info": {
            "name": "Get the agent's own greetings.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/agents/greetings/me"
          },
          "docs": "Get the agent's own greetings."
        },
        {
          "info": {
            "name": "Updates the agent's own greetings.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/telephony/agents/greetings/me"
          },
          "docs": "Updates the agent's own greetings."
        },
        {
          "info": {
            "name": "Re-route all numbers on an organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/telephony/numbers/routing/all"
          },
          "docs": "Re-route all numbers on an organization"
        },
        {
          "info": {
            "name": "Get Number Routings by organizationId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/numbers/routing",
            "params": [
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200."
              },
              {
                "name": "numberId",
                "value": "",
                "type": "query",
                "description": "numberId"
              },
              {
                "name": "activeRoutingOrganizationId",
                "value": "",
                "type": "query",
                "description": "activeRoutingOrganizationId"
              },
              {
                "name": "ownerOrganizationId",
                "value": "",
                "type": "query",
                "description": "ownerOrganizationId"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "status"
              }
            ]
          },
          "docs": "Get Number Routings by organizationId"
        },
        {
          "info": {
            "name": "Update the routing of numbers for one or multiple organizations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/telephony/numbers/routing"
          },
          "docs": "Update the routing of numbers for one or multiple organizations"
        },
        {
          "info": {
            "name": "Reset routing for organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/telephony/numbers/routing/reset"
          },
          "docs": "Reset routing for organization"
        },
        {
          "info": {
            "name": "Get organization links",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/organization/link"
          },
          "docs": "Get organization links"
        },
        {
          "info": {
            "name": "Create a link with an organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/telephony/organization/link"
          },
          "docs": "Create a link with an organization"
        },
        {
          "info": {
            "name": "Delete a link",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/telephony/organization/link/:targetOrganizationId",
            "params": [
              {
                "name": "targetOrganizationId",
                "value": "",
                "type": "path",
                "description": "targetOrganizationId"
              }
            ]
          },
          "docs": "Delete a link"
        },
        {
          "info": {
            "name": "Approving a requested link",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/telephony/organization/link/approve/:requestingOrganizationId",
            "params": [
              {
                "name": "requestingOrganizationId",
                "value": "",
                "type": "path",
                "description": "requestingOrganizationId"
              }
            ]
          },
          "docs": "Approving a requested link"
        },
        {
          "info": {
            "name": "Get all the replica regions by primary region",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/organization/link/regions"
          },
          "docs": "Get all the replica regions by primary region"
        },
        {
          "info": {
            "name": "Get SIP headers.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/sipmessages/conversations/:conversationId/headers",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "Conversation id"
              },
              {
                "name": "keys",
                "value": "",
                "type": "query",
                "description": "comma-separated list of header identifiers to query. e.g. ruri,to,from"
              }
            ]
          },
          "docs": "Get parsed SIP headers. Returns specific headers if key query parameters are added."
        },
        {
          "info": {
            "name": "Get a SIP message.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/sipmessages/conversations/:conversationId",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "Conversation id"
              }
            ]
          },
          "docs": "Get the raw form of the SIP message"
        },
        {
          "info": {
            "name": "Get the concurrent call metrics for a given organization.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/calls/metrics",
            "params": [
              {
                "name": "metricType",
                "value": "",
                "type": "query",
                "description": "Flag to indicate metric type to fetch."
              }
            ]
          },
          "docs": "Get the concurrent call metrics for a given organization."
        },
        {
          "info": {
            "name": "Request a download of a pcap file to S3",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/telephony/siptraces/download"
          },
          "docs": "Request a download of a pcap file to S3"
        },
        {
          "info": {
            "name": "Get signed S3 URL for a pcap download",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/siptraces/download/:downloadId",
            "params": [
              {
                "name": "downloadId",
                "value": "",
                "type": "path",
                "description": "unique id for the downloaded file in S3"
              }
            ]
          },
          "docs": "Get signed S3 URL for a pcap download"
        },
        {
          "info": {
            "name": "Fetch SIP metadata",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/telephony/siptraces",
            "params": [
              {
                "name": "callId",
                "value": "",
                "type": "query",
                "description": "unique identification of the placed call"
              },
              {
                "name": "toUser",
                "value": "",
                "type": "query",
                "description": "User to who the call was placed"
              },
              {
                "name": "fromUser",
                "value": "",
                "type": "query",
                "description": "user who placed the call"
              },
              {
                "name": "conversationId",
                "value": "",
                "type": "query",
                "description": "Unique identification of the conversation"
              },
              {
                "name": "dateStart",
                "value": "",
                "type": "query",
                "description": "Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
              },
              {
                "name": "dateEnd",
                "value": "",
                "type": "query",
                "description": "End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
              }
            ]
          },
          "docs": "Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected"
        }
      ]
    }
  ],
  "bundled": true
}