Vonage Traffic Control API

Versión 1

API for activating or deactivating the Vonage Traffic Control (VTC) service for supported products and for checking the current VTC status. For more infomation, see our developer documentation

Descargar la especificación OpenAPI

Traffic Control

Operaciones disponibles

Get VTC activation status for the product

Returns the current activation status of the Vonage Traffic Control (VTC) service for the specified product.

gethttps://api.nexmo.com/vtc/v1/configuration/product/:product_name

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

product_name
string
Requerido

The product name for which the VTC service is being managed. Only supported products are allowed.

Debe ser uno de:sms

Respuestas
Tipo de contenido
application/json

The current VTC activation status for the specified product.

Cabecera Parámetros
X-Request-Id
string(uuid)
ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
_embedded
object
Requerido
data
object

Object representing the activated/deactivated status of the Vonage Traffic Control (VTC) service.

status
string
Requerido
ejemploACTIVATED

Indicates whether the VTC service is activated (ACTIVATED) or deactivated (DEACTIVATED) for the product.

Debe ser uno de:ACTIVATEDDEACTIVATED
_links
object
Requerido

HAL Links object

self
object
Requerido

A single HAL link object

href
string
Requerido
ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
ejemploapplication/json

Media type hint for the target resource

name
string
ejemploresource-name

Secondary key for selecting link objects

title
string
ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

{
   "_embedded": {
      "data": {
         "status": "ACTIVATED"
      }
   },
   "_links": {
      "self": {
         "href": "https://api.vonage.com/v1/resources/abc123",
         "templated": false,
         "type": "application/json",
         "name": "resource-name",
         "title": "Resource Title"
      }
   }
}

Activate VTC for the product

Activates the Vonage Traffic Control (VTC) service for the specified product.

posthttps://api.nexmo.com/vtc/v1/configuration/product/:product_name/activate

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

product_name
string
Requerido

The product name for which the VTC service is being managed. Only supported products are allowed.

Debe ser uno de:sms

Respuestas
Tipo de contenido
application/json

A HAL response with a relative link to check the resource status.

Cabecera Parámetros
X-Request-Id
string(uuid)
ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
_embedded
object
Requerido
data
object

Object representing the activated/deactivated status of the Vonage Traffic Control (VTC) service.

status
string
Requerido
ejemploACTIVATED

Indicates whether the VTC service is activated (ACTIVATED) or deactivated (DEACTIVATED) for the product.

Debe ser uno de:ACTIVATEDDEACTIVATED
_links
object
Requerido

HAL Links object

self
object
Requerido

A single HAL link object

href
string
Requerido
ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
ejemploapplication/json

Media type hint for the target resource

name
string
ejemploresource-name

Secondary key for selecting link objects

title
string
ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

{
   "_embedded": {
      "data": {
         "status": "ACTIVATED"
      }
   },
   "_links": {
      "self": {
         "href": "https://api.vonage.com/v1/resources/abc123",
         "templated": false,
         "type": "application/json",
         "name": "resource-name",
         "title": "Resource Title"
      }
   }
}

Deactivate VTC for the product

Deactivates the Vonage Traffic Control (VTC) service for the specified product.

posthttps://api.nexmo.com/vtc/v1/configuration/product/:product_name/deactivate

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

product_name
string
Requerido

The product name for which the VTC service is being managed. Only supported products are allowed.

Debe ser uno de:sms

Respuestas
Tipo de contenido
application/json

A HAL response with a relative link to check the resource status.

Cabecera Parámetros
X-Request-Id
string(uuid)
ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
_embedded
object
Requerido
data
object

Object representing the activated/deactivated status of the Vonage Traffic Control (VTC) service.

status
string
Requerido
ejemploACTIVATED

Indicates whether the VTC service is activated (ACTIVATED) or deactivated (DEACTIVATED) for the product.

Debe ser uno de:ACTIVATEDDEACTIVATED
_links
object
Requerido

HAL Links object

self
object
Requerido

A single HAL link object

href
string
Requerido
ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
ejemploapplication/json

Media type hint for the target resource

name
string
ejemploresource-name

Secondary key for selecting link objects

title
string
ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

{
   "_embedded": {
      "data": {
         "status": "ACTIVATED"
      }
   },
   "_links": {
      "self": {
         "href": "https://api.vonage.com/v1/resources/abc123",
         "templated": false,
         "type": "application/json",
         "name": "resource-name",
         "title": "Resource Title"
      }
   }
}

Retrieve the current queue size

Retrieves the current queue size for the Vonage Traffic Control (VTC) service for the specified product.

gethttps://api.nexmo.com/vtc/v1/queues/product/:product_name/current

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

product_name
string
Requerido

The product name for which the VTC service is being managed. Only supported products are allowed.

Debe ser uno de:sms

Respuestas
Tipo de contenido
application/json

The current queue size for the specified product.

Cabecera Parámetros
X-Request-Id
string(uuid)
ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
_embedded
object
Requerido
data
object

Object representing the current queue size for the VTC service.

queue_size
integer
Requerido
ejemplo100

The current number of messages in the queue.

_links
object
Requerido

HAL Links object

self
object
Requerido

A single HAL link object

href
string
Requerido
ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
ejemploapplication/json

Media type hint for the target resource

name
string
ejemploresource-name

Secondary key for selecting link objects

title
string
ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

{
   "_embedded": {
      "data": {
         "queue_size": 100
      }
   },
   "_links": {
      "self": {
         "href": "https://api.vonage.com/v1/resources/abc123",
         "templated": false,
         "type": "application/json",
         "name": "resource-name",
         "title": "Resource Title"
      }
   }
}

Retrieve historical queue size data

Retrieves historical queue size data for the Vonage Traffic Control (VTC) service for the specified product over a specified date range.

gethttps://api.nexmo.com/vtc/v1/queues/product/:product_name/historical

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

product_name
string
Requerido

The product name for which the VTC service is being managed. Only supported products are allowed.

Debe ser uno de:sms

Consulta Parámetros

start_date
string(date-time)
ejemplo2024-06-12T15:59:22.870Z

The date at which the returned dataset should start in ISO8601 format.

end_date
string(date-time)
ejemplo2024-06-12T15:59:42.870Z

The date at which the returned dataset should end in ISO8601 format.

Respuestas
Tipo de contenido
application/json

Historical queue size data for the specified product over a specified date range.

Cabecera Parámetros
X-Request-Id
string(uuid)
ejemplof94b4e56-604e-07e5-e5ad-5a7228618f81
A unique identifier for the request, used for tracking and debugging
_embedded
object
Requerido
historical_data
array

Array of historical queue size data points.

queue_size
integer
Requerido
ejemplo30

The queue size at a specific point in time.

timestamp
string(date-time)
Requerido
ejemplo2024-06-12T15:59:22.870Z

The timestamp of when the queue size was recorded.

_links
object
Requerido

HAL Links object

self
object
Requerido

A single HAL link object

href
string
Requerido
ejemplohttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated
boolean

Indicates if the href is a URI template

type
string
ejemploapplication/json

Media type hint for the target resource

name
string
ejemploresource-name

Secondary key for selecting link objects

title
string
ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

{
   "_embedded": {
      "historical_data": [
         {
            "queue_size": 30,
            "timestamp": "2024-06-12T15:59:22.870Z"
         }
      ]
   },
   "_links": {
      "self": {
         "href": "https://api.vonage.com/v1/resources/abc123",
         "templated": false,
         "type": "application/json",
         "name": "resource-name",
         "title": "Resource Title"
      }
   }
}