Programmable SIP API

The Programmable SIP API lets you create and configure Programmable SIP Domains in Vonage's platform.

OpenAPI-Spezifikation herunterladen

Domains

Methods for managing SIP domains.

Verfügbare Operationen

Create a PSIP domain

Create a new PSIP domain.

posthttps://api.nexmo.com/v1/psip/

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Anfrage Körper
Inhalt Typ
application/json

Einer der
name
string
Erforderlich
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

application_id
string
Erforderlich
Beispielc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Standardoptional

Require TLS use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
digest_auth
boolean
Standardfalse

Allow definition of up to 200 users that can use Digest Authentication to access domain.

srtp
string
Standardoptional

Require SRTP use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
acl
array
Erforderlich

Access Control List of IPs that can make calls to domain. Can use CIDR notation to facilitate inclusion of IP ranges.

domain_type
string
Standardapp
Beispielapp

Type of domain. 'app' for PSIP application, 'trunk' for SIP trunking

Muss eines der folgenden sein:apptrunk

Beispiel Anfrage

{
   "name": "mydomain",
   "application_id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
   "tls": "always",
   "digest_auth": false,
   "srtp": "always",
   "acl": [
      "50.127.127.0/29",
      "50.128.128.0/29"
   ],
   "domain_type": "app"
}

Antworten
Inhalt Typ
application/json

Created

name
string
Erforderlich
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

application_id
string
Erforderlich
Beispielc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Standardoptional

Require TLS use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
digest_auth
boolean
Standardfalse

Allow definition of up to 200 users that can use Digest Authentication to access domain.

srtp
string
Standardoptional

Require SRTP use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
acl
array
Erforderlich

Access Control List of IPs that can make calls to domain. Can use CIDR notation to facilitate inclusion of IP ranges.

domain_type
string
Standardapp
Beispielapp

Type of domain. 'app' for PSIP application, 'trunk' for SIP trunking

Muss eines der folgenden sein:apptrunk

Beispiel Antwort

{
   "name": "mydomain",
   "application_id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
   "tls": "always",
   "digest_auth": false,
   "srtp": "always",
   "acl": [
      "50.127.127.0/29",
      "50.128.128.0/29"
   ],
   "domain_type": "app"
}

Get all of your PSIP domains

Get all of your PSIP domains.

gethttps://api.nexmo.com/v1/psip/

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Antworten
Inhalt Typ
application/json

OK

array
name
string
Erforderlich
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

application_id
string
Erforderlich
Beispielc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Standardoptional

Require TLS use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
digest_auth
boolean
Standardfalse

Allow definition of up to 200 users that can use Digest Authentication to access domain.

srtp
string
Standardoptional

Require SRTP use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
acl
array
Erforderlich

Access Control List of IPs that can make calls to domain. Can use CIDR notation to facilitate inclusion of IP ranges.

domain_type
string
Standardapp
Beispielapp

Type of domain. 'app' for PSIP application, 'trunk' for SIP trunking

Muss eines der folgenden sein:apptrunk

Beispiel Antwort

[
   {
      "name": "mydomain",
      "application_id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
      "tls": "always",
      "digest_auth": false,
      "srtp": "always",
      "acl": [
         "50.127.127.0/29",
         "50.128.128.0/29"
      ],
      "domain_type": "app"
   }
]

Get details of your PSIP domain

Get details of your PSIP domain.

gethttps://api.nexmo.com/v1/psip/:domain

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Pfad Parameter

domain
string
Erforderlich
Beispielmydomain

Filter by domain name.

Antworten
Inhalt Typ
application/json

OK

name
string
Erforderlich
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

application_id
string
Erforderlich
Beispielc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Standardoptional

Require TLS use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
digest_auth
boolean
Standardfalse

Allow definition of up to 200 users that can use Digest Authentication to access domain.

srtp
string
Standardoptional

Require SRTP use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
acl
array
Erforderlich

Access Control List of IPs that can make calls to domain. Can use CIDR notation to facilitate inclusion of IP ranges.

domain_type
string
Standardapp
Beispielapp

Type of domain. 'app' for PSIP application, 'trunk' for SIP trunking

Muss eines der folgenden sein:apptrunk

Beispiel Antwort

{
   "name": "mydomain",
   "application_id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
   "tls": "always",
   "digest_auth": false,
   "srtp": "always",
   "acl": [
      "50.127.127.0/29",
      "50.128.128.0/29"
   ],
   "domain_type": "app"
}

Update a PSIP domain

Update a PSIP domain.

puthttps://api.nexmo.com/v1/psip/:domain

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Pfad Parameter

domain
string
Erforderlich
Beispielmydomain

Filter by domain name.

Anfrage Körper
Inhalt Typ
application/json

Einer der
name
string
Erforderlich
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

application_id
string
Erforderlich
Beispielc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Standardoptional

Require TLS use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
digest_auth
boolean
Standardfalse

Allow definition of up to 200 users that can use Digest Authentication to access domain.

srtp
string
Standardoptional

Require SRTP use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
acl
array
Erforderlich

Access Control List of IPs that can make calls to domain. Can use CIDR notation to facilitate inclusion of IP ranges.

domain_type
string
Standardapp
Beispielapp

Type of domain. 'app' for PSIP application, 'trunk' for SIP trunking

Muss eines der folgenden sein:apptrunk

Beispiel Anfrage

{
   "name": "mydomain",
   "application_id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
   "tls": "always",
   "digest_auth": false,
   "srtp": "always",
   "acl": [
      "50.127.127.0/29",
      "50.128.128.0/29"
   ],
   "domain_type": "app"
}

Antworten
Inhalt Typ
application/json

Created

name
string
Erforderlich
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

application_id
string
Erforderlich
Beispielc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Standardoptional

Require TLS use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
digest_auth
boolean
Standardfalse

Allow definition of up to 200 users that can use Digest Authentication to access domain.

srtp
string
Standardoptional

Require SRTP use in SIP connection. Optional allows customer to choose. Always will require it to always be used. Never will require it to never be used.

Muss eines der folgenden sein:alwaysneveroptional
acl
array
Erforderlich

Access Control List of IPs that can make calls to domain. Can use CIDR notation to facilitate inclusion of IP ranges.

domain_type
string
Standardapp
Beispielapp

Type of domain. 'app' for PSIP application, 'trunk' for SIP trunking

Muss eines der folgenden sein:apptrunk

Beispiel Antwort

{
   "name": "mydomain",
   "application_id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
   "tls": "always",
   "digest_auth": false,
   "srtp": "always",
   "acl": [
      "50.127.127.0/29",
      "50.128.128.0/29"
   ],
   "domain_type": "app"
}

Delete PSIP domain

Delete a PSIP domain.

deletehttps://api.nexmo.com/v1/psip/:domain

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Pfad Parameter

domain
string
Erforderlich
Beispielmydomain

Filter by domain name.

Abfrage Parameter

cascade
boolean

Whether the delete request should cascade to the domain's users.

Antworten

Deleted

Domain Users

Methods for managing users in a SIP domain.

Verfügbare Operationen

Create a PSIP domain user

Create a new PSIP domain user, up to 200 per domain.

posthttps://api.nexmo.com/v1/psip/:domain/users

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Anfrage Körper
Inhalt Typ
application/json

Einer der
key
string
Erforderlich
Beispieluser-1

The user's key and unique identifier. Permitted list of characters is alphanumeric (a-z, 0-9) and dash (-).

secret
string
Erforderlich
Beispielmysupersecretsecret

The user's secret to do authentication.

Beispiel Anfrage

{
   "key": "user-1",
   "secret": "mysupersecretsecret"
}

Antworten
Inhalt Typ
application/json

OK

key
string
Beispieluser-1

The user's key and unique identifier. Permitted list of characters is alphanumeric (a-z, 0-9) and dash (-).

domain
string
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

Beispiel Antwort

{
   "key": "user-1",
   "domain": "mydomain"
}

Get all of your PSIP domain's digest users

Retrieve a list of your PSIP domain's digest users.

gethttps://api.nexmo.com/v1/psip/:domain/users

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Antworten
Inhalt Typ
application/json

OK

array
key
string
Beispieluser-1

The user's key and unique identifier. Permitted list of characters is alphanumeric (a-z, 0-9) and dash (-).

domain
string
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

Beispiel Antwort

[
   {
      "key": "user-1",
      "domain": "mydomain"
   },
   {
      "key": "user-0",
      "domain": "mydomain"
   }
]

Check existence of a PSIP domain user

Validate a PSIP domain user.

gethttps://api.nexmo.com/v1/psip/:domain/users/:key

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Antworten
Inhalt Typ
application/json

OK

key
string
Beispieluser-1

The user's key and unique identifier. Permitted list of characters is alphanumeric (a-z, 0-9) and dash (-).

domain
string
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

Beispiel Antwort

{
   "key": "user-1",
   "domain": "mydomain"
}

Update a PSIP domain user

Update a PSIP domain user.

puthttps://api.nexmo.com/v1/psip/:domain/users/:key

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Anfrage Körper
Inhalt Typ
application/json

Einer der
key
string
Erforderlich
Beispieluser-1

The user's key and unique identifier. Permitted list of characters is alphanumeric (a-z, 0-9) and dash (-).

secret
string
Erforderlich
Beispielmysupersecretsecret

The user's secret to do authentication.

Beispiel Anfrage

{
   "key": "user-1",
   "secret": "mysupersecretsecret"
}

Antworten
Inhalt Typ
application/json

OK

key
string
Beispieluser-1

The user's key and unique identifier. Permitted list of characters is alphanumeric (a-z, 0-9) and dash (-).

domain
string
Min5
Max32
Beispielmydomain

The customised SIP domain that will used in Programmable SIP: mydomain.sip-eu.nexmo.com.

Beispiel Antwort

{
   "key": "user-1",
   "domain": "mydomain"
}

Delete a PSIP domain user

Delete a PSIP domain user.

deletehttps://api.nexmo.com/v1/psip/:domain/users/:key

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Antworten

OK

Domain Endpoints

Methods for managing endpoints in a SIP domain.

Verfügbare Operationen

Create an endpoint for a PSIP domain

Create a new PSIP domain endpoint

posthttps://api.nexmo.com/v1/psip/:domain/endpoints

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Anfrage Körper
Inhalt Typ
application/json

Einer der
id
string

The unique id of the endpoint in this domain.

priority
integer
Max100

The priority of this endpoint when sending calls to one of the domain's endpoints. A numeric value where a lower value means higher priority.

uri
string
Erforderlich
Beispielsip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Beispiel Anfrage

{
   "id": "string",
   "priority": 100,
   "uri": "sip:myendpoint@mydomain.example.com:5060"
}

Antworten

OK

Get all of your PSIP domain's endpoint

Retrieve a list of your PSIP domain's endpoints

gethttps://api.nexmo.com/v1/psip/:domain/endpoints

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Antworten
Inhalt Typ
application/json

OK

array
id
string

The unique id of the endpoint in this domain.

priority
integer
Max100

The priority of this endpoint when sending calls to one of the domain's endpoints. A numeric value where a lower value means higher priority.

uri
string
Erforderlich
Beispielsip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Beispiel Antwort

[
   {
      "id": "string",
      "priority": 100,
      "uri": "sip:myendpoint@mydomain.example.com:5060"
   }
]

Check existence of a PSIP domain endpoint

Validate a PSIP domain endpoint

gethttps://api.nexmo.com/v1/psip/:domain/endpoints/:endpointId

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Antworten
Inhalt Typ
application/json

OK

id
string

The unique id of the endpoint in this domain.

priority
integer
Max100

The priority of this endpoint when sending calls to one of the domain's endpoints. A numeric value where a lower value means higher priority.

uri
string
Erforderlich
Beispielsip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Beispiel Antwort

{
   "id": "string",
   "priority": 100,
   "uri": "sip:myendpoint@mydomain.example.com:5060"
}

Update a PSIP domain endpoint

Update a PSIP domain endpoint

puthttps://api.nexmo.com/v1/psip/:domain/endpoints/:endpointId

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Anfrage Körper
Inhalt Typ
application/json

Einer der
id
string

The unique id of the endpoint in this domain.

priority
integer
Max100

The priority of this endpoint when sending calls to one of the domain's endpoints. A numeric value where a lower value means higher priority.

uri
string
Erforderlich
Beispielsip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Beispiel Anfrage

{
   "id": "string",
   "priority": 100,
   "uri": "sip:myendpoint@mydomain.example.com:5060"
}

Antworten
Inhalt Typ
application/json

OK

id
string

The unique id of the endpoint in this domain.

priority
integer
Max100

The priority of this endpoint when sending calls to one of the domain's endpoints. A numeric value where a lower value means higher priority.

uri
string
Erforderlich
Beispielsip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Beispiel Antwort

{
   "id": "string",
   "priority": 100,
   "uri": "sip:myendpoint@mydomain.example.com:5060"
}

Delete a PSIP domain endpoint

Delete a PSIP domain endpoint

deletehttps://api.nexmo.com/v1/psip/:domain/endpoints/:endpointId

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Antworten

OK