/public/sip-connections/{sipConnectionConfigurationId}

Authorization

ApiKeyAuth

X-Api-Key<token>

API key for authentication. Passed as a header on every request.

In: header

Path Parameters

sipConnectionConfigurationId*string

Header Parameters

X-API-Version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

agentId?|

name?|

Response Body

curl -X PATCH "https://companion-api.napster.com/public/sip-connections/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "organizationId": "string",
  "projectId": "string",
  "agentId": "string",
  "name": "string",
  "settings": {
    "server": "string",
    "port": 0,
    "domain": "string",
    "username": "string",
    "transport": "string",
    "callerId": "string"
  },
  "status": {
    "lifecycleStatus": "string",
    "sipStatus": "string",
    "message": "string",
    "lastRefreshed": 0
  },
  "created": 0
}

{
  "code": "string",
  "description": "string",
  "type": "failure",
  "numericType": 0
}