Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
10The number of applications per page
1The current page number (starts at 1)
6The total number of applications
1The total number of pages returned
A list of applications matching your existing filters
78d335fa-323d-0114-9c3d-d6f0d48968cfThe application's ID
My ApplicationFriendly identifier for your application. This is not unique
Configuration for the products available in this application
Voice related configuration
https://example.com/webhooks/answerThe URL that Vonage requests when a call is placed/received. Must return an NCCO
POSTThe HTTP method used to fetch your NCCO from your answer_url
500If 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.
3000If 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.
https://fallback.example.com/webhooks/answerIf 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.
POSTThe HTTP method used to fetch your NCCO from your answer_url
500Connection timeout in milliseconds
3000Reading timeout in milliseconds
https://example.com/webhooks/eventThe URL that Vonage sends events related to your call to
POSTThe HTTP method used to send events to your server
500If 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.
3000If 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.
trueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
190004812The length of time named conversations will remain active for after creation, in hours. Maximum value is 9000 (i.e. 365 days).
131210The persistence duration for legs, in days. Maximum value is 31.
eu-westSelecting a region means all inbound, programmable SIP and SIP connect calls will be sent to the selected region unless the call is sent to a regional endpoint, if the call is using a regional endpoint this will override the application setting.
na-eastna-westeu-easteu-westapac-sngapac-australiaMessages / Dispatch related configuration
https://example.com/webhooks/inboundThe URL that Vonage forwards inbound messages to on your server
POSTThe HTTP method used to send inbound messages to your server
https://example.com/webhooks/statusThe URL that Vonage sends events related to your messages to
POSTThe HTTP method used to send events to your server (always POST)
RTC / Conversation Service related configuration
https://example.com/webhooks/eventPOSTtrueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.
Network APIs
2bzfIFqRG128IcjSj1YhZNtw6LADGhttps://my-redirect-uri.example.comMeetings related configuration
https://example.com/webhooks/recordingsThe URL that Vonage forwards recording information to on your server
POSTThe HTTP method used to send recording information to your server (always POST)
https://example.com/webhooks/roomsThe URL that Vonage forwards meeting room information on your server.
POSTThe HTTP method used to send meeting room information to your server (always POST)
https://example.com/webhooks/sessionsThe URL that Vonage forwards session information on your server.
POSTThe HTTP method used to send session information to your server (always POST)
Verify v2 related configuration
v2The version of the Verify API to use
https://example.com/webhooks/statusThe URL that Vonage sends events related to your verify requests to
POSTThe HTTP method used to send events to your server (always POST)
Video related configuration
https://example.com/webhooks/eventThe URL that Vonage sends events informing about the archive status
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends session notifications to
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a render status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when captions status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a broadcast status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is updated
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is muted
trueWhether the webhook is active
Whether to use server-side encryption
Whether to use end-to-end encryption
Whether to use cloud storage feature
Application privacy config
trueIf set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.
Example Response
{
"page_size": 10,
"page": 1,
"total_items": 6,
"total_pages": 1,
"_embedded": {
"applications": [
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"name": "My Application",
"capabilities": {
"voice": {
"webhooks": {
"answer_url": {
"address": "https://example.com/webhooks/answer",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
},
"fallback_answer_url": {
"address": "https://fallback.example.com/webhooks/answer",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
},
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
}
},
"signed_callbacks": false,
"conversations_ttl": 12,
"leg_persistence_time": 10,
"region": "eu-west"
},
"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": {
"webhooks": {
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST"
}
},
"signed_callbacks": false
},
"vbc": {},
"network_apis": {
"network_application_id": "2bzfIFqRG128IcjSj1YhZNtw6LADG",
"redirect_uri": "https://my-redirect-uri.example.com"
},
"meetings": {
"webhooks": {
"recording_changed": {
"address": "https://example.com/webhooks/recordings",
"http_method": "POST"
},
"room_changed": {
"address": "https://example.com/webhooks/rooms",
"http_method": "POST"
},
"session_changed": {
"address": "https://example.com/webhooks/sessions",
"http_method": "POST"
}
}
},
"verify": {
"version": "v2",
"webhooks": {
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"video": {
"webhooks": {
"archive_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_notification": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"render_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"captions_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"broadcast_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_updated": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_mute_forced": {
"address": "https://example.com/webhooks/event",
"active": true
}
},
"storage": {
"server_side_encryption": false,
"end_to_end_encryption": false,
"cloud_storage": false
}
}
},
"privacy": {
"improve_ai": true
}
}
]
}
}Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Demo ApplicationApplication Name
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCA
KOxjsU4pf/sMFi9N0jqcSLcjxu33G
d/vynKnlw9SENi+UZR44GdjGdmfm1
tL1eA7IBh2HNnkYXnAwYzKJoa4eO3
0kYWekeIZawIwe/g9faFgkev+1xsO
OUNhPx2LhuLmgwWSRS4L5W851Xe3f
UQIDAQAB
-----END PUBLIC KEY-----
Public key
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.
Voice application webhook config
The URL that Vonage makes a request to when a call is placed/received. Must return an NCCO
https://example.com/webhooks/answerGETGETPOST30010001000500If 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.
1000500050003000If 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.
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.
https://fallback.example.com/webhooks/answerGETGETPOST30010001000500If 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.
1000500050003000If 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.
Vonage will send call events (e.g. ringing, answered) to this URL
https://example.com/webhooks/eventPOSTGETPOST30010001000500If 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.
100010000100003000If 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.
trueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
190004812The length of time named conversations will remain active for after creation, in hours. Maximum value is 9000 (i.e. 365 days).
131210The persistence duration for legs, in days. Maximum value is 31.
eu-westSelecting a region means all inbound, programmable SIP and SIP connect calls will be sent to the selected region unless the call is sent to a regional endpoint, if the call is using a regional endpoint this will override the application setting.
na-eastna-westeu-easteu-westapac-sngapac-australiaRTC / Client SDK application webhook config
Vonage will send RTC events to this URL
https://example.com/webhooks/eventPOSTGETPOSTtrueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
Messages and Dispatch application webhook config
If not populated will be set to v1
Vonage will forward inbound messages to this URL
https://example.com/webhooks/inboundPOSTPOSTVonage will send message status updates (e.g. delivered, seen) to this URL
https://example.com/webhooks/statusPOSTPOSTSpecify vbc capability to enable zero-rated calls for VBC number programmability service applications. This must be an empty object.
Network APIs
2bzfIFqRG128IcjSj1YhZNtw6LADGhttps://my-redirect-uri.example.comMeetings related configuration
The URL that Vonage forwards recording information to on your server
https://example.com/webhooks/recordingsPOSTPOSTThe URL that Vonage forwards meeting room information on your server.
https://example.com/webhooks/roomsPOSTPOSTThe URL that Vonage forwards session information on your server.
https://example.com/webhooks/sessionsPOSTPOSTVerify v2 application webhook config
Vonage will send Verify updates to this URL
https://example.com/webhooks/statusPOSTPOSTVideo related configuration
https://example.com/webhooks/eventThe URL that Vonage sends events informing about the archive status
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends session notifications to
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a render status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when captions status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a broadcast status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is updated
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is muted
trueWhether the webhook is active
Whether to use server-side encryption
Whether to use end-to-end encryption
Whether to use cloud storage feature
Application privacy config
truetrueIf set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.
Example Request
{
"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": {
"voice": {
"webhooks": {
"answer_url": {
"address": "https://example.com/webhooks/answer",
"http_method": "GET",
"connect_timeout": 500,
"socket_timeout": 3000
},
"fallback_answer_url": {
"address": "https://fallback.example.com/webhooks/answer",
"http_method": "GET",
"connect_timeout": 500,
"socket_timeout": 3000
},
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
}
},
"signed_callbacks": false,
"conversations_ttl": 12,
"leg_persistence_time": 10,
"region": "eu-west"
},
"rtc": {
"webhooks": {
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST"
}
},
"signed_callbacks": false
},
"messages": {
"version": "string",
"webhooks": {
"inbound_url": {
"address": "https://example.com/webhooks/inbound",
"http_method": "POST"
},
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"vbc": {},
"network_apis": {
"network_application_id": "2bzfIFqRG128IcjSj1YhZNtw6LADG",
"redirect_uri": "https://my-redirect-uri.example.com"
},
"meetings": {
"webhooks": {
"recording_changed": {
"address": "https://example.com/webhooks/recordings",
"http_method": "POST"
},
"room_changed": {
"address": "https://example.com/webhooks/rooms",
"http_method": "POST"
},
"session_changed": {
"address": "https://example.com/webhooks/sessions",
"http_method": "POST"
}
}
},
"verify": {
"webhooks": {
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"video": {
"webhooks": {
"archive_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_notification": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"render_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"captions_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"broadcast_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_updated": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_mute_forced": {
"address": "https://example.com/webhooks/event",
"active": true
}
},
"storage": {
"server_side_encryption": false,
"end_to_end_encryption": false,
"cloud_storage": false
}
}
},
"privacy": {
"improve_ai": true
}
}{
"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": {
"voice": {
"webhooks": {
"answer_url": {
"address": "https://example.com/webhooks/answer",
"http_method": "GET",
"connect_timeout": 500,
"socket_timeout": 3000
},
"fallback_answer_url": {
"address": "https://fallback.example.com/webhooks/answer",
"http_method": "GET",
"connect_timeout": 500,
"socket_timeout": 3000
},
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
}
},
"signed_callbacks": false,
"conversations_ttl": 12,
"leg_persistence_time": 10,
"region": "eu-west"
},
"rtc": {
"webhooks": {
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST"
}
},
"signed_callbacks": false
},
"messages": {
"version": "string",
"webhooks": {
"inbound_url": {
"address": "https://example.com/webhooks/inbound",
"http_method": "POST"
},
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"vbc": {},
"network_apis": {
"network_application_id": "2bzfIFqRG128IcjSj1YhZNtw6LADG",
"redirect_uri": "https://my-redirect-uri.example.com"
},
"meetings": {
"webhooks": {
"recording_changed": {
"address": "https://example.com/webhooks/recordings",
"http_method": "POST"
},
"room_changed": {
"address": "https://example.com/webhooks/rooms",
"http_method": "POST"
},
"session_changed": {
"address": "https://example.com/webhooks/sessions",
"http_method": "POST"
}
}
},
"verify": {
"webhooks": {
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"video": {
"webhooks": {
"archive_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_notification": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"render_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"captions_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"broadcast_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_updated": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_mute_forced": {
"address": "https://example.com/webhooks/event",
"active": true
}
},
"storage": {
"server_side_encryption": false,
"end_to_end_encryption": false,
"cloud_storage": false
}
}
},
"privacy": {
"improve_ai": true
}
}78d335fa-323d-0114-9c3d-d6f0d48968cfThe application's ID
My ApplicationFriendly identifier for your application. This is not unique
Configuration for the products available in this application
Voice related configuration
https://example.com/webhooks/answerThe URL that Vonage requests when a call is placed/received. Must return an NCCO
POSTThe HTTP method used to fetch your NCCO from your answer_url
500If 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.
3000If 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.
https://fallback.example.com/webhooks/answerIf 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.
POSTThe HTTP method used to fetch your NCCO from your answer_url
500Connection timeout in milliseconds
3000Reading timeout in milliseconds
https://example.com/webhooks/eventThe URL that Vonage sends events related to your call to
POSTThe HTTP method used to send events to your server
500If 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.
3000If 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.
trueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
190004812The length of time named conversations will remain active for after creation, in hours. Maximum value is 9000 (i.e. 365 days).
131210The persistence duration for legs, in days. Maximum value is 31.
eu-westSelecting a region means all inbound, programmable SIP and SIP connect calls will be sent to the selected region unless the call is sent to a regional endpoint, if the call is using a regional endpoint this will override the application setting.
na-eastna-westeu-easteu-westapac-sngapac-australiaMessages / Dispatch related configuration
https://example.com/webhooks/inboundThe URL that Vonage forwards inbound messages to on your server
POSTThe HTTP method used to send inbound messages to your server
https://example.com/webhooks/statusThe URL that Vonage sends events related to your messages to
POSTThe HTTP method used to send events to your server (always POST)
RTC / Conversation Service related configuration
https://example.com/webhooks/eventPOSTtrueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.
Network APIs
2bzfIFqRG128IcjSj1YhZNtw6LADGhttps://my-redirect-uri.example.comMeetings related configuration
https://example.com/webhooks/recordingsThe URL that Vonage forwards recording information to on your server
POSTThe HTTP method used to send recording information to your server (always POST)
https://example.com/webhooks/roomsThe URL that Vonage forwards meeting room information on your server.
POSTThe HTTP method used to send meeting room information to your server (always POST)
https://example.com/webhooks/sessionsThe URL that Vonage forwards session information on your server.
POSTThe HTTP method used to send session information to your server (always POST)
Verify v2 related configuration
v2The version of the Verify API to use
https://example.com/webhooks/statusThe URL that Vonage sends events related to your verify requests to
POSTThe HTTP method used to send events to your server (always POST)
Video related configuration
https://example.com/webhooks/eventThe URL that Vonage sends events informing about the archive status
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends session notifications to
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a render status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when captions status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a broadcast status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is updated
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is muted
trueWhether the webhook is active
Whether to use server-side encryption
Whether to use end-to-end encryption
Whether to use cloud storage feature
Application privacy config
trueIf set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCA
KOxjsU4pf/sMFi9N0jqcSLcjxu33G
d/vynKnlw9SENi+UZR44GdjGdmfm1
tL1eA7IBh2HNnkYXnAwYzKJoa4eO3
0kYWekeIZawIwe/g9faFgkev+1xsO
OUNhPx2LhuLmgwWSRS4L5W851Xe3f
UQIDAQAB
-----END PUBLIC KEY-----
-----BEGIN PRIVATE KEY-----
MIIEvQIBADANBgkqhkiG9w0BAQEFA
ASCBKcwggSjAgEAAoIBAQDEPpvi+3
RH1efQ\nkveWzZDrNNoEXmBw61w+O
0u/N36tJnN5XnYecU64yHzu2ByEr0
7iIvYbavFnADwl\nHMTJwqDQakpa3
8/SFRnTDq3zronvNZ6nOp7S6K7pcZ
rw/CvrL6hXT1x7cGBZ4jPx\nqhjqY
uJPgZD7OVB69oYOV92vIIJ7JLYwqb
-----END PRIVATE KEY-----
Example Response
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"name": "My Application",
"capabilities": {
"voice": {
"webhooks": {
"answer_url": {
"address": "https://example.com/webhooks/answer",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
},
"fallback_answer_url": {
"address": "https://fallback.example.com/webhooks/answer",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
},
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
}
},
"signed_callbacks": false,
"conversations_ttl": 12,
"leg_persistence_time": 10,
"region": "eu-west"
},
"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": {
"webhooks": {
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST"
}
},
"signed_callbacks": false
},
"vbc": {},
"network_apis": {
"network_application_id": "2bzfIFqRG128IcjSj1YhZNtw6LADG",
"redirect_uri": "https://my-redirect-uri.example.com"
},
"meetings": {
"webhooks": {
"recording_changed": {
"address": "https://example.com/webhooks/recordings",
"http_method": "POST"
},
"room_changed": {
"address": "https://example.com/webhooks/rooms",
"http_method": "POST"
},
"session_changed": {
"address": "https://example.com/webhooks/sessions",
"http_method": "POST"
}
}
},
"verify": {
"version": "v2",
"webhooks": {
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"video": {
"webhooks": {
"archive_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_notification": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"render_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"captions_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"broadcast_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_updated": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_mute_forced": {
"address": "https://example.com/webhooks/event",
"active": true
}
},
"storage": {
"server_side_encryption": false,
"end_to_end_encryption": false,
"cloud_storage": false
}
}
},
"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"
}
}Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
78d335fa-323d-0114-9c3d-d6f0d48968cfThe application's ID
My ApplicationFriendly identifier for your application. This is not unique
Configuration for the products available in this application
Voice related configuration
https://example.com/webhooks/answerThe URL that Vonage requests when a call is placed/received. Must return an NCCO
POSTThe HTTP method used to fetch your NCCO from your answer_url
500If 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.
3000If 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.
https://fallback.example.com/webhooks/answerIf 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.
POSTThe HTTP method used to fetch your NCCO from your answer_url
500Connection timeout in milliseconds
3000Reading timeout in milliseconds
https://example.com/webhooks/eventThe URL that Vonage sends events related to your call to
POSTThe HTTP method used to send events to your server
500If 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.
3000If 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.
trueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
190004812The length of time named conversations will remain active for after creation, in hours. Maximum value is 9000 (i.e. 365 days).
131210The persistence duration for legs, in days. Maximum value is 31.
eu-westSelecting a region means all inbound, programmable SIP and SIP connect calls will be sent to the selected region unless the call is sent to a regional endpoint, if the call is using a regional endpoint this will override the application setting.
na-eastna-westeu-easteu-westapac-sngapac-australiaMessages / Dispatch related configuration
https://example.com/webhooks/inboundThe URL that Vonage forwards inbound messages to on your server
POSTThe HTTP method used to send inbound messages to your server
https://example.com/webhooks/statusThe URL that Vonage sends events related to your messages to
POSTThe HTTP method used to send events to your server (always POST)
RTC / Conversation Service related configuration
https://example.com/webhooks/eventPOSTtrueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.
Network APIs
2bzfIFqRG128IcjSj1YhZNtw6LADGhttps://my-redirect-uri.example.comMeetings related configuration
https://example.com/webhooks/recordingsThe URL that Vonage forwards recording information to on your server
POSTThe HTTP method used to send recording information to your server (always POST)
https://example.com/webhooks/roomsThe URL that Vonage forwards meeting room information on your server.
POSTThe HTTP method used to send meeting room information to your server (always POST)
https://example.com/webhooks/sessionsThe URL that Vonage forwards session information on your server.
POSTThe HTTP method used to send session information to your server (always POST)
Verify v2 related configuration
v2The version of the Verify API to use
https://example.com/webhooks/statusThe URL that Vonage sends events related to your verify requests to
POSTThe HTTP method used to send events to your server (always POST)
Video related configuration
https://example.com/webhooks/eventThe URL that Vonage sends events informing about the archive status
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends session notifications to
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a render status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when captions status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a broadcast status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is updated
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is muted
trueWhether the webhook is active
Whether to use server-side encryption
Whether to use end-to-end encryption
Whether to use cloud storage feature
Application privacy config
trueIf set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.
Example Response
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"name": "My Application",
"capabilities": {
"voice": {
"webhooks": {
"answer_url": {
"address": "https://example.com/webhooks/answer",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
},
"fallback_answer_url": {
"address": "https://fallback.example.com/webhooks/answer",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
},
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
}
},
"signed_callbacks": false,
"conversations_ttl": 12,
"leg_persistence_time": 10,
"region": "eu-west"
},
"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": {
"webhooks": {
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST"
}
},
"signed_callbacks": false
},
"vbc": {},
"network_apis": {
"network_application_id": "2bzfIFqRG128IcjSj1YhZNtw6LADG",
"redirect_uri": "https://my-redirect-uri.example.com"
},
"meetings": {
"webhooks": {
"recording_changed": {
"address": "https://example.com/webhooks/recordings",
"http_method": "POST"
},
"room_changed": {
"address": "https://example.com/webhooks/rooms",
"http_method": "POST"
},
"session_changed": {
"address": "https://example.com/webhooks/sessions",
"http_method": "POST"
}
}
},
"verify": {
"version": "v2",
"webhooks": {
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"video": {
"webhooks": {
"archive_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_notification": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"render_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"captions_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"broadcast_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_updated": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_mute_forced": {
"address": "https://example.com/webhooks/event",
"active": true
}
},
"storage": {
"server_side_encryption": false,
"end_to_end_encryption": false,
"cloud_storage": false
}
}
},
"privacy": {
"improve_ai": true
}
}Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Demo ApplicationApplication Name
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCA
KOxjsU4pf/sMFi9N0jqcSLcjxu33G
d/vynKnlw9SENi+UZR44GdjGdmfm1
tL1eA7IBh2HNnkYXnAwYzKJoa4eO3
0kYWekeIZawIwe/g9faFgkev+1xsO
OUNhPx2LhuLmgwWSRS4L5W851Xe3f
UQIDAQAB
-----END PUBLIC KEY-----
Public key
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.
Voice application webhook config
The URL that Vonage make a request to when a call is placed/received. Must return an NCCO
https://example.com/webhooks/answerGETGETPOST30010001000500If 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.
1000500050003000If 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.
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
https://fallback.example.com/webhooks/answerGETGETPOST30010001000500If 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.
1000500050003000If 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.
Vonage will send call events (e.g. ringing, answered) to this URL
https://example.com/webhooks/eventPOSTGETPOST30010001000500If 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.
100010000100003000If 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.
trueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
190004812The length of time named conversations will remain active for after creation, in hours. Maximum value is 9000 (i.e. 365 days).
131210The persistence duration for legs, in days. Maximum value is 31.
eu-westSelecting a region means all inbound, programmable SIP and SIP connect calls will be sent to the selected region unless the call is sent to a regional endpoint, if the call is using a regional endpoint this will override the application setting.
na-eastna-westeu-easteu-westapac-sngapac-australiaRTC / Client SDK application webhook config
Vonage will send RTC events to this URL
https://example.com/webhooks/eventPOSTGETPOSTtrueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
Messages and Dispatch application webhook config
Vonage will forward inbound messages to this URL
https://example.com/webhooks/inboundPOSTPOSTVonage will send message status updates (e.g. delivered, seen) to this URL
https://example.com/webhooks/statusPOSTPOSTSpecify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This must be an empty object.
Network APIs
2bzfIFqRG128IcjSj1YhZNtw6LADGhttps://my-redirect-uri.example.comMeetings related configuration
The URL that Vonage forwards recording information to on your server
https://example.com/webhooks/recordingsPOSTPOSTThe URL that Vonage forwards meeting room information on your server.
https://example.com/webhooks/roomsPOSTPOSTThe URL that Vonage forwards session information on your server.
https://example.com/webhooks/sessionsPOSTPOSTVideo related configuration
https://example.com/webhooks/eventThe URL that Vonage sends events informing about the archive status
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends session notifications to
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a render status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when captions status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a broadcast status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is updated
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is muted
trueWhether the webhook is active
Whether to use server-side encryption
Whether to use end-to-end encryption
Whether to use cloud storage feature
Application privacy config
trueIf set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.
Example Request
{
"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": {
"voice": {
"webhooks": {
"answer_url": {
"address": "https://example.com/webhooks/answer",
"http_method": "GET",
"connect_timeout": 500,
"socket_timeout": 3000
},
"fallback_answer_url": {
"address": "https://fallback.example.com/webhooks/answer",
"http_method": "GET",
"connect_timeout": 500,
"socket_timeout": 3000
},
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
}
},
"signed_callbacks": false,
"conversations_ttl": 12,
"leg_persistence_time": 10,
"region": "eu-west"
},
"rtc": {
"webhooks": {
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST"
}
},
"signed_callbacks": false
},
"messages": {
"webhooks": {
"inbound_url": {
"address": "https://example.com/webhooks/inbound",
"http_method": "POST"
},
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"vbc": {},
"network_apis": {
"network_application_id": "2bzfIFqRG128IcjSj1YhZNtw6LADG",
"redirect_uri": "https://my-redirect-uri.example.com"
},
"meetings": {
"webhooks": {
"recording_url": {
"address": "https://example.com/webhooks/recordings",
"http_method": "POST"
},
"rooms_url": {
"address": "https://example.com/webhooks/rooms",
"http_method": "POST"
},
"sessions_url": {
"address": "https://example.com/webhooks/sessions",
"http_method": "POST"
}
}
},
"video": {
"webhooks": {
"archive_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_notification": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"render_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"captions_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"broadcast_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_updated": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_mute_forced": {
"address": "https://example.com/webhooks/event",
"active": true
}
},
"storage": {
"server_side_encryption": false,
"end_to_end_encryption": false,
"cloud_storage": false
}
}
},
"privacy": {
"improve_ai": true
}
}{
"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": {
"voice": {
"webhooks": {
"answer_url": {
"address": "https://example.com/webhooks/answer",
"http_method": "GET",
"connect_timeout": 500,
"socket_timeout": 3000
},
"fallback_answer_url": {
"address": "https://fallback.example.com/webhooks/answer",
"http_method": "GET",
"connect_timeout": 500,
"socket_timeout": 3000
},
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
}
},
"signed_callbacks": false,
"conversations_ttl": 12,
"leg_persistence_time": 10,
"region": "eu-west"
},
"rtc": {
"webhooks": {
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST"
}
},
"signed_callbacks": false
},
"messages": {
"webhooks": {
"inbound_url": {
"address": "https://example.com/webhooks/inbound",
"http_method": "POST"
},
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"vbc": {},
"network_apis": {
"network_application_id": "2bzfIFqRG128IcjSj1YhZNtw6LADG",
"redirect_uri": "https://my-redirect-uri.example.com"
},
"meetings": {
"webhooks": {
"recording_url": {
"address": "https://example.com/webhooks/recordings",
"http_method": "POST"
},
"rooms_url": {
"address": "https://example.com/webhooks/rooms",
"http_method": "POST"
},
"sessions_url": {
"address": "https://example.com/webhooks/sessions",
"http_method": "POST"
}
}
},
"video": {
"webhooks": {
"archive_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_notification": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"render_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"captions_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"broadcast_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_updated": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_mute_forced": {
"address": "https://example.com/webhooks/event",
"active": true
}
},
"storage": {
"server_side_encryption": false,
"end_to_end_encryption": false,
"cloud_storage": false
}
}
},
"privacy": {
"improve_ai": true
}
}78d335fa-323d-0114-9c3d-d6f0d48968cfThe application's ID
My ApplicationFriendly identifier for your application. This is not unique
Configuration for the products available in this application
Voice related configuration
https://example.com/webhooks/answerThe URL that Vonage requests when a call is placed/received. Must return an NCCO
POSTThe HTTP method used to fetch your NCCO from your answer_url
500If 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.
3000If 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.
https://fallback.example.com/webhooks/answerIf 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.
POSTThe HTTP method used to fetch your NCCO from your answer_url
500Connection timeout in milliseconds
3000Reading timeout in milliseconds
https://example.com/webhooks/eventThe URL that Vonage sends events related to your call to
POSTThe HTTP method used to send events to your server
500If 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.
3000If 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.
trueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
190004812The length of time named conversations will remain active for after creation, in hours. Maximum value is 9000 (i.e. 365 days).
131210The persistence duration for legs, in days. Maximum value is 31.
eu-westSelecting a region means all inbound, programmable SIP and SIP connect calls will be sent to the selected region unless the call is sent to a regional endpoint, if the call is using a regional endpoint this will override the application setting.
na-eastna-westeu-easteu-westapac-sngapac-australiaMessages / Dispatch related configuration
https://example.com/webhooks/inboundThe URL that Vonage forwards inbound messages to on your server
POSTThe HTTP method used to send inbound messages to your server
https://example.com/webhooks/statusThe URL that Vonage sends events related to your messages to
POSTThe HTTP method used to send events to your server (always POST)
RTC / Conversation Service related configuration
https://example.com/webhooks/eventPOSTtrueWhether to use signed webhooks. This is a way of verifying that the request is coming from Vonage. Refer to the Webhooks documentation for more information.
Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.
Network APIs
2bzfIFqRG128IcjSj1YhZNtw6LADGhttps://my-redirect-uri.example.comMeetings related configuration
https://example.com/webhooks/recordingsThe URL that Vonage forwards recording information to on your server
POSTThe HTTP method used to send recording information to your server (always POST)
https://example.com/webhooks/roomsThe URL that Vonage forwards meeting room information on your server.
POSTThe HTTP method used to send meeting room information to your server (always POST)
https://example.com/webhooks/sessionsThe URL that Vonage forwards session information on your server.
POSTThe HTTP method used to send session information to your server (always POST)
Verify v2 related configuration
v2The version of the Verify API to use
https://example.com/webhooks/statusThe URL that Vonage sends events related to your verify requests to
POSTThe HTTP method used to send events to your server (always POST)
Video related configuration
https://example.com/webhooks/eventThe URL that Vonage sends events informing about the archive status
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video connection is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a video session is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends session notifications to
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a stream is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a render status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when captions status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a broadcast status changes
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is created
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is updated
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is destroyed
trueWhether the webhook is active
https://example.com/webhooks/eventThe URL that Vonage sends events when a sip call is muted
trueWhether the webhook is active
Whether to use server-side encryption
Whether to use end-to-end encryption
Whether to use cloud storage feature
Application privacy config
trueIf set to true, Vonage may store and use your content and data for the improvement of Vonage's AI based services and technologies.
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCA
KOxjsU4pf/sMFi9N0jqcSLcjxu33G
d/vynKnlw9SENi+UZR44GdjGdmfm1
tL1eA7IBh2HNnkYXnAwYzKJoa4eO3
0kYWekeIZawIwe/g9faFgkev+1xsO
OUNhPx2LhuLmgwWSRS4L5W851Xe3f
UQIDAQAB
-----END PUBLIC KEY-----
-----BEGIN PRIVATE KEY-----
MIIEvQIBADANBgkqhkiG9w0BAQEFA
ASCBKcwggSjAgEAAoIBAQDEPpvi+3
RH1efQ\nkveWzZDrNNoEXmBw61w+O
0u/N36tJnN5XnYecU64yHzu2ByEr0
7iIvYbavFnADwl\nHMTJwqDQakpa3
8/SFRnTDq3zronvNZ6nOp7S6K7pcZ
rw/CvrL6hXT1x7cGBZ4jPx\nqhjqY
uJPgZD7OVB69oYOV92vIIJ7JLYwqb
-----END PRIVATE KEY-----
Example Response
{
"id": "78d335fa-323d-0114-9c3d-d6f0d48968cf",
"name": "My Application",
"capabilities": {
"voice": {
"webhooks": {
"answer_url": {
"address": "https://example.com/webhooks/answer",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
},
"fallback_answer_url": {
"address": "https://fallback.example.com/webhooks/answer",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
},
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST",
"connect_timeout": 500,
"socket_timeout": 3000
}
},
"signed_callbacks": false,
"conversations_ttl": 12,
"leg_persistence_time": 10,
"region": "eu-west"
},
"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": {
"webhooks": {
"event_url": {
"address": "https://example.com/webhooks/event",
"http_method": "POST"
}
},
"signed_callbacks": false
},
"vbc": {},
"network_apis": {
"network_application_id": "2bzfIFqRG128IcjSj1YhZNtw6LADG",
"redirect_uri": "https://my-redirect-uri.example.com"
},
"meetings": {
"webhooks": {
"recording_changed": {
"address": "https://example.com/webhooks/recordings",
"http_method": "POST"
},
"room_changed": {
"address": "https://example.com/webhooks/rooms",
"http_method": "POST"
},
"session_changed": {
"address": "https://example.com/webhooks/sessions",
"http_method": "POST"
}
}
},
"verify": {
"version": "v2",
"webhooks": {
"status_url": {
"address": "https://example.com/webhooks/status",
"http_method": "POST"
}
}
},
"video": {
"webhooks": {
"archive_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"connection_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"session_notification": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"stream_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"render_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"captions_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"broadcast_status": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_created": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_updated": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_destroyed": {
"address": "https://example.com/webhooks/event",
"active": true
},
"sip_call_mute_forced": {
"address": "https://example.com/webhooks/event",
"active": true
}
},
"storage": {
"server_side_encryption": false,
"end_to_end_encryption": false,
"cloud_storage": false
}
}
},
"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"
}
}Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Base64 encoded API key and secret joined by a colon. | Headers | Basic <base64> |
Available Operations
Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Your JSON web token. | Headers | Bearer <JWT> |
Query Parameters
11001010Return this amount of records in the response
ascReturn the records in ascending or descending order.
ascdescASCDESCThe cursor to start returning results from.
You are not expected to provide this manually, but to follow the url provided in _links.next.href or _links.prev.href in the response which contains a cursor value.
my_user_nameUnique name for a user
11001010The amount of records returned in this response
A list of user objects. See the get details of a specific user response fields for a description of the nested objects
List of users matching the provided filter
USR-82e028d9-5201-4f1e-8188-604b2d3471ecUser ID
my_user_nameUnique name for a user
My User NameA string to be displayed as user name. It does not need to be unique
https://api.nexmo.com/v1/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ecA series of links between resources in this API in the http://stateless.co/hal_specification.html.
https://api.nexmo.com/v1/users?order=desc&page_size=10https://api.nexmo.com/v1/users?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3Dhttps://api.nexmo.com/v1/users?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3Dhttps://api.nexmo.com/v1/users?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3DExample Response
{
"page_size": 10,
"_embedded": {
"users": [
{
"id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
"name": "my_user_name",
"display_name": "My User Name",
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec"
}
}
}
]
},
"_links": {
"first": {
"href": "https://api.nexmo.com/v1/users?order=desc&page_size=10"
},
"self": {
"href": "https://api.nexmo.com/v1/users?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
},
"next": {
"href": "https://api.nexmo.com/v1/users?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
},
"prev": {
"href": "https://api.nexmo.com/v1/users?order=desc&page_size=10&cursor=7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg%3D"
}
}
}Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Your JSON web token. | Headers | Bearer <JWT> |
my_user_nameUnique name for a user
My User NameA string to be displayed as user name. It does not need to be unique
https://example.com/image.pngAn image URL that you associate with the user
User properties
{
"custom_key": "custom_value"
}custom key/value pairs
21474836483600Time to live in seconds
123457sip:4442138907@sip.example.com;transport=tlsValue must match regular expression ^(sip|sips):\+?([\w|:.\-@;,=%&]+)
New SIPPassword403wss://example.com/socketValue must match regular expression ^(ws|wss)://[a-zA-Z0-9~#%@&-_?\/.,:;)(][]*$
audio/l16;rate=16000audio/l16;rate=8000audio/l16;rate=16000Details of the Websocket to connect to
ABC123This is an example header. You can provide any headers you may need
44770090000044770090000044770090000044770090000012345abcdExample Request
{
"name": "my_user_name",
"display_name": "My User Name",
"image_url": "https://example.com/image.png",
"properties": {
"custom_data": {
"custom_key": "custom_value"
},
"ttl": 3600
},
"channels": {
"pstn": [
{
"number": 123457
}
],
"sip": [
{
"uri": "sip:4442138907@sip.example.com;transport=tls",
"username": "New SIP",
"password": "Password"
}
],
"vbc": [
{
"extension": "403"
}
],
"websocket": [
{
"uri": "wss://example.com/socket",
"content-type": "audio/l16;rate=16000",
"headers": {
"customer_id": "ABC123"
}
}
],
"sms": [
{
"number": "447700900000"
}
],
"mms": [
{
"number": "447700900000"
}
],
"whatsapp": [
{
"number": "447700900000"
}
],
"viber": [
{
"number": "447700900000"
}
],
"messenger": [
{
"id": "12345abcd"
}
]
}
}{
"name": "my_user_name",
"display_name": "My User Name",
"image_url": "https://example.com/image.png",
"properties": {
"custom_data": {
"custom_key": "custom_value"
},
"ttl": 3600
},
"channels": {
"pstn": [
{
"number": 123457
}
],
"sip": [
{
"uri": "sip:4442138907@sip.example.com;transport=tls",
"username": "New SIP",
"password": "Password"
}
],
"vbc": [
{
"extension": "403"
}
],
"websocket": [
{
"uri": "wss://example.com/socket",
"content-type": "audio/l16;rate=16000",
"headers": {
"customer_id": "ABC123"
}
}
],
"sms": [
{
"number": "447700900000"
}
],
"mms": [
{
"number": "447700900000"
}
],
"whatsapp": [
{
"number": "447700900000"
}
],
"viber": [
{
"number": "447700900000"
}
],
"messenger": [
{
"id": "12345abcd"
}
]
}
}USR-82e028d9-5201-4f1e-8188-604b2d3471ecUser ID
my_user_nameUnique name for a user
My User NameA string to be displayed as user name. It does not need to be unique
https://example.com/image.pngAn image URL that you associate with the user
User properties
{
"custom_key": "custom_value"
}custom key/value pairs
21474836483600Time to live in seconds
123457sip:4442138907@sip.example.com;transport=tlsValue must match regular expression ^(sip|sips):\+?([\w|:.\-@;,=%&]+)
New SIPPassword403wss://example.com/socketValue must match regular expression ^(ws|wss)://[a-zA-Z0-9~#%@&-_?\/.,:;)(][]*$
audio/l16;rate=16000audio/l16;rate=8000audio/l16;rate=16000Details of the Websocket to connect to
ABC123This is an example header. You can provide any headers you may need
44770090000044770090000044770090000044770090000012345abcdhttps://api.nexmo.com/v1/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ecExample Response
{
"id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
"name": "my_user_name",
"display_name": "My User Name",
"image_url": "https://example.com/image.png",
"properties": {
"custom_data": {
"custom_key": "custom_value"
},
"ttl": 3600
},
"channels": {
"pstn": [
{
"number": 123457
}
],
"sip": [
{
"uri": "sip:4442138907@sip.example.com;transport=tls",
"username": "New SIP",
"password": "Password"
}
],
"vbc": [
{
"extension": "403"
}
],
"websocket": [
{
"uri": "wss://example.com/socket",
"content-type": "audio/l16;rate=16000",
"headers": {
"customer_id": "ABC123"
}
}
],
"sms": [
{
"number": "447700900000"
}
],
"mms": [
{
"number": "447700900000"
}
],
"whatsapp": [
{
"number": "447700900000"
}
],
"viber": [
{
"number": "447700900000"
}
],
"messenger": [
{
"id": "12345abcd"
}
]
},
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec"
}
}
}Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Your JSON web token. | Headers | Bearer <JWT> |
USR-82e028d9-5201-4f1e-8188-604b2d3471ecUser ID
my_user_nameUnique name for a user
My User NameA string to be displayed as user name. It does not need to be unique
https://example.com/image.pngAn image URL that you associate with the user
User properties
{
"custom_key": "custom_value"
}custom key/value pairs
21474836483600Time to live in seconds
123457sip:4442138907@sip.example.com;transport=tlsValue must match regular expression ^(sip|sips):\+?([\w|:.\-@;,=%&]+)
New SIPPassword403wss://example.com/socketValue must match regular expression ^(ws|wss)://[a-zA-Z0-9~#%@&-_?\/.,:;)(][]*$
audio/l16;rate=16000audio/l16;rate=8000audio/l16;rate=16000Details of the Websocket to connect to
ABC123This is an example header. You can provide any headers you may need
44770090000044770090000044770090000044770090000012345abcdhttps://api.nexmo.com/v1/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ecExample Response
{
"id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
"name": "my_user_name",
"display_name": "My User Name",
"image_url": "https://example.com/image.png",
"properties": {
"custom_data": {
"custom_key": "custom_value"
},
"ttl": 3600
},
"channels": {
"pstn": [
{
"number": 123457
}
],
"sip": [
{
"uri": "sip:4442138907@sip.example.com;transport=tls",
"username": "New SIP",
"password": "Password"
}
],
"vbc": [
{
"extension": "403"
}
],
"websocket": [
{
"uri": "wss://example.com/socket",
"content-type": "audio/l16;rate=16000",
"headers": {
"customer_id": "ABC123"
}
}
],
"sms": [
{
"number": "447700900000"
}
],
"mms": [
{
"number": "447700900000"
}
],
"whatsapp": [
{
"number": "447700900000"
}
],
"viber": [
{
"number": "447700900000"
}
],
"messenger": [
{
"id": "12345abcd"
}
]
},
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec"
}
}
}Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Your JSON web token. | Headers | Bearer <JWT> |
my_user_nameUnique name for a user
My User NameA string to be displayed as user name. It does not need to be unique
https://example.com/image.pngAn image URL that you associate with the user
123457sip:4442138907@sip.example.com;transport=tlsValue must match regular expression ^(sip|sips):\+?([\w|:.\-@;,=%&]+)
New SIPPassword403wss://example.com/socketValue must match regular expression ^(ws|wss)://[a-zA-Z0-9~#%@&-_?\/.,:;)(][]*$
audio/l16;rate=16000audio/l16;rate=8000audio/l16;rate=16000Details of the Websocket to connect to
ABC123This is an example header. You can provide any headers you may need
44770090000044770090000044770090000044770090000012345abcdExample Request
{
"name": "my_user_name",
"display_name": "My User Name",
"image_url": "https://example.com/image.png",
"channels": {
"pstn": [
{
"number": 123457
}
],
"sip": [
{
"uri": "sip:4442138907@sip.example.com;transport=tls",
"username": "New SIP",
"password": "Password"
}
],
"vbc": [
{
"extension": "403"
}
],
"websocket": [
{
"uri": "wss://example.com/socket",
"content-type": "audio/l16;rate=16000",
"headers": {
"customer_id": "ABC123"
}
}
],
"sms": [
{
"number": "447700900000"
}
],
"mms": [
{
"number": "447700900000"
}
],
"whatsapp": [
{
"number": "447700900000"
}
],
"viber": [
{
"number": "447700900000"
}
],
"messenger": [
{
"id": "12345abcd"
}
]
}
}{
"name": "my_user_name",
"display_name": "My User Name",
"image_url": "https://example.com/image.png",
"channels": {
"pstn": [
{
"number": 123457
}
],
"sip": [
{
"uri": "sip:4442138907@sip.example.com;transport=tls",
"username": "New SIP",
"password": "Password"
}
],
"vbc": [
{
"extension": "403"
}
],
"websocket": [
{
"uri": "wss://example.com/socket",
"content-type": "audio/l16;rate=16000",
"headers": {
"customer_id": "ABC123"
}
}
],
"sms": [
{
"number": "447700900000"
}
],
"mms": [
{
"number": "447700900000"
}
],
"whatsapp": [
{
"number": "447700900000"
}
],
"viber": [
{
"number": "447700900000"
}
],
"messenger": [
{
"id": "12345abcd"
}
]
}
}USR-82e028d9-5201-4f1e-8188-604b2d3471ecUser ID
my_user_nameUnique name for a user
My User NameA string to be displayed as user name. It does not need to be unique
https://example.com/image.pngAn image URL that you associate with the user
User properties
{
"custom_key": "custom_value"
}custom key/value pairs
21474836483600Time to live in seconds
123457sip:4442138907@sip.example.com;transport=tlsValue must match regular expression ^(sip|sips):\+?([\w|:.\-@;,=%&]+)
New SIPPassword403wss://example.com/socketValue must match regular expression ^(ws|wss)://[a-zA-Z0-9~#%@&-_?\/.,:;)(][]*$
audio/l16;rate=16000audio/l16;rate=8000audio/l16;rate=16000Details of the Websocket to connect to
ABC123This is an example header. You can provide any headers you may need
44770090000044770090000044770090000044770090000012345abcdhttps://api.nexmo.com/v1/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ecExample Response
{
"id": "USR-82e028d9-5201-4f1e-8188-604b2d3471ec",
"name": "my_user_name",
"display_name": "My User Name",
"image_url": "https://example.com/image.png",
"properties": {
"custom_data": {
"custom_key": "custom_value"
},
"ttl": 3600
},
"channels": {
"pstn": [
{
"number": 123457
}
],
"sip": [
{
"uri": "sip:4442138907@sip.example.com;transport=tls",
"username": "New SIP",
"password": "Password"
}
],
"vbc": [
{
"extension": "403"
}
],
"websocket": [
{
"uri": "wss://example.com/socket",
"content-type": "audio/l16;rate=16000",
"headers": {
"customer_id": "ABC123"
}
}
],
"sms": [
{
"number": "447700900000"
}
],
"mms": [
{
"number": "447700900000"
}
],
"whatsapp": [
{
"number": "447700900000"
}
],
"viber": [
{
"number": "447700900000"
}
],
"messenger": [
{
"id": "12345abcd"
}
]
},
"_links": {
"self": {
"href": "https://api.nexmo.com/v1/users/USR-82e028d9-5201-4f1e-8188-604b2d3471ec"
}
}
}Authentication
| Key | Description | Where | Example |
|---|---|---|---|
| Authorization | Your JSON web token. | Headers | Bearer <JWT> |
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 | Information |
|---|---|
| payload-validation | Description Invalid request. See Resolution Review the documentation and send a valid |
| list-validation | Description Invalid request. See Resolution Review the documentation and send a valid |
| rate-limit | Description The request was rate limited Resolution The Redact API supports 170 requests per second. Reduce the frequency of your requests. |