# Retrieve a SIP Endpoint

GET https://YOUR_SPACE.signalwire.com/api/relay/rest/endpoints/sip/{id}

Retrieves the details of a SIP endpoint.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/relay-rest/sip-endpoints/retrieve-sip-endpoint

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: relay-rest
  version: 1.0.0
paths:
  /endpoints/sip/{id}:
    get:
      operationId: retrieve-sip-endpoint
      summary: Retrieve a SIP Endpoint
      description: >-
        Retrieves the details of a SIP endpoint.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Voice_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_sipEndpoints
      parameters:
        - name: id
          in: path
          description: Unique ID of the SIP endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipEndpointResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/relay/rest
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    SipEndpointResponseEncryption:
      type: string
      enum:
        - default
        - required
        - optional
      description: >-
        Whether connections to this endpoint require encryption or if encryption
        is optional.
      title: SipEndpointResponseEncryption
    SipEndpointCallHandler:
      type: string
      enum:
        - relay_context
        - relay_topic
        - relay_application
        - relay_connector
        - relay_script
        - laml_webhooks
        - laml_application
        - dialogflow
        - video_room
        - call_flow
        - ai_agent
      description: Call handler type for SIP endpoints.
      title: SipEndpointCallHandler
    SipEndpointResponseCallRequestMethod:
      type: string
      enum:
        - GET
        - POST
      description: >-
        A string representing the HTTP method to use with call_request_url.
        Valid values are GET and POST.
      title: SipEndpointResponseCallRequestMethod
    SipEndpointResponseCallFallbackMethod:
      type: string
      enum:
        - GET
        - POST
      description: >-
        A string representing the HTTP method to use with call_fallback_url.
        Valid values are GET and POST.
      title: SipEndpointResponseCallFallbackMethod
    SipEndpointResponseCallStatusCallbackMethod:
      type: string
      enum:
        - GET
        - POST
      description: >-
        A string representing the HTTP method to use with
        call_status_callback_url. Valid values are GET and POST.
      title: SipEndpointResponseCallStatusCallbackMethod
    SipEndpointResponse:
      type: object
      properties:
        type:
          type: string
          description: A string representation of the type of object this record is.
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier of the SIP endpoint.
        username:
          type: string
          description: The username for the SIP endpoint.
        caller_id:
          type:
            - string
            - 'null'
          description: >-
            Friendly Caller ID used as the CNAM when dialing a phone number or
            the From when dialing another SIP Endpoint.
        send_as:
          type: string
          description: >-
            When dialing a PSTN phone number, you must send it From a number you
            have purchased or verified. send_as indicates which number this
            endpoint has set as its origination. random indicates it will
            randomly choose a purchased or verified number from within the
            project.
        ciphers:
          type: array
          items:
            type: string
          description: A list of encryption ciphers this endpoint will support.
        codecs:
          type: array
          items:
            type: string
          description: A list of codecs this endpoint will support.
        encryption:
          $ref: '#/components/schemas/SipEndpointResponseEncryption'
          description: >-
            Whether connections to this endpoint require encryption or if
            encryption is optional.
        call_handler:
          oneOf:
            - $ref: '#/components/schemas/SipEndpointCallHandler'
            - type: 'null'
          description: What type of handler you want to run on inbound calls.
        calling_handler_resource_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: The unique identifier of the calling handler resource.
        call_request_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing the LaML URL to access when a call is
            received. This is only used (and required) when call_handler is set
            to laml_webhooks.
        call_request_method:
          oneOf:
            - $ref: '#/components/schemas/SipEndpointResponseCallRequestMethod'
            - type: 'null'
          description: >-
            A string representing the HTTP method to use with call_request_url.
            Valid values are GET and POST.
        call_fallback_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing the LaML URL to access when the call to
            call_request_url fails. This is only used (and required) when
            call_handler is set to laml_webhooks.
        call_fallback_method:
          oneOf:
            - $ref: '#/components/schemas/SipEndpointResponseCallFallbackMethod'
            - type: 'null'
          description: >-
            A string representing the HTTP method to use with call_fallback_url.
            Valid values are GET and POST.
        call_status_callback_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing a URL to send status change messages to. This
            is only used (and required) when call_handler is set to
            laml_webhooks.
        call_status_callback_method:
          oneOf:
            - $ref: '#/components/schemas/SipEndpointResponseCallStatusCallbackMethod'
            - type: 'null'
          description: >-
            A string representing the HTTP method to use with
            call_status_callback_url. Valid values are GET and POST.
        call_laml_application_id:
          type:
            - string
            - 'null'
          description: >-
            A string representing the ID of the LaML application to forward
            incoming calls to. This is only used (and required) when
            call_handler is set to laml_application.
        call_dialogflow_agent_id:
          type:
            - string
            - 'null'
          description: >-
            A string representing the ID of the Dialogflow agent to forward
            incoming calls to. This is only used (and required) when
            call_handler is set to dialogflow.
        call_relay_topic:
          type:
            - string
            - 'null'
          description: >-
            A string representing the Relay topic to forward incoming calls to.
            This is only used (and required) when call_handler is set to
            relay_topic.
        call_relay_topic_status_callback_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing a URL to send status change messages to. This
            is only used (and required) when call_handler is set to relay_topic.
        call_relay_context:
          type:
            - string
            - 'null'
          description: >-
            A string representing the Relay context to forward incoming calls
            to. This is only used (and required) when call_handler is set to
            relay_context.
        call_relay_context_status_callback_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing a URL to send status change messages to. This
            is only used (and required) when call_handler is set to
            relay_context.
        call_relay_application:
          type:
            - string
            - 'null'
          description: >-
            A string representing the Relay application to forward incoming
            calls to. This is only used (and required) when call_handler is set
            to relay_application.
        call_video_room_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: >-
            A string representing the ID of the Video Room to forward incoming
            calls to. This is only used (and required) when call_handler is set
            to video_room.
        call_relay_script_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing a URL of a SWML script to respond to incoming
            calls. This is only used (and required) when call_handler is set to
            relay_script.
      required:
        - type
        - id
        - username
        - caller_id
        - send_as
        - ciphers
        - codecs
        - encryption
        - call_handler
        - calling_handler_resource_id
        - call_request_url
        - call_request_method
        - call_fallback_url
        - call_fallback_method
        - call_status_callback_url
        - call_status_callback_method
        - call_laml_application_id
        - call_dialogflow_agent_id
        - call_relay_topic
        - call_relay_topic_status_callback_url
        - call_relay_context
        - call_relay_context_status_callback_url
        - call_relay_application
        - call_video_room_id
        - call_relay_script_url
      description: Response containing a single SIP endpoint.
      title: SipEndpointResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    Types.StatusCodes.SpaceApiErrorItem:
      type: object
      properties:
        detail:
          type: string
          description: A description of what caused the error.
        status:
          type: string
          description: The HTTP status code.
        title:
          type: string
          description: A short summary of the error type.
        code:
          type: string
          description: The error code.
      required:
        - detail
        - status
        - title
        - code
      description: Details about a specific validation error.
      title: Types.StatusCodes.SpaceApiErrorItem
    Types.StatusCodes.ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.SpaceApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request failed validation. See errors for details.
      title: Types.StatusCodes.ValidationError
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/relay/rest/endpoints/sip/id"

headers = {"Authorization": "Basic <project_id>:<api_token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/relay/rest/endpoints/sip/id';
const options = {method: 'GET', headers: {Authorization: 'Basic <project_id>:<api_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_space.signalwire.com/api/relay/rest/endpoints/sip/id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your_space.signalwire.com/api/relay/rest/endpoints/sip/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://your_space.signalwire.com/api/relay/rest/endpoints/sip/id")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your_space.signalwire.com/api/relay/rest/endpoints/sip/id', [
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/relay/rest/endpoints/sip/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Basic <project_id>:<api_token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/relay/rest/endpoints/sip/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```