Vonage QoD

Quality of Service on Demand API leveraging carrier QoS capabilities

Descargar la especificación OpenAPI

QoD Sessions

QoD session management services

Operaciones disponibles

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Su token web JSON.
Más información sobre los JWT

Headers

Bearer <JWT>

Cuerpo de la solicitud
Tipo de contenido
application/json

msisdn
string
Requerido
Min10
Max15
ejemplo14040000000

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
Requerido
ejemplo192.158.1.38

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

duration
integer
Requerido
Min60
Max86400
ejemplo60

The requested session duration in seconds.

channels
array
Requerido
source
object
Requerido

The source endpoint of the network flow.

port
integer(int32)
Min1
Max65535
destination
object
Requerido

The destination endpoint of the network flow.

cidr
string
Requerido
ejemplo2002::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)
Min1
Max65535
qod_profile
string
Requerido

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

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

QoD session created

id
string
Requerido

Unique identifier for each QoD session.

msisdn
string
Requerido
Min10
Max15
ejemplo14040000000

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
Requerido
ejemplo192.158.1.38

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

duration
integer
Requerido
Min60
Max86400
ejemplo60

The requested session duration in seconds.

channels
array
Requerido
source
object
Requerido

The source endpoint of the network flow.

port
integer(int32)
Min1
Max65535
destination
object
Requerido

The destination endpoint of the network flow.

cidr
string
Requerido
ejemplo2002::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)
Min1
Max65535
qod_profile
string
Requerido

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
Requerido

|- 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.

Debe ser uno de:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Requerido

The timestamp of the status update

reason
string

The reason why the status update occurred.

Ejemplo Respuesta

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

Cuerpo de la solicitud
Tipo de contenido
application/json

id
string
Requerido

The identifier of the QoD session that has been updated.

update
object
Requerido
status
string
Requerido

|- 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.

Debe ser uno de:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Requerido

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

Ejemplo Carga útil

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

Respuestas

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Su token web JSON.
Más información sobre los JWT

Headers

Bearer <JWT>

Cuerpo de la solicitud
Tipo de contenido
application/json

msisdn
string
Min10
Max15
ejemplo14040000000

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
Por defectoin-progress

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

Debe ser uno de:in-progressall

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

QoD session query response

array
id
string
Requerido

Unique identifier for each QoD session.

msisdn
string
Requerido
Min10
Max15
ejemplo14040000000

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
Requerido
ejemplo192.158.1.38

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

duration
integer
Requerido
Min60
Max86400
ejemplo60

The requested session duration in seconds.

channels
array
Requerido
source
object
Requerido

The source endpoint of the network flow.

port
integer(int32)
Min1
Max65535
destination
object
Requerido

The destination endpoint of the network flow.

cidr
string
Requerido
ejemplo2002::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)
Min1
Max65535
qod_profile
string
Requerido

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
Requerido

|- 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.

Debe ser uno de:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Requerido

The timestamp of the status update

reason
string

The reason why the status update occurred.

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Su token web JSON.
Más información sobre los JWT

Headers

Bearer <JWT>

Ruta Parámetros

session_id
string
Requerido

The unique identifier for the QoD session

Respuestas
Tipo de contenido
application/json

QoD session for the specified identifier

id
string
Requerido

Unique identifier for each QoD session.

msisdn
string
Requerido
Min10
Max15
ejemplo14040000000

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
Requerido
ejemplo192.158.1.38

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

duration
integer
Requerido
Min60
Max86400
ejemplo60

The requested session duration in seconds.

channels
array
Requerido
source
object
Requerido

The source endpoint of the network flow.

port
integer(int32)
Min1
Max65535
destination
object
Requerido

The destination endpoint of the network flow.

cidr
string
Requerido
ejemplo2002::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)
Min1
Max65535
qod_profile
string
Requerido

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
Requerido

|- 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.

Debe ser uno de:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Requerido

The timestamp of the status update

reason
string

The reason why the status update occurred.

Ejemplo Respuesta

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Su token web JSON.
Más información sobre los JWT

Headers

Bearer <JWT>

Ruta Parámetros

session_id
string
Requerido

The unique identifier for the QoD session

Respuestas

Session cancellation request accepted

QoD status update callback callback

Provides updates on the status of the QoD session.

posthttps://example.com/webhooks/event

Cuerpo de la solicitud
Tipo de contenido
application/json

id
string
Requerido

The identifier of the QoD session that has been updated.

update
object
Requerido
status
string
Requerido

|- 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.

Debe ser uno de:PENDINGACTIVECANCELLINGCOMPLETEDFAILED
updated
string(date-time)
Requerido

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

Ejemplo Carga útil

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

Respuestas

Return this code if the server accepts the callback.