Vonage Traffic Control API
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
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Object representing the activated/deactivated status of the Vonage Traffic Control (VTC) service.
ACTIVATEDIndicates whether the VTC service is activated (ACTIVATED) or deactivated (DEACTIVATED) for the product.
ACTIVATEDDEACTIVATEDHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Beispiel Antwort
{
"_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"
}
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Object representing the activated/deactivated status of the Vonage Traffic Control (VTC) service.
ACTIVATEDIndicates whether the VTC service is activated (ACTIVATED) or deactivated (DEACTIVATED) for the product.
ACTIVATEDDEACTIVATEDHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Beispiel Antwort
{
"_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"
}
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Object representing the activated/deactivated status of the Vonage Traffic Control (VTC) service.
ACTIVATEDIndicates whether the VTC service is activated (ACTIVATED) or deactivated (DEACTIVATED) for the product.
ACTIVATEDDEACTIVATEDHAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Beispiel Antwort
{
"_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"
}
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Object representing the current queue size for the VTC service.
100The current number of messages in the queue.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Beispiel Antwort
{
"_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"
}
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Array of historical queue size data points.
30The queue size at a specific point in time.
2024-06-12T15:59:22.870ZThe timestamp of when the queue size was recorded.
HAL Links object
A single HAL link object
https://api.vonage.com/v1/resources/abc123The URL for the resource
Indicates if the href is a URI template
application/jsonMedia type hint for the target resource
resource-nameSecondary key for selecting link objects
Resource TitleHuman-readable title for the link
Beispiel Antwort
{
"_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"
}
}
}