> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goyappr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get SIP Endpoint



## OpenAPI

````yaml GET /sip-endpoints/{id}
openapi: 3.1.0
info:
  title: Yappr API
  description: >
    Create and manage AI voice agents, purchase phone numbers, configure tools,
    and initiate calls — all via REST.
  version: 1.0.0
  contact:
    url: https://goyappr.com
servers:
  - url: https://api.goyappr.com
    description: Production
security:
  - apiKey: []
paths:
  /sip-endpoints/{id}:
    get:
      tags:
        - SIP Endpoints
      summary: Get SIP endpoint
      operationId: getSipEndpoint
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: SIP endpoint detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SipEndpoint'
        '404':
          description: SIP endpoint not found
components:
  schemas:
    SipEndpoint:
      type: object
      description: |
        A BYOC SIP endpoint. Customers paste the returned `sip_uri` into their
        own telephony system — calls dialed to that URI are routed to the
        Yappr agent identified by `inbound_agent_id`. No authentication is
        required at the SIP layer; the slug embedded in the URI is the
        bearer credential.

        Security model: the slug includes ~120 bits of entropy in its random
        suffix, so guessing is intractable. Treat the full URI like an API
        key — anyone with it can dial the agent. To revoke access, delete the
        endpoint (which makes the URI immediately return 404) and create a
        new one.

        Optional defense in depth: set `allowed_source_ips` to restrict which
        source IPs (or CIDRs) can reach the endpoint. Calls from any other
        source are rejected pre-answer.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: After-hours
        slug:
          type: string
          description: |
            SIP URI user-part. Server generates ~120 bits of entropy in a
            24-char random suffix, prefixed with a 1–12 char human-readable
            stub derived from `name` (or the `slug` value supplied in the
            request, if any). Example: `after-hours-bz3r3mtypuwuw8tpdw3x392s`.
          example: after-hours-bz3r3mtypuwuw8tpdw3x392s
        inbound_agent_id:
          type: string
          format: uuid
        is_active:
          type: boolean
        last_call_at:
          type: string
          format: date-time
          nullable: true
        allowed_source_ips:
          type: array
          nullable: true
          description: |
            Optional list of CIDRs / IPs allowed to dial this endpoint. `null`
            (default) accepts any source. Useful when the customer's PBX has
            a fixed egress IP.
          items:
            type: string
            example: 203.0.113.0/24
        sip_uri:
          type: string
          description: |
            Full SIP URI customers dial. This is what gets pasted into their
            telephony platform's outbound route — nothing else (no username,
            no password).
          example: sip:after-hours-bz3r3mtypuwuw8tpdw3x392s@yappr-byoc.sip.telnyx.com
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Your Yappr API key (e.g. `ypr_live_...`). Generate one in the dashboard
        under **Settings → API Keys**.

````