When you have familiarized yourself with the Vonage Contact Center (VCC) APIs, you might want to run some requests.
| Panel | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
How do I try out Vonage Contact Center APIs?
To enable you to quickly try out the APIs, we have provided them in a Postman collection.
| Warning | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Running API requests in Postman runs the endpoints on your LIVE data. You will be viewing, creating, updating, and deleting real data. | ||||||||||||||
| Panel | ||||||||||||||
| ||||||||||||||
What is a Postman collection?
Postman collections are groups of API endpoints that you can send requests to. Vonage Contact Center API endpoints are stored within a collection that you can run to get, create, update, and delete data. For more information about Postman collections, see Postman help.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
How do I get the Postman collection?
...
Click Fork Collection. The forked API collection appears within your chosen workspace. We recommend that you watch for changes in the source collection, so that you can see when you need to pull changes into the forked collection. To watch the source collection, click Watch on the home tab of the forked source collection.
For more information about forking collections, including watching collections, see Postman help.
...
Some endpoints require a value that is part of the endpoint itself—this is a path parameter. For example, the GET /users/{userId} endpoint in the User Admin API requires a value for the userId parameter in the request. The endpoint uses the value to return data relating to the corresponding user only. In the path, replace <insert user ID here> with a specific userId.
| Code Block | ||||
|---|---|---|---|---|
| ||||
https://{{region}}.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79 |
...