Bandwidth · Schema

SipPeer

A SIP peer (location) within a site

CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Properties

Name Type Description
peerId string The unique identifier for the SIP peer
peerName string The name of the SIP peer
description string A description of the SIP peer
isDefaultPeer boolean Whether this is the default SIP peer for the site
View JSON Schema on GitHub

JSON Schema

phone-numbers-sip-peer-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-schema/phone-numbers-sip-peer-schema.json",
  "title": "SipPeer",
  "description": "A SIP peer (location) within a site",
  "type": "object",
  "properties": {
    "peerId": {
      "type": "string",
      "description": "The unique identifier for the SIP peer"
    },
    "peerName": {
      "type": "string",
      "description": "The name of the SIP peer"
    },
    "description": {
      "type": "string",
      "description": "A description of the SIP peer"
    },
    "isDefaultPeer": {
      "type": "boolean",
      "description": "Whether this is the default SIP peer for the site"
    }
  }
}