Programmable SIP API

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

Baixar a especificação OpenAPI

Domains

Methods for managing SIP domains.

Operações disponíveis

Create a PSIP domain

Create a new PSIP domain.

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Corpo da solicitação
Tipo de conteúdo
application/json

Um dos
name
string
Obrigatório
Mín.5
Max32
exemplomydomain

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

application_id
string
Obrigatório
exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
digest_auth
boolean
Padrãofalse

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

srtp
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
acl
array
Obrigatório

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

domain_type
string
Padrãoapp
exemploapp

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

Deve ser uma das seguintes opções:apptrunk

Exemplo Solicitação

{
   "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"
}
{
   "name": "mydomain",
   "application_id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
   "acl": [
      "50.127.127.0/29",
      "50.128.128.0/29"
   ]
}

Respostas
Tipo de conteúdo
application/json

Created

name
string
Obrigatório
Mín.5
Max32
exemplomydomain

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

application_id
string
Obrigatório
exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
digest_auth
boolean
Padrãofalse

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

srtp
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
acl
array
Obrigatório

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

domain_type
string
Padrãoapp
exemploapp

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

Deve ser uma das seguintes opções:apptrunk

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Respostas
Tipo de conteúdo
application/json

OK

array
name
string
Obrigatório
Mín.5
Max32
exemplomydomain

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

application_id
string
Obrigatório
exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
digest_auth
boolean
Padrãofalse

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

srtp
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
acl
array
Obrigatório

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

domain_type
string
Padrãoapp
exemploapp

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

Deve ser uma das seguintes opções:apptrunk

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Caminho Parâmetros

domain
string
Obrigatório
exemplomydomain

Filter by domain name.

Respostas
Tipo de conteúdo
application/json

OK

name
string
Obrigatório
Mín.5
Max32
exemplomydomain

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

application_id
string
Obrigatório
exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
digest_auth
boolean
Padrãofalse

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

srtp
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
acl
array
Obrigatório

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

domain_type
string
Padrãoapp
exemploapp

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

Deve ser uma das seguintes opções:apptrunk

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Caminho Parâmetros

domain
string
Obrigatório
exemplomydomain

Filter by domain name.

Corpo da solicitação
Tipo de conteúdo
application/json

Um dos
name
string
Obrigatório
Mín.5
Max32
exemplomydomain

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

application_id
string
Obrigatório
exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
digest_auth
boolean
Padrãofalse

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

srtp
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
acl
array
Obrigatório

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

domain_type
string
Padrãoapp
exemploapp

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

Deve ser uma das seguintes opções:apptrunk

Exemplo Solicitação

{
   "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"
}
{
   "name": "mydomain",
   "application_id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
   "acl": [
      "50.127.127.0/29",
      "50.128.128.0/29"
   ]
}

Respostas
Tipo de conteúdo
application/json

Created

name
string
Obrigatório
Mín.5
Max32
exemplomydomain

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

application_id
string
Obrigatório
exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Application ID to associate with the domain.

tls
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
digest_auth
boolean
Padrãofalse

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

srtp
string
Padrãooptional

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.

Deve ser uma das seguintes opções:alwaysneveroptional
acl
array
Obrigatório

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

domain_type
string
Padrãoapp
exemploapp

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

Deve ser uma das seguintes opções:apptrunk

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Caminho Parâmetros

domain
string
Obrigatório
exemplomydomain

Filter by domain name.

Consulta Parâmetros

cascade
boolean

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

Respostas

Deleted

Domain Users

Methods for managing users in a SIP domain.

Operações disponíveis

Create a PSIP domain user

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

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Corpo da solicitação
Tipo de conteúdo
application/json

Um dos
key
string
Obrigatório
exemplouser-1

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

secret
string
Obrigatório
exemplomysupersecretsecret

The user's secret to do authentication.

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

OK

key
string
exemplouser-1

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

domain
string
Mín.5
Max32
exemplomydomain

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

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Respostas
Tipo de conteúdo
application/json

OK

array
key
string
exemplouser-1

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

domain
string
Mín.5
Max32
exemplomydomain

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

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Respostas
Tipo de conteúdo
application/json

OK

key
string
exemplouser-1

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

domain
string
Mín.5
Max32
exemplomydomain

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

Exemplo Resposta

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

Update a PSIP domain user

Update a PSIP domain user.

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Corpo da solicitação
Tipo de conteúdo
application/json

Um dos
key
string
Obrigatório
exemplouser-1

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

secret
string
Obrigatório
exemplomysupersecretsecret

The user's secret to do authentication.

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

OK

key
string
exemplouser-1

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

domain
string
Mín.5
Max32
exemplomydomain

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

Exemplo Resposta

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

Delete a PSIP domain user

Delete a PSIP domain user.

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Respostas

OK

Domain Endpoints

Methods for managing endpoints in a SIP domain.

Operações disponíveis

Create an endpoint for a PSIP domain

Create a new PSIP domain endpoint

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Corpo da solicitação
Tipo de conteúdo
application/json

Um dos
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
Obrigatório
exemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemplo Solicitação

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

Respostas

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Respostas
Tipo de conteúdo
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
Obrigatório
exemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Respostas
Tipo de conteúdo
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
Obrigatório
exemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Corpo da solicitação
Tipo de conteúdo
application/json

Um dos
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
Obrigatório
exemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
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
Obrigatório
exemplosip:myendpoint@mydomain.example.com:5060

A SIP URI to deliver incoming calls for this domain.

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Respostas

OK