A Nexmo application contains the security and configuration information you need to connect to Nexmo endpoints and easily use our products.
You use a GET request to retrieve details of all applications associated with your account.
GET
https://api.nexmo.com/v1/applications
Host
https://api.nexmo.com
GET
/v1/applications
You can find your API key in your account overview
You can find your API secret in your account overview
Set the number of items returned on each call to this endpoint. The default is 10 records.
Set the offset from the first page. The default value is 0.
The number of items associated with your account.
The number of items returned on each call to this endpoint. The default is 10 records.
The offset from the first page.
The collection of your applications. Each object contains information about an an individual application. The public_key is not included in the application information.
The ID allocated to your application by Nexmo.
The name of your application
The Nexmo product that you access with this application.
answer_url or event_url
answer_url: The URL where your webhook delivers the Nexmo Call Control Object that governs this call. As soon as your user answers a call Nexmo makes a request to answer_url. event_url: Nexmo sends event information asynchronously to this URL when status changes.
The HTTP method used to send event information to the event_url or answer_url.
GET or POST
The Nexmo product that you access with this application.
inbound_url or status_url
inbound_url: The URL where inbound messages are delivered. status_url: The URL where message status is delivered.
The HTTP method used to send data to the inbound_url or status_url. Default is POST.
GET or POST
The Nexmo product that you access with this application.
{
"count": 1,
"page_size": 10,
"page_index": 1,
"_embedded": {
"applications": [
{
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"name": "My Application",
"voice": {
"webhooks": [
{
"endpoint_type": "answer_url",
"endpoint": "https://example.com/webhooks/answer",
"http_method": "GET"
}
]
},
"messages": {
"webhooks": [
{
"endpoint_type": "status_url",
"endpoint": "https://example.com/webhooks/status",
"http_method": "POST"
}
]
},
"keys": {
"public_key": "PUBLIC_KEY"
},
"_links": {
"href": "/v1/applications/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
}
]
},
"_links": {
"href": "/v1/applications/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
}You use a POST request to create a new application.
POST
https://api.nexmo.com/v1/applications
Host
https://api.nexmo.com
POST
/v1/applications
You can find your API key in your account overview
You can find your API secret in your account overview
The name of your application.
The Nexmo product or products that you access with this application. Currently voice and messages application types are supported.
voice or messages
The URL where your webhook delivers the Nexmo Call Control Object that governs this call. As soon as your user answers a call Nexmo makes a request to answer_url. Required for inbound calls only.
The HTTP method used to make the request to answer_url. The default value is GET.
Nexmo sends event information asynchronously to this URL when status changes for voice applications. Always required for voice applications.
The HTTP method used to send event information to event_url. The default value is POST. For voice type applications only.
Nexmo sends event information asynchronously to this URL when status changes. Required for messages type applications only.
The HTTP method used to send event information to status_url. The default value is POST. For messages type applications only.
Nexmo sends a request to this URL when an inbound message is received. Required for messages type applications only.
The HTTP method used to send event information to inbound_url. The default value is POST. For messages type applications only.
The ID allocated to your application by Nexmo.
The name of your application
The Nexmo product that you access with this application.
answer_url or event_url
answer_url: The URL where your webhook delivers the Nexmo Call Control Object that governs this call. As soon as your user answers a call Nexmo makes a request to answer_url. event_url: Nexmo sends event information asynchronously to this URL when status changes.
The HTTP method used to send event information to the event_url or answer_url.
GET or POST
The Nexmo product that you access with this application.
inbound_url or status_url
inbound_url: The URL where inbound messages are delivered. status_url: The URL where message status is delivered.
The HTTP method used to send data to the inbound_url or status_url. Default is POST.
GET or POST
The Nexmo product that you access with this application.
The private key you use to generate the JSON Web Token (JWT) that authenticates your requests to Messages API.
{
"api_key": "ap1k3y",
"api_secret": "230e6cf0709417176df1b4fc1e083adc",
"name": "My Application",
"type": "voice"
}{
"api_key": "ap1k3y",
"api_secret": "230e6cf0709417176df1b4fc1e083adc",
"name": "My Application",
"type": "voice",
"answer_url": "https://example.com/webhooks/answer",
"answer_method": "GET",
"event_url": "https://example.com/webhooks/event",
"event_method": "POST",
"status_url": "https://example.com/webhooks/status",
"status_method": "POST",
"inbound_url": "https://example.com/webhooks/inbound",
"inbound_method": "POST"
}{
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"name": "My Application",
"voice": {
"webhooks": [
{
"endpoint_type": "answer_url",
"endpoint": "https://example.com/webhooks/answer",
"http_method": "GET"
}
]
},
"messages": {
"webhooks": [
{
"endpoint_type": "status_url",
"endpoint": "https://example.com/webhooks/status",
"http_method": "POST"
}
]
},
"keys": {
"public_key": "PUBLIC_KEY",
"private_key": "PRIVATE_KEY"
},
"_links": {
"href": "/v1/applications/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
}You use a GET request to retrieve details about a single application.
GET
https://api.nexmo.com/v1/applications/:app_id
Host
https://api.nexmo.com
GET
/v1/applications/:app_id
The ID allocated to your application by Nexmo.
You can find your API key in your account overview
You can find your API secret in your account overview
The ID allocated to your application by Nexmo.
The name of your application
The Nexmo product that you access with this application.
answer_url or event_url
answer_url: The URL where your webhook delivers the Nexmo Call Control Object that governs this call. As soon as your user answers a call Nexmo makes a request to answer_url. event_url: Nexmo sends event information asynchronously to this URL when status changes.
The HTTP method used to send event information to the event_url or answer_url.
GET or POST
The Nexmo product that you access with this application.
inbound_url or status_url
inbound_url: The URL where inbound messages are delivered. status_url: The URL where message status is delivered.
The HTTP method used to send data to the inbound_url or status_url. Default is POST.
GET or POST
The Nexmo product that you access with this application.
{
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"name": "My Application",
"voice": {
"webhooks": [
{
"endpoint_type": "answer_url",
"endpoint": "https://example.com/webhooks/answer",
"http_method": "GET"
}
]
},
"messages": {
"webhooks": [
{
"endpoint_type": "status_url",
"endpoint": "https://example.com/webhooks/status",
"http_method": "POST"
}
]
},
"keys": {
"public_key": "PUBLIC_KEY"
},
"_links": {
"href": "/v1/applications/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
}You use a PUT request to update an existing application.
PUT
https://api.nexmo.com/v1/applications/:app_id
Host
https://api.nexmo.com
PUT
/v1/applications/:app_id
The ID allocated to your application by Nexmo.
You can find your API key in your account overview
You can find your API secret in your account overview
The name of your application.
The Nexmo product or products that you access with this application. Currently voice and messages application types are supported. You can't change the type of application.
voice or messages
The URL where your webhook delivers the Nexmo Call Control Object that governs this call. As soon as your user answers a call Nexmo makes a request to answer_url.
The HTTP method used to make the request to answer_url. The default value is GET.
Nexmo sends event information asynchronously to this URL when status changes.
The HTTP method used to send event information to event_url. The default value is POST.
The ID allocated to your application by Nexmo.
The name of your application
The Nexmo product that you access with this application.
answer_url or event_url
answer_url: The URL where your webhook delivers the Nexmo Call Control Object that governs this call. As soon as your user answers a call Nexmo makes a request to answer_url. event_url: Nexmo sends event information asynchronously to this URL when status changes.
The HTTP method used to send event information to the event_url or answer_url.
GET or POST
The Nexmo product that you access with this application.
inbound_url or status_url
inbound_url: The URL where inbound messages are delivered. status_url: The URL where message status is delivered.
The HTTP method used to send data to the inbound_url or status_url. Default is POST.
GET or POST
The Nexmo product that you access with this application.
{
"api_key": "ap1k3y",
"api_secret": "230e6cf0709417176df1b4fc1e083adc",
"name": "UpdatedApplication",
"type": "voice"
}{
"api_key": "ap1k3y",
"api_secret": "230e6cf0709417176df1b4fc1e083adc",
"name": "UpdatedApplication",
"type": "voice",
"answer_url": "https://example.com/webhooks/answer",
"answer_method": "GET",
"event_url": "https://example.com/webhooks/event",
"event_method": "POST"
}{
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"name": "My Application",
"voice": {
"webhooks": [
{
"endpoint_type": "answer_url",
"endpoint": "https://example.com/webhooks/answer",
"http_method": "GET"
}
]
},
"messages": {
"webhooks": [
{
"endpoint_type": "status_url",
"endpoint": "https://example.com/webhooks/status",
"http_method": "POST"
}
]
},
"keys": {
"public_key": "PUBLIC_KEY"
},
"_links": {
"href": "/v1/applications/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
}You use a DELETE request to delete a single application.
DELETE
https://api.nexmo.com/v1/applications/:app_id
Host
https://api.nexmo.com
DELETE
/v1/applications/:app_id
The ID allocated to your application by Nexmo.
No content