Vonage QoD

Quality of Service on Demand API leveraging carrier QoS capabilities

Baixar a especificação OpenAPI

QoD Sessions

QoD session management services

Operações disponíveis

Create a QoD session

Enables applications to create a QoD session. The session represents the network flow(s) from the mobile device to the specified server(s) and the QoD profile(s) that will be applied to the network.

posthttps://api-eu.vonage.com/qod/v0.1/sessions

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token JSON da Web.
Saiba mais sobre os JWTs

Headers

Bearer <JWT>

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

msisdn
string
Obrigatório
Mín.10
Max15
exemplo14040000000

A single phone number you want insights on, starting with the country code. You may optionally include a leading +, but do not use 00 at the beginning. Ideally, the number should follow the E.164 format. However, the API is designed to extract the phone number even if the input string contains alphanumeric characters, spaces, or symbols like brackets.

source_ip
string
Obrigatório
exemplo192.158.1.38

IP address of the device, in IPv4 or IPv6 format. Note: not all mobile operators support both formats.

duration
integer
Obrigatório
Mín.60
Max86400
exemplo60

The requested session duration in seconds.

channels
array
Obrigatório
source
object
Obrigatório

The source endpoint of the network flow.

port
integer(int32)
Mín.1
Max65535
destination
object
Obrigatório

The destination endpoint of the network flow.

cidr
string
Obrigatório
exemplo2002::1234:abcd:ffff:c0a8:101/64

CIDR notation for IPv4 or IPv6 address ranges. Note: not all mobile operators support both formats.

port
integer(int32)
Mín.1
Max65535
qod_profile
string
Obrigatório

The QoD profile configures the flow in the network adapting network characteristics, for example throughput, latency, or jitter.

Exemplo Solicitação

{
   "msisdn": "14040000000",
   "source_ip": "192.158.1.38",
   "duration": 60,
   "channels": [
      {
         "source": {
            "port": 1
         },
         "destination": {
            "cidr": "2002::1234:abcd:ffff:c0a8:101/64",
            "port": 1
         },
         "qod_profile": "string"
      }
   ]
}
{
   "msisdn": "14040000000",
   "source_ip": "192.158.1.38",
   "duration": 60,
   "channels": [
      {
         "source": {},
         "destination": {
            "cidr": "2002::1234:abcd:ffff:c0a8:101/64"
         },
         "qod_profile": "string"
      }
   ]
}

Respostas
Tipo de conteúdo
application/json

QoD session created

id
string
Obrigatório

Unique identifier for each QoD session.

msisdn
string
Obrigatório
Mín.10
Max15
exemplo14040000000

A single phone number you want insights on, starting with the country code. You may optionally include a leading +, but do not use 00 at the beginning. Ideally, the number should follow the E.164 format. However, the API is designed to extract the phone number even if the input string contains alphanumeric characters, spaces, or symbols like brackets.

source_ip
string
Obrigatório
exemplo192.158.1.38

IP address of the device, in IPv4 or IPv6 format. Note: not all mobile operators support both formats.

duration
integer
Obrigatório
Mín.60
Max86400
exemplo60

The requested session duration in seconds.

channels
array
Obrigatório
source
object
Obrigatório

The source endpoint of the network flow.

port
integer(int32)
Mín.1
Max65535
destination
object
Obrigatório

The destination endpoint of the network flow.

cidr
string
Obrigatório
exemplo2002::1234:abcd:ffff:c0a8:101/64

CIDR notation for IPv4 or IPv6 address ranges. Note: not all mobile operators support both formats.

port
integer(int32)
Mín.1
Max65535
qod_profile
string
Obrigatório

The QoD profile configures the flow in the network adapting network characteristics, for example throughput, latency, or jitter.

projected_end_time
string(date-time)

ISO 8601 date-time in UTC

statuses
array
status
string
Obrigatório

|- PENDING. The QoD session has not yet been processed by the underlying network. ACTIVE. The QoD session is active, the QoD profile is being applied to the network flow. CANCELLING. The QoD session is in the process of being cancelled, but has not yet reached a terminal state. COMPLETED. The QoD session has completed successfully. FAILED. The QoD session has completed but due to failure, see the reason for more details.

Deve ser uma das seguintes opções:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Obrigatório

The timestamp of the status update

reason
string

The reason why the status update occurred.

Exemplo Resposta

{
   "id": "string",
   "msisdn": "14040000000",
   "source_ip": "192.158.1.38",
   "duration": 60,
   "channels": [
      {
         "source": {
            "port": 1
         },
         "destination": {
            "cidr": "2002::1234:abcd:ffff:c0a8:101/64",
            "port": 1
         },
         "qod_profile": "string",
         "projected_end_time": "2019-08-24T14:15:22Z",
         "statuses": [
            {
               "status": "PENDING",
               "updated": "2019-08-24T14:15:22Z",
               "reason": "string"
            }
         ]
      }
   ]
}

QoD session status update callback callback

Provides updates on the status of the QoD session.

posthttps://example.com/webhooks/event

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

id
string
Obrigatório

The identifier of the QoD session that has been updated.

update
object
Obrigatório
status
string
Obrigatório

|- PENDING. The QoD session has not yet been processed by the underlying network. ACTIVE. The QoD session is active, the QoD profile is being applied to the network flow. CANCELLING. The QoD session is in the process of being cancelled, but has not yet reached a terminal state. COMPLETED. The QoD session has completed successfully. FAILED. The QoD session has completed but due to failure, see the reason for more details.

Deve ser uma das seguintes opções:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Obrigatório

The timestamp of the status update

reason
string

The reason why the status update occurred.

projected_end_time
string(date-time)

ISO 8601 date-time in UTC

Exemplo Carga útil

{
   "id": "string",
   "update": {
      "status": "PENDING",
      "updated": "2019-08-24T14:15:22Z",
      "reason": "string"
   },
   "projected_end_time": "2019-08-24T14:15:22Z"
}

Respostas

Return this code if the server accepts the callback.

Query QoD sessions

Enables applications to create a QoD session. The session represents the network flow(s) from the mobile device to the specified server(s) and the QoD profile(s) that will be applied to the network.

posthttps://api-eu.vonage.com/qod/v0.1/sessions/query

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token JSON da Web.
Saiba mais sobre os JWTs

Headers

Bearer <JWT>

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

msisdn
string
Mín.10
Max15
exemplo14040000000

A single phone number you want insights on, starting with the country code. You may optionally include a leading +, but do not use 00 at the beginning. Ideally, the number should follow the E.164 format. However, the API is designed to extract the phone number even if the input string contains alphanumeric characters, spaces, or symbols like brackets.

filter
string
Padrãoin-progress

If set to in-progress, only in-progress sessions (e.g. PENDING, ACTIVE, CANCELLING) will be returned; otherwise all sessions will be returned.

Deve ser uma das seguintes opções:in-progressall

Exemplo Solicitação

{
   "msisdn": "14040000000",
   "filter": "in-progress"
}
{}

Respostas
Tipo de conteúdo
application/json

QoD session query response

array
id
string
Obrigatório

Unique identifier for each QoD session.

msisdn
string
Obrigatório
Mín.10
Max15
exemplo14040000000

A single phone number you want insights on, starting with the country code. You may optionally include a leading +, but do not use 00 at the beginning. Ideally, the number should follow the E.164 format. However, the API is designed to extract the phone number even if the input string contains alphanumeric characters, spaces, or symbols like brackets.

source_ip
string
Obrigatório
exemplo192.158.1.38

IP address of the device, in IPv4 or IPv6 format. Note: not all mobile operators support both formats.

duration
integer
Obrigatório
Mín.60
Max86400
exemplo60

The requested session duration in seconds.

channels
array
Obrigatório
source
object
Obrigatório

The source endpoint of the network flow.

port
integer(int32)
Mín.1
Max65535
destination
object
Obrigatório

The destination endpoint of the network flow.

cidr
string
Obrigatório
exemplo2002::1234:abcd:ffff:c0a8:101/64

CIDR notation for IPv4 or IPv6 address ranges. Note: not all mobile operators support both formats.

port
integer(int32)
Mín.1
Max65535
qod_profile
string
Obrigatório

The QoD profile configures the flow in the network adapting network characteristics, for example throughput, latency, or jitter.

projected_end_time
string(date-time)

ISO 8601 date-time in UTC

statuses
array
status
string
Obrigatório

|- PENDING. The QoD session has not yet been processed by the underlying network. ACTIVE. The QoD session is active, the QoD profile is being applied to the network flow. CANCELLING. The QoD session is in the process of being cancelled, but has not yet reached a terminal state. COMPLETED. The QoD session has completed successfully. FAILED. The QoD session has completed but due to failure, see the reason for more details.

Deve ser uma das seguintes opções:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Obrigatório

The timestamp of the status update

reason
string

The reason why the status update occurred.

Exemplo Resposta

[
   {
      "id": "string",
      "msisdn": "14040000000",
      "source_ip": "192.158.1.38",
      "duration": 60,
      "channels": [
         {
            "source": {
               "port": 1
            },
            "destination": {
               "cidr": "2002::1234:abcd:ffff:c0a8:101/64",
               "port": 1
            },
            "qod_profile": "string",
            "projected_end_time": "2019-08-24T14:15:22Z",
            "statuses": [
               {
                  "status": "PENDING",
                  "updated": "2019-08-24T14:15:22Z",
                  "reason": "string"
               }
            ]
         }
      ]
   }
]

Get QoD session by identifier

Enables applications to retrieve detailed information about a specific session.

gethttps://api-eu.vonage.com/qod/v0.1/sessions/:session_id

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token JSON da Web.
Saiba mais sobre os JWTs

Headers

Bearer <JWT>

Caminho Parâmetros

session_id
string
Obrigatório

The unique identifier for the QoD session

Respostas
Tipo de conteúdo
application/json

QoD session for the specified identifier

id
string
Obrigatório

Unique identifier for each QoD session.

msisdn
string
Obrigatório
Mín.10
Max15
exemplo14040000000

A single phone number you want insights on, starting with the country code. You may optionally include a leading +, but do not use 00 at the beginning. Ideally, the number should follow the E.164 format. However, the API is designed to extract the phone number even if the input string contains alphanumeric characters, spaces, or symbols like brackets.

source_ip
string
Obrigatório
exemplo192.158.1.38

IP address of the device, in IPv4 or IPv6 format. Note: not all mobile operators support both formats.

duration
integer
Obrigatório
Mín.60
Max86400
exemplo60

The requested session duration in seconds.

channels
array
Obrigatório
source
object
Obrigatório

The source endpoint of the network flow.

port
integer(int32)
Mín.1
Max65535
destination
object
Obrigatório

The destination endpoint of the network flow.

cidr
string
Obrigatório
exemplo2002::1234:abcd:ffff:c0a8:101/64

CIDR notation for IPv4 or IPv6 address ranges. Note: not all mobile operators support both formats.

port
integer(int32)
Mín.1
Max65535
qod_profile
string
Obrigatório

The QoD profile configures the flow in the network adapting network characteristics, for example throughput, latency, or jitter.

projected_end_time
string(date-time)

ISO 8601 date-time in UTC

statuses
array
status
string
Obrigatório

|- PENDING. The QoD session has not yet been processed by the underlying network. ACTIVE. The QoD session is active, the QoD profile is being applied to the network flow. CANCELLING. The QoD session is in the process of being cancelled, but has not yet reached a terminal state. COMPLETED. The QoD session has completed successfully. FAILED. The QoD session has completed but due to failure, see the reason for more details.

Deve ser uma das seguintes opções:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Obrigatório

The timestamp of the status update

reason
string

The reason why the status update occurred.

Exemplo Resposta

{
   "id": "string",
   "msisdn": "14040000000",
   "source_ip": "192.158.1.38",
   "duration": 60,
   "channels": [
      {
         "source": {
            "port": 1
         },
         "destination": {
            "cidr": "2002::1234:abcd:ffff:c0a8:101/64",
            "port": 1
         },
         "qod_profile": "string",
         "projected_end_time": "2019-08-24T14:15:22Z",
         "statuses": [
            {
               "status": "PENDING",
               "updated": "2019-08-24T14:15:22Z",
               "reason": "string"
            }
         ]
      }
   ]
}

Cancel a QoD session

Enables applications to request the cancellation of a QoD session.

deletehttps://api-eu.vonage.com/qod/v0.1/sessions/:session_id

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Seu token JSON da Web.
Saiba mais sobre os JWTs

Headers

Bearer <JWT>

Caminho Parâmetros

session_id
string
Obrigatório

The unique identifier for the QoD session

Respostas

Session cancellation request accepted

QoD status update callback callback

Provides updates on the status of the QoD session.

posthttps://example.com/webhooks/event

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

id
string
Obrigatório

The identifier of the QoD session that has been updated.

update
object
Obrigatório
status
string
Obrigatório

|- PENDING. The QoD session has not yet been processed by the underlying network. ACTIVE. The QoD session is active, the QoD profile is being applied to the network flow. CANCELLING. The QoD session is in the process of being cancelled, but has not yet reached a terminal state. COMPLETED. The QoD session has completed successfully. FAILED. The QoD session has completed but due to failure, see the reason for more details.

Deve ser uma das seguintes opções:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Obrigatório

The timestamp of the status update

reason
string

The reason why the status update occurred.

projected_end_time
string(date-time)

ISO 8601 date-time in UTC

Exemplo Carga útil

{
   "id": "string",
   "update": {
      "status": "PENDING",
      "updated": "2019-08-24T14:15:22Z",
      "reason": "string"
   },
   "projected_end_time": "2019-08-24T14:15:22Z"
}

Respostas

Return this code if the server accepts the callback.