Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

The PUT /users/{userId}/callbackNumbers endpoint replaces the user’s callback numbers for the user matching the user ID provided.

In this page


Most URLs in the example code use the following values:

Parameters

userID

Type

Required

Example

StringTrue2f9207ca-8922-4245-bfc5-d8f42939e29a

The user ID of the required user.

Requests

Example Request

curl -L -X PUT "https://***.api.newvoicemedia.com/useradmin/8e22b1fe-d2ea-403d-8c03-50eb21188e79/callbackNumbers" \
-H "Content-Type: application/json" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
--data-raw "<JSON BODY>"

Request body parameters

The endpoint requires a callbackNumbers object in JSON format as in the request body.

This endpoint replaces the agents callback numbers.

  • To add a new callback number, you must request the current callback number list and append the new callback number Id. 
  • To remove a new callback number, you must request the current callback number list and remove the target callback number Id from the list.

Example request body

{
  "callbackNumbers": [
    {
      "callbackNumberId": "118135e7-5a08-b79d-d4c7-ae65bbb7181c"
    }
  ]
}


where:

  • callbackNumbers. A list of callback numbers to assign to the user.
    • callbackNumberId. The unique ID of the callback number.

Responses

Successful response

Successful requests return a 200 Success code.

  • No labels