Programmable SIP API

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

Descargar la especificación OpenAPI

Domains

Methods for managing SIP domains.

Operaciones disponibles

Create a PSIP domain

Create a new PSIP domain.

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de
name
string
Requerido
Min5
Max32
ejemplomydomain

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

application_id
string
Requerido
ejemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
digest_auth
boolean
Por defectofalse

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

srtp
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
acl
array
Requerido

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

domain_type
string
Por defectoapp
ejemploapp

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

Debe ser uno de:apptrunk

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

Created

name
string
Requerido
Min5
Max32
ejemplomydomain

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

application_id
string
Requerido
ejemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
digest_auth
boolean
Por defectofalse

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

srtp
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
acl
array
Requerido

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

domain_type
string
Por defectoapp
ejemploapp

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

Debe ser uno de:apptrunk

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Respuestas
Tipo de contenido
application/json

OK

array
name
string
Requerido
Min5
Max32
ejemplomydomain

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

application_id
string
Requerido
ejemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
digest_auth
boolean
Por defectofalse

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

srtp
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
acl
array
Requerido

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

domain_type
string
Por defectoapp
ejemploapp

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

Debe ser uno de:apptrunk

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Ruta Parámetros

domain
string
Requerido
ejemplomydomain

Filter by domain name.

Respuestas
Tipo de contenido
application/json

OK

name
string
Requerido
Min5
Max32
ejemplomydomain

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

application_id
string
Requerido
ejemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
digest_auth
boolean
Por defectofalse

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

srtp
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
acl
array
Requerido

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

domain_type
string
Por defectoapp
ejemploapp

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

Debe ser uno de:apptrunk

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Ruta Parámetros

domain
string
Requerido
ejemplomydomain

Filter by domain name.

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de
name
string
Requerido
Min5
Max32
ejemplomydomain

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

application_id
string
Requerido
ejemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
digest_auth
boolean
Por defectofalse

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

srtp
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
acl
array
Requerido

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

domain_type
string
Por defectoapp
ejemploapp

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

Debe ser uno de:apptrunk

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

Created

name
string
Requerido
Min5
Max32
ejemplomydomain

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

application_id
string
Requerido
ejemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
digest_auth
boolean
Por defectofalse

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

srtp
string
Por defectooptional

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.

Debe ser uno de:alwaysneveroptional
acl
array
Requerido

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

domain_type
string
Por defectoapp
ejemploapp

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

Debe ser uno de:apptrunk

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Ruta Parámetros

domain
string
Requerido
ejemplomydomain

Filter by domain name.

Consulta Parámetros

cascade
boolean

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

Respuestas

Deleted

Domain Users

Methods for managing users in a SIP domain.

Operaciones 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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de
key
string
Requerido
ejemplouser-1

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

secret
string
Requerido
ejemplomysupersecretsecret

The user's secret to do authentication.

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

OK

key
string
ejemplouser-1

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

domain
string
Min5
Max32
ejemplomydomain

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

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Respuestas
Tipo de contenido
application/json

OK

array
key
string
ejemplouser-1

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

domain
string
Min5
Max32
ejemplomydomain

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

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Respuestas
Tipo de contenido
application/json

OK

key
string
ejemplouser-1

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

domain
string
Min5
Max32
ejemplomydomain

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

Ejemplo Respuesta

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

Update a PSIP domain user

Update a PSIP domain user.

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de
key
string
Requerido
ejemplouser-1

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

secret
string
Requerido
ejemplomysupersecretsecret

The user's secret to do authentication.

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

OK

key
string
ejemplouser-1

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

domain
string
Min5
Max32
ejemplomydomain

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

Ejemplo Respuesta

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

Delete a PSIP domain user

Delete a PSIP domain user.

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Respuestas

OK

Domain Endpoints

Methods for managing endpoints in a SIP domain.

Operaciones disponibles

Create an endpoint for a PSIP domain

Create a new PSIP domain endpoint

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de
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
Requerido
ejemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Ejemplo Solicitar

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

Respuestas

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Respuestas
Tipo de contenido
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
Requerido
ejemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Respuestas
Tipo de contenido
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
Requerido
ejemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de
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
Requerido
ejemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
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
Requerido
ejemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Respuestas

OK