Available Operations Errors
 
 

Application API

Vonage provides an Application API to allow management of your Vonage Applications.

This API is backwards compatible with version 1. Applications created using version 1 of the API can also be managed using version 2 (this version) of the API.

Available Operations:

There are multiple versions of this API available

Version 1 | Version 2

List available applications

GET https://api.nexmo.com/v2/applications
Host https://api.nexmo.com
GET /v2/applications

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Query Parameter

page_size
integer

The number of applications per page

page
integer

The current page number (starts at 1)

Responses

200 Success
page_size
integer

The number of applications per page

page
integer

The current page number (starts at 1)

total_items
integer

The total number of applications

total_pages
integer

The total number of pages returned

_embedded
object

A list of applications matching your existing filters

applications
array
id
string

The application's ID

name
string

Friendly identifier for your application. This is not unique

capabilities
object

Your application can use multiple products. This contains the configuration for each product. This replaces the application type from version 1 of the Application API.

messages
object

Messages / Dispatch related configuration

version
string

If not populated will be set to v1

webhooks
object
inbound_url
object

Vonage will forward inbound messages to this URL

address
string
http_method
string
One of: POST
status_url
object

Vonage will send message status updates (e.g. delivered, seen) to this URL

address
string
http_method
string
One of: POST
rtc
object

RTC / Conversation Service related configuration

signed_callbacks
boolean
leg_persistence_time
integer
webhooks
object
event_url
object

Vonage will send RTC events to this URL

address
string
http_method
string
One of: GET or POST
voice
object

Voice related configuration

signed_callbacks
boolean

verify that a request is coming from Vonage servers (a jwt token will be sent on the callback authorization header)

conversation_ttl
integer

ttl used by the NCCO in case you’re using a conversation action (is set in hours and is 48 by default)

payments
object

encompass all the payment related fields

gateways
array of objects

payment gateways like Stripe

type
string

payment gateway type (Stripe, Azure)

credential
string

used to identify the gateway in the credentials service

mode
string

determines if the user has completed the integration with the gateway

One of: test or live
webhooks
object
answer_url
object
address
string

The URL that Vonage requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Vonage will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

event_url
object

Vonage will send call events (e.g. ringing, answered) to this URL

address
string

The URL that Vonage sends events related to your call to

http_method
string

The HTTP method used to send events to your server

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

meetings
object

Meetings related configuration

webhooks
object
room_changed
object

Vonage will send call room changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
session_changed
object

Vonage will send call session changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
recording_changed
object

Vonage will send recording changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

verify
object

Two factor authentication related configuration

webhooks
object
status_url
object

Vonage will send request status events (e.g. progress, complete) to this URL

address
string
http_method
string
One of: POST
version
string

Verify current version. If specified must be set to v2

One of: v2
privacy
object

Application privacy config

improve_ai
boolean

If set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.

Example Responses

200 400 401 405 406
{
  "page_size": 10,
  "page": 1,
  "total_items": 6,
  "total_pages": 1,
  "_embedded": {
    "applications": [
      {
        "id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
        "name": "My Application",
        "capabilities": {
          "messages": {
            "version": "abc123",
            "webhooks": {
              "inbound_url": {
                "address": "https://example.com/webhooks/inbound",
                "http_method": "POST"
              },
              "status_url": {
                "address": "https://example.com/webhooks/status",
                "http_method": "POST"
              }
            }
          },
          "rtc": {
            "signed_callbacks": true,
            "leg_persistence_time": 5,
            "webhooks": {
              "event_url": {
                "address": "https://example.com/webhooks/event",
                "http_method": "POST"
              }
            }
          },
          "voice": {
            "signed_callbacks": true,
            "conversation_ttl": 30,
            "payments": {
              "gateways": [
                {
                  "type": "Stripe",
                  "credential": "26f2a89e-6fcd-11ed-a1eb-0242ac120002",
                  "mode": "live"
                }
              ]
            },
            "webhooks": {
              "answer_url": {
                "address": "https://example.com/webhooks/answer",
                "http_method": "POST",
                "connection_timeout": 500,
                "socket_timeout": 3000
              },
              "fallback_answer_url": {
                "address": "https://fallback.example.com/webhooks/answer",
                "http_method": "POST",
                "connection_timeout": 500,
                "socket_timeout": 3000
              },
              "event_url": {
                "address": "https://example.com/webhooks/event",
                "http_method": "POST",
                "connection_timeout": 500,
                "socket_timeout": 3000
              }
            }
          },
          "meetings": {
            "webhooks": {
              "room_changed": {
                "address": "https://example.com/webhooks/event",
                "http_method": "POST"
              },
              "session_changed": {
                "address": "https://example.com/webhooks/event",
                "http_method": "POST"
              },
              "recording_changed": {
                "address": "https://example.com/webhooks/event",
                "http_method": "POST"
              }
            }
          },
          "vbc": {},
          "verify": {
            "webhooks": {
              "status_url": {
                "address": "https://example.com/webhooks/event",
                "http_method": "POST"
              }
            },
            "version": "v2"
          }
        },
        "privacy": {
          "improve_ai": true
        }
      }
    ]
  }
}
{
  "type": "https://developer.nexmo.com/api-errors/application#list-validation",
  "title": "Bad Request",
  "detail": "The request failed due to validation errors",
  "invalid_parameters": [
    {
      "name": "page_size",
      "reason": "must be between 1 and 100"
    }
  ],
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Create an application

POST https://api.nexmo.com/v2/applications
Host https://api.nexmo.com
POST /v2/applications

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Request body application/json

name
string | Required

Application Name

keys
object
public_key
string

Public key

capabilities
object

Your application can use multiple products. This contains the configuration for each product. This replaces the application type from version 1 of the Application API.

messages
object

Messages / Dispatch related configuration

version
string

If not populated will be set to v1

webhooks
object

Messages / Dispatch related configuration

inbound_url
object

Vonage will forward inbound messages to this URL

address
string

Vonage will forward inbound messages to this URL

http_method
string

Vonage will forward inbound messages to this URL

Must be one of: POST
status_url
object

Vonage will send message status updates (e.g. delivered, seen) to this URL

address
string

Vonage will send message status updates (e.g. delivered, seen) to this URL

http_method
string

Vonage will send message status updates (e.g. delivered, seen) to this URL

Must be one of: POST
rtc
object

RTC / Conversation Service related configuration

signed_callbacks
boolean

RTC / Conversation Service related configuration

leg_persistence_time
integer (int32) | Min: 1 | Max: 31

RTC / Conversation Service related configuration

webhooks
object

RTC / Conversation Service related configuration

event_url
object

Vonage will send RTC events to this URL

address
string

Vonage will send RTC events to this URL

http_method
string

Vonage will send RTC events to this URL

Must be one of: GET or POST
voice
object

Voice related configuration

signed_callbacks
boolean

verify that a request is coming from Vonage servers (a jwt token will be sent on the callback authorization header)

conversation_ttl
integer

ttl used by the NCCO in case you’re using a conversation action (is set in hours and is 48 by default)

payments
object

encompass all the payment related fields

gateways
array of objects

payment gateways like Stripe

type
string

payment gateway type (Stripe, Azure)

credential
string

used to identify the gateway in the credentials service

mode
string

determines if the user has completed the integration with the gateway

Must be one of: test or live
webhooks
object

Voice related configuration

answer_url
object
address
string

The URL that Vonage requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

Must be one of: GET or POST
connection_timeout
integer | Min: 300 | Max: 1000 | Default: 1000

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer | Min: 1000 | Max: 5000 | Default: 5000

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Vonage will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

Must be one of: GET or POST
connection_timeout
integer | Min: 300 | Max: 1000 | Default: 1000

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer | Min: 1000 | Max: 5000 | Default: 5000

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

event_url
object

Vonage will send call events (e.g. ringing, answered) to this URL

address
string

The URL that Vonage sends events related to your call to

http_method
string

The HTTP method used to send events to your server

Must be one of: GET or POST
connection_timeout
integer | Min: 300 | Max: 1000 | Default: 1000

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer | Min: 1000 | Max: 10000 | Default: 10000

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

meetings
object

Meetings related configuration

webhooks
object

Meetings related configuration

room_changed
object

Vonage will send call room changed events to this URL

address
string

Vonage will send call room changed events to this URL

http_method
string

Vonage will send call room changed events to this URL

Must be one of: GET, POST or PUT
session_changed
object

Vonage will send call session changed events to this URL

address
string

Vonage will send call session changed events to this URL

http_method
string

Vonage will send call session changed events to this URL

Must be one of: GET, POST or PUT
recording_changed
object

Vonage will send recording changed events to this URL

address
string

Vonage will send recording changed events to this URL

http_method
string

Vonage will send recording changed events to this URL

Must be one of: GET, POST or PUT
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

verify
object

Two factor authentication related configuration

webhooks
object

Two factor authentication related configuration

status_url
object

Vonage will send request status events (e.g. progress, complete) to this URL

address
string

Vonage will send request status events (e.g. progress, complete) to this URL

http_method
string

Vonage will send request status events (e.g. progress, complete) to this URL

Must be one of: POST
version
string

Verify current version. If specified must be set to v2

Must be one of: v2
privacy
object

Application privacy config

improve_ai
boolean | Default: true

If set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.

Responses

201 Success
id
string

The application's ID

name
string

Friendly identifier for your application. This is not unique

capabilities
object

Your application can use multiple products. This contains the configuration for each product. This replaces the application type from version 1 of the Application API.

messages
object

Messages / Dispatch related configuration

version
string

If not populated will be set to v1

webhooks
object
inbound_url
object

Vonage will forward inbound messages to this URL

address
string
http_method
string
One of: POST
status_url
object

Vonage will send message status updates (e.g. delivered, seen) to this URL

address
string
http_method
string
One of: POST
rtc
object

RTC / Conversation Service related configuration

signed_callbacks
boolean
leg_persistence_time
integer
webhooks
object
event_url
object

Vonage will send RTC events to this URL

address
string
http_method
string
One of: GET or POST
voice
object

Voice related configuration

signed_callbacks
boolean

verify that a request is coming from Vonage servers (a jwt token will be sent on the callback authorization header)

conversation_ttl
integer

ttl used by the NCCO in case you’re using a conversation action (is set in hours and is 48 by default)

payments
object

encompass all the payment related fields

gateways
array of objects

payment gateways like Stripe

type
string

payment gateway type (Stripe, Azure)

credential
string

used to identify the gateway in the credentials service

mode
string

determines if the user has completed the integration with the gateway

One of: test or live
webhooks
object
answer_url
object
address
string

The URL that Vonage requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Vonage will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

event_url
object

Vonage will send call events (e.g. ringing, answered) to this URL

address
string

The URL that Vonage sends events related to your call to

http_method
string

The HTTP method used to send events to your server

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

meetings
object

Meetings related configuration

webhooks
object
room_changed
object

Vonage will send call room changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
session_changed
object

Vonage will send call session changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
recording_changed
object

Vonage will send recording changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

verify
object

Two factor authentication related configuration

webhooks
object
status_url
object

Vonage will send request status events (e.g. progress, complete) to this URL

address
string
http_method
string
One of: POST
version
string

Verify current version. If specified must be set to v2

One of: v2
privacy
object

Application privacy config

improve_ai
boolean

If set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.

keys
object
public_key
string
private_key
string

Example Request

{
  "name": "Demo Application"
}
{
  "name": "Demo Application",
  "keys": {
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n"
  },
  "capabilities": {
    "messages": {
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "signed_callbacks": true,
      "leg_persistence_time": 5,
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "voice": {
      "signed_callbacks": true,
      "conversation_ttl": 30,
      "payments": {
        "gateways": [
          {
            "type": "Stripe",
            "credential": "26f2a89e-6fcd-11ed-a1eb-0242ac120002",
            "mode": "live"
          }
        ]
      },
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        }
      }
    },
    "meetings": {
      "webhooks": {
        "room_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "session_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "recording_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "verify": {
      "webhooks": {
        "status_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      },
      "version": "v2"
    }
  },
  "privacy": {
    "improve_ai": true
  }
}

Example Responses

201 400 401 405 406 415
{
  "id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
  "name": "My Application",
  "capabilities": {
    "messages": {
      "version": "abc123",
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "signed_callbacks": true,
      "leg_persistence_time": 5,
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "voice": {
      "signed_callbacks": true,
      "conversation_ttl": 30,
      "payments": {
        "gateways": [
          {
            "type": "Stripe",
            "credential": "26f2a89e-6fcd-11ed-a1eb-0242ac120002",
            "mode": "live"
          }
        ]
      },
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        }
      }
    },
    "meetings": {
      "webhooks": {
        "room_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "session_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "recording_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "vbc": {},
    "verify": {
      "webhooks": {
        "status_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      },
      "version": "v2"
    }
  },
  "privacy": {
    "improve_ai": true
  },
  "keys": {
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n",
    "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFA\nASCBKcwggSjAgEAAoIBAQDEPpvi+3\nRH1efQ\\nkveWzZDrNNoEXmBw61w+O\n0u/N36tJnN5XnYecU64yHzu2ByEr0\n7iIvYbavFnADwl\\nHMTJwqDQakpa3\n8/SFRnTDq3zronvNZ6nOp7S6K7pcZ\nrw/CvrL6hXT1x7cGBZ4jPx\\nqhjqY\nuJPgZD7OVB69oYOV92vIIJ7JLYwqb\n-----END PRIVATE KEY-----\n"
  }
}
{
  "type": "https://developer.nexmo.com/api-errors/application#payload-validation",
  "title": "Bad Request",
  "detail": "The request failed due to validation errors",
  "invalid_parameters": [
    {
      "name": "capabilities.voice.webhooks.answer_url.http_method",
      "reason": "must be one of: GET, POST"
    }
  ],
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#content-type-header",
  "title": "Unsupported Content-Type header",
  "detail": "Unsupported Content-Type header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Get an application

GET https://api.nexmo.com/v2/applications/:id
Host https://api.nexmo.com
GET /v2/applications/:id

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Path Parameters

id
string | Required

The ID of the application

Responses

200 Success
id
string

The application's ID

name
string

Friendly identifier for your application. This is not unique

capabilities
object

Your application can use multiple products. This contains the configuration for each product. This replaces the application type from version 1 of the Application API.

messages
object

Messages / Dispatch related configuration

version
string

If not populated will be set to v1

webhooks
object
inbound_url
object

Vonage will forward inbound messages to this URL

address
string
http_method
string
One of: POST
status_url
object

Vonage will send message status updates (e.g. delivered, seen) to this URL

address
string
http_method
string
One of: POST
rtc
object

RTC / Conversation Service related configuration

signed_callbacks
boolean
leg_persistence_time
integer
webhooks
object
event_url
object

Vonage will send RTC events to this URL

address
string
http_method
string
One of: GET or POST
voice
object

Voice related configuration

signed_callbacks
boolean

verify that a request is coming from Vonage servers (a jwt token will be sent on the callback authorization header)

conversation_ttl
integer

ttl used by the NCCO in case you’re using a conversation action (is set in hours and is 48 by default)

payments
object

encompass all the payment related fields

gateways
array of objects

payment gateways like Stripe

type
string

payment gateway type (Stripe, Azure)

credential
string

used to identify the gateway in the credentials service

mode
string

determines if the user has completed the integration with the gateway

One of: test or live
webhooks
object
answer_url
object
address
string

The URL that Vonage requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Vonage will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

event_url
object

Vonage will send call events (e.g. ringing, answered) to this URL

address
string

The URL that Vonage sends events related to your call to

http_method
string

The HTTP method used to send events to your server

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

meetings
object

Meetings related configuration

webhooks
object
room_changed
object

Vonage will send call room changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
session_changed
object

Vonage will send call session changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
recording_changed
object

Vonage will send recording changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

verify
object

Two factor authentication related configuration

webhooks
object
status_url
object

Vonage will send request status events (e.g. progress, complete) to this URL

address
string
http_method
string
One of: POST
version
string

Verify current version. If specified must be set to v2

One of: v2
privacy
object

Application privacy config

improve_ai
boolean

If set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.

Example Responses

200 401 404 405 406
{
  "id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
  "name": "My Application",
  "capabilities": {
    "messages": {
      "version": "abc123",
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "signed_callbacks": true,
      "leg_persistence_time": 5,
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "voice": {
      "signed_callbacks": true,
      "conversation_ttl": 30,
      "payments": {
        "gateways": [
          {
            "type": "Stripe",
            "credential": "26f2a89e-6fcd-11ed-a1eb-0242ac120002",
            "mode": "live"
          }
        ]
      },
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        }
      }
    },
    "meetings": {
      "webhooks": {
        "room_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "session_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "recording_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "vbc": {},
    "verify": {
      "webhooks": {
        "status_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      },
      "version": "v2"
    }
  },
  "privacy": {
    "improve_ai": true
  }
}
{
  "type": "https://developer.vonage.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#not-found",
  "title": "Not Found",
  "detail": "ID 'ABC123' does not exist, or you do not have access",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Update an application

PUT https://api.nexmo.com/v2/applications/:id
Host https://api.nexmo.com
PUT /v2/applications/:id

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Path Parameters

id
string | Required

The ID of the application

Request body application/json

name
string | Required

Application Name

keys
object
public_key
string

Public key

capabilities
object

Your application can use multiple products. This contains the configuration for each product. This replaces the application type from version 1 of the Application API.

messages
object

Messages / Dispatch related configuration

version
string

If not populated will be set to v1

webhooks
object

Messages / Dispatch related configuration

inbound_url
object

Vonage will forward inbound messages to this URL

address
string

Vonage will forward inbound messages to this URL

http_method
string

Vonage will forward inbound messages to this URL

Must be one of: POST
status_url
object

Vonage will send message status updates (e.g. delivered, seen) to this URL

address
string

Vonage will send message status updates (e.g. delivered, seen) to this URL

http_method
string

Vonage will send message status updates (e.g. delivered, seen) to this URL

Must be one of: POST
rtc
object

RTC / Conversation Service related configuration

signed_callbacks
boolean

RTC / Conversation Service related configuration

leg_persistence_time
integer (int32) | Min: 1 | Max: 31

RTC / Conversation Service related configuration

webhooks
object

RTC / Conversation Service related configuration

event_url
object

Vonage will send RTC events to this URL

address
string

Vonage will send RTC events to this URL

http_method
string

Vonage will send RTC events to this URL

Must be one of: GET or POST
voice
object

Voice related configuration

signed_callbacks
boolean

verify that a request is coming from Vonage servers (a jwt token will be sent on the callback authorization header)

conversation_ttl
integer

ttl used by the NCCO in case you’re using a conversation action (is set in hours and is 48 by default)

payments
object

encompass all the payment related fields

gateways
array of objects

payment gateways like Stripe

type
string

payment gateway type (Stripe, Azure)

credential
string

used to identify the gateway in the credentials service

mode
string

determines if the user has completed the integration with the gateway

Must be one of: test or live
webhooks
object

Voice related configuration

answer_url
object
address
string

The URL that Vonage requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

Must be one of: GET or POST
connection_timeout
integer | Min: 300 | Max: 1000 | Default: 1000

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer | Min: 1000 | Max: 5000 | Default: 5000

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Vonage will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

Must be one of: GET or POST
connection_timeout
integer | Min: 300 | Max: 1000 | Default: 1000

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer | Min: 1000 | Max: 5000 | Default: 5000

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

event_url
object

Vonage will send call events (e.g. ringing, answered) to this URL

address
string

The URL that Vonage sends events related to your call to

http_method
string

The HTTP method used to send events to your server

Must be one of: GET or POST
connection_timeout
integer | Min: 300 | Max: 1000 | Default: 1000

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer | Min: 1000 | Max: 10000 | Default: 10000

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

meetings
object

Meetings related configuration

webhooks
object

Meetings related configuration

room_changed
object

Vonage will send call room changed events to this URL

address
string

Vonage will send call room changed events to this URL

http_method
string

Vonage will send call room changed events to this URL

Must be one of: GET, POST or PUT
session_changed
object

Vonage will send call session changed events to this URL

address
string

Vonage will send call session changed events to this URL

http_method
string

Vonage will send call session changed events to this URL

Must be one of: GET, POST or PUT
recording_changed
object

Vonage will send recording changed events to this URL

address
string

Vonage will send recording changed events to this URL

http_method
string

Vonage will send recording changed events to this URL

Must be one of: GET, POST or PUT
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

verify
object

Two factor authentication related configuration

webhooks
object

Two factor authentication related configuration

status_url
object

Vonage will send request status events (e.g. progress, complete) to this URL

address
string

Vonage will send request status events (e.g. progress, complete) to this URL

http_method
string

Vonage will send request status events (e.g. progress, complete) to this URL

Must be one of: POST
version
string

Verify current version. If specified must be set to v2

Must be one of: v2
privacy
object

Application privacy config

improve_ai
boolean

If set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.

Responses

200 Success
id
string

The application's ID

name
string

Friendly identifier for your application. This is not unique

capabilities
object

Your application can use multiple products. This contains the configuration for each product. This replaces the application type from version 1 of the Application API.

messages
object

Messages / Dispatch related configuration

version
string

If not populated will be set to v1

webhooks
object
inbound_url
object

Vonage will forward inbound messages to this URL

address
string
http_method
string
One of: POST
status_url
object

Vonage will send message status updates (e.g. delivered, seen) to this URL

address
string
http_method
string
One of: POST
rtc
object

RTC / Conversation Service related configuration

signed_callbacks
boolean
leg_persistence_time
integer
webhooks
object
event_url
object

Vonage will send RTC events to this URL

address
string
http_method
string
One of: GET or POST
voice
object

Voice related configuration

signed_callbacks
boolean

verify that a request is coming from Vonage servers (a jwt token will be sent on the callback authorization header)

conversation_ttl
integer

ttl used by the NCCO in case you’re using a conversation action (is set in hours and is 48 by default)

payments
object

encompass all the payment related fields

gateways
array of objects

payment gateways like Stripe

type
string

payment gateway type (Stripe, Azure)

credential
string

used to identify the gateway in the credentials service

mode
string

determines if the user has completed the integration with the gateway

One of: test or live
webhooks
object
answer_url
object
address
string

The URL that Vonage requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Vonage will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

event_url
object

Vonage will send call events (e.g. ringing, answered) to this URL

address
string

The URL that Vonage sends events related to your call to

http_method
string

The HTTP method used to send events to your server

One of: GET or POST
connection_timeout
integer

If Vonage can't connect to the webhook URL for this specified amount of time, then Vonage makes one additional attempt to connect to the webhook endpoint. This is an integer value specified in milliseconds.

socket_timeout
integer

If a response from the webhook URL can't be read for this specified amount of time, then Vonage makes one additional attempt to read the webhook endpoint. This is an integer value specified in milliseconds.

meetings
object

Meetings related configuration

webhooks
object
room_changed
object

Vonage will send call room changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
session_changed
object

Vonage will send call session changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
recording_changed
object

Vonage will send recording changed events to this URL

address
string
http_method
string
One of: GET, POST or PUT
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

verify
object

Two factor authentication related configuration

webhooks
object
status_url
object

Vonage will send request status events (e.g. progress, complete) to this URL

address
string
http_method
string
One of: POST
version
string

Verify current version. If specified must be set to v2

One of: v2
privacy
object

Application privacy config

improve_ai
boolean

If set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.

keys
object
public_key
string
private_key
string

Example Request

{
  "name": "Demo Application"
}
{
  "name": "Demo Application",
  "keys": {
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n"
  },
  "capabilities": {
    "messages": {
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "signed_callbacks": true,
      "leg_persistence_time": 5,
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "voice": {
      "signed_callbacks": true,
      "conversation_ttl": 30,
      "payments": {
        "gateways": [
          {
            "type": "Stripe",
            "credential": "26f2a89e-6fcd-11ed-a1eb-0242ac120002",
            "mode": "live"
          }
        ]
      },
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        }
      }
    },
    "meetings": {
      "webhooks": {
        "room_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "session_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "recording_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "verify": {
      "webhooks": {
        "status_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      },
      "version": "v2"
    }
  },
  "privacy": {
    "improve_ai": true
  }
}

Example Responses

200 400 401 404 405 406 415
{
  "id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
  "name": "My Application",
  "capabilities": {
    "messages": {
      "version": "abc123",
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "signed_callbacks": true,
      "leg_persistence_time": 5,
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "voice": {
      "signed_callbacks": true,
      "conversation_ttl": 30,
      "payments": {
        "gateways": [
          {
            "type": "Stripe",
            "credential": "26f2a89e-6fcd-11ed-a1eb-0242ac120002",
            "mode": "live"
          }
        ]
      },
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        }
      }
    },
    "meetings": {
      "webhooks": {
        "room_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "session_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        },
        "recording_changed": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "vbc": {},
    "verify": {
      "webhooks": {
        "status_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      },
      "version": "v2"
    }
  },
  "privacy": {
    "improve_ai": true
  },
  "keys": {
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n",
    "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFA\nASCBKcwggSjAgEAAoIBAQDEPpvi+3\nRH1efQ\\nkveWzZDrNNoEXmBw61w+O\n0u/N36tJnN5XnYecU64yHzu2ByEr0\n7iIvYbavFnADwl\\nHMTJwqDQakpa3\n8/SFRnTDq3zronvNZ6nOp7S6K7pcZ\nrw/CvrL6hXT1x7cGBZ4jPx\\nqhjqY\nuJPgZD7OVB69oYOV92vIIJ7JLYwqb\n-----END PRIVATE KEY-----\n"
  }
}
{
  "type": "https://developer.nexmo.com/api-errors/application#payload-validation",
  "title": "Bad Request",
  "detail": "The request failed due to validation errors",
  "invalid_parameters": [
    {
      "name": "capabilities.voice.webhooks.answer_url.http_method",
      "reason": "must be one of: GET, POST"
    }
  ],
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#not-found",
  "title": "Not Found",
  "detail": "ID 'ABC123' does not exist, or you do not have access",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#content-type-header",
  "title": "Unsupported Content-Type header",
  "detail": "Unsupported Content-Type header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Delete an application

Deleting an application cannot be undone.

DELETE https://api.nexmo.com/v2/applications/:id
Host https://api.nexmo.com
DELETE /v2/applications/:id

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Path Parameters

id
string | Required

The ID of the application

Example Responses

204 401 404 405 406
Success
{
  "type": "https://developer.vonage.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#not-found",
  "title": "Not Found",
  "detail": "ID 'ABC123' does not exist, or you do not have access",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.vonage.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Errors

The following is a non-exhaustive list of error codes that may occur while using this API. These codes are in addition to any of our generic error codes.

Code Details
payload-validation

Invalid request. See invalid_parameters field for details

list-validation

Invalid request. See invalid_parameters field for details

rate-limit

The request was rate limited