API Reference
API Reference

Create Organization Sip Ip Range

Create an unverified SIP signaling/media IP range for the current organization.

POST/api/v1/organizations/sip_ip_ranges/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Request body

application/json

body OrganizationSipIpRangeCreate required
2 fields
typeenum<string>required

The SIP IP range type

Allowed values ["signaling","media"]
ip_rangestring (ipv4network) | string (ipv6network)required

The SIP IP range in CIDR notation

2 options
Option 1string (ipv4network)required
Option 2string (ipv6network)required
Request example
{
  "type": "string",
  "ip_range": "string"
}

Responses

201Successful Response

application/json

response OrganizationSipIpRange required
8 fields
typeenum<string>required

The SIP IP range type

Allowed values ["signaling","media"]
ip_rangestring (ipv4network) | string (ipv6network)required

The SIP IP range in CIDR notation

2 options
Option 1string (ipv4network)required
Option 2string (ipv6network)required
idintegerrequired

The organization SIP IP range ID

organization_idintegerrequired

The Organization ID

verifiedbooleanrequired

Whether Syllable has verified this SIP IP range.Verification implies that the Syllable team has updated the firewall rules on the SBCs, confirmed traffic is correctly established from/to the customer network and calls to Syllable agents are working.

created_atstring (date-time) | nulloptional

The timestamp when the range was created

updated_atstring (date-time) | nulloptional

The timestamp when the range was last updated

deleted_atstring (date-time) | nulloptional

The timestamp when the IP was deleted

Response example
{
  "type": "string",
  "ip_range": "string",
  "id": 0,
  "organization_id": 0,
  "verified": true,
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}