Cisco Voice Portal SIP Sessions API

Monitor SIP session details

Operations 2

GET /sip/session Cisco Voice Portal List Active Sip Sessions #
GET /sip/session/{sessionId} Cisco Voice Portal Get Sip Session Details #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cisco-voice-portal-sip-sessions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cisco-voice-portal-sip-sessions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cisco Voice Portal Call Control SIP Sessions API
  description: The Cisco Unified Customer Voice Portal (CVP) Call Control API provides programmatic access to call control functions on the CVP Call Server.
  version: 12.6.0
  contact:
    name: Cisco Developer Support
    url: https://developer.cisco.com/
  license:
    name: Cisco DevNet
    url: https://developer.cisco.com/site/license/
  x-provider: cisco
  x-product: unified-customer-voice-portal
servers:
- url: https://{call-server}:8000/cvp/rest
  description: CVP Call Server REST management interface
  variables:
    call-server:
      default: cvp-callserver.example.com
      description: Hostname or IP of the CVP Call Server
security:
- basicAuth: []
tags:
- name: SIP Sessions
  description: Monitor SIP session details
paths:
  /sip/session:
    get:
      operationId: listSipSessions
      summary: Cisco Voice Portal List Active Sip Sessions
      description: Retrieves information about active SIP sessions (dialogs) on the Call Server. Each SIP session corresponds to an active call leg.
      tags:
      - SIP Sessions
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: Active SIP sessions
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalSessions:
                    type: integer
                  sessions:
                    type: array
                    items:
                      $ref: '#/components/schemas/SipSession'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sip/session/{sessionId}:
    get:
      operationId: getSipSession
      summary: Cisco Voice Portal Get Sip Session Details
      description: Retrieves detailed SIP session information including SIP headers, dialog state, and associated call GUID.
      tags:
      - SIP Sessions
      parameters:
      - name: sessionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: SIP session details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipSessionDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Session not found
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        details:
          type: string
          example: example_value
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    SipSession:
      type: object
      properties:
        sessionId:
          type: string
          example: '500123'
        callId:
          type: string
          description: SIP Call-ID
          example: '500123'
        callGuid:
          type: string
          description: Associated CVP call GUID
          example: '500123'
        state:
          type: string
          enum:
          - initial
          - early
          - confirmed
          - terminated
          example: initial
        method:
          type: string
          description: Initial SIP method (INVITE)
          example: example_value
        fromUri:
          type: string
          example: example_value
        toUri:
          type: string
          example: example_value
        startTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    SipSessionDetail:
      type: object
      properties:
        sessionId:
          type: string
          example: '500123'
        callId:
          type: string
          example: '500123'
        callGuid:
          type: string
          example: '500123'
        state:
          type: string
          example: example_value
        fromUri:
          type: string
          example: example_value
        toUri:
          type: string
          example: example_value
        fromTag:
          type: string
          example: example_value
        toTag:
          type: string
          example: example_value
        cseq:
          type: integer
          example: 10
        transport:
          type: string
          enum:
          - UDP
          - TCP
          - TLS
          example: UDP
        localAddress:
          type: string
          example: example_value
        remoteAddress:
          type: string
          example: example_value
        startTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        lastActivityTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
  responses:
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using CVP Call Server credentials