Programmable SIP API

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

Télécharger la spécification OpenAPI

Domains

Methods for managing SIP domains.

Opérations disponibles

Create a PSIP domain

Create a new PSIP domain.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Corps de la demande
Type de contenu
application/json

L'un des
name
string
Exigée
Min5
Max32
exemplemydomain

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

application_id
string
Exigée
exemplec49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
digest_auth
boolean
Défautfalse

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

srtp
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
acl
array
Exigée

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

domain_type
string
Défautapp
exempleapp

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

Il doit s'agir de l'un d'entre eux :apptrunk

Exemple Demande

{
   "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"
}

Réponses
Type de contenu
application/json

Created

name
string
Exigée
Min5
Max32
exemplemydomain

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

application_id
string
Exigée
exemplec49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
digest_auth
boolean
Défautfalse

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

srtp
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
acl
array
Exigée

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

domain_type
string
Défautapp
exempleapp

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

Il doit s'agir de l'un d'entre eux :apptrunk

Exemple Réponse

{
   "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/

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Réponses
Type de contenu
application/json

OK

array
name
string
Exigée
Min5
Max32
exemplemydomain

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

application_id
string
Exigée
exemplec49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
digest_auth
boolean
Défautfalse

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

srtp
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
acl
array
Exigée

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

domain_type
string
Défautapp
exempleapp

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

Il doit s'agir de l'un d'entre eux :apptrunk

Exemple Réponse

[
   {
      "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

domain
string
Exigée
exemplemydomain

Filter by domain name.

Réponses
Type de contenu
application/json

OK

name
string
Exigée
Min5
Max32
exemplemydomain

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

application_id
string
Exigée
exemplec49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
digest_auth
boolean
Défautfalse

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

srtp
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
acl
array
Exigée

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

domain_type
string
Défautapp
exempleapp

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

Il doit s'agir de l'un d'entre eux :apptrunk

Exemple Réponse

{
   "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

domain
string
Exigée
exemplemydomain

Filter by domain name.

Corps de la demande
Type de contenu
application/json

L'un des
name
string
Exigée
Min5
Max32
exemplemydomain

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

application_id
string
Exigée
exemplec49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
digest_auth
boolean
Défautfalse

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

srtp
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
acl
array
Exigée

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

domain_type
string
Défautapp
exempleapp

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

Il doit s'agir de l'un d'entre eux :apptrunk

Exemple Demande

{
   "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"
}

Réponses
Type de contenu
application/json

Created

name
string
Exigée
Min5
Max32
exemplemydomain

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

application_id
string
Exigée
exemplec49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
digest_auth
boolean
Défautfalse

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

srtp
string
Défautoptional

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.

Il doit s'agir de l'un d'entre eux :alwaysneveroptional
acl
array
Exigée

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

domain_type
string
Défautapp
exempleapp

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

Il doit s'agir de l'un d'entre eux :apptrunk

Exemple Réponse

{
   "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

domain
string
Exigée
exemplemydomain

Filter by domain name.

Demande de renseignements Paramètres

cascade
boolean

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

Réponses

Deleted

Domain Users

Methods for managing users in a SIP domain.

Opérations disponibles

Create a PSIP domain user

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

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Corps de la demande
Type de contenu
application/json

L'un des
key
string
Exigée
exempleuser-1

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

secret
string
Exigée
exemplemysupersecretsecret

The user's secret to do authentication.

Exemple Demande

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

Réponses
Type de contenu
application/json

OK

key
string
exempleuser-1

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

domain
string
Min5
Max32
exemplemydomain

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

Exemple Réponse

{
   "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Réponses
Type de contenu
application/json

OK

array
key
string
exempleuser-1

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

domain
string
Min5
Max32
exemplemydomain

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

Exemple Réponse

[
   {
      "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Réponses
Type de contenu
application/json

OK

key
string
exempleuser-1

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

domain
string
Min5
Max32
exemplemydomain

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

Exemple Réponse

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

Update a PSIP domain user

Update a PSIP domain user.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Corps de la demande
Type de contenu
application/json

L'un des
key
string
Exigée
exempleuser-1

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

secret
string
Exigée
exemplemysupersecretsecret

The user's secret to do authentication.

Exemple Demande

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

Réponses
Type de contenu
application/json

OK

key
string
exempleuser-1

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

domain
string
Min5
Max32
exemplemydomain

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

Exemple Réponse

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

Delete a PSIP domain user

Delete a PSIP domain user.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Réponses

OK

Domain Endpoints

Methods for managing endpoints in a SIP domain.

Opérations disponibles

Create an endpoint for a PSIP domain

Create a new PSIP domain endpoint

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Corps de la demande
Type de contenu
application/json

L'un des
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
Exigée
exemplesip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemple Demande

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

Réponses

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Réponses
Type de contenu
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
Exigée
exemplesip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemple Réponse

[
   {
      "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Réponses
Type de contenu
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
Exigée
exemplesip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemple Réponse

{
   "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Corps de la demande
Type de contenu
application/json

L'un des
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
Exigée
exemplesip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemple Demande

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

Réponses
Type de contenu
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
Exigée
exemplesip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemple Réponse

{
   "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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Réponses

OK