The GET /users/{userId}/callbackNumbers
endpoint gets a list of all callback numbers for the user matching the user ID provided.
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Parameters
The endpoint accepts the following query parameters:
userID
Type | Required | Example |
---|---|---|
String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The user ID of the required user.
limit
Type | Required | Example |
---|---|---|
integer | False | 25 |
The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.
page
Type | Required | Example |
---|---|---|
integer | False | 1 |
The required page. Minimum of 1, maximum of 1000000000. Default is 1.
Responses
Responses contain a list of all callback numbers for the user matching the user ID provided.
Successful response
Successful requests return a 200 Success
code and a collection of callback numbers.
Example response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"meta": {
"page": 1,
"count": 3,
"pageCount": 1,
"totalCount": 3
},
"userId": "2f9207ca-8922-4245-bfc5-d8f42939e29a",
"agentDisplayId": "9876",
"callbackNumbers": [
{
"callbackNumberId": "3be4802b-d8ec-4620-a4da-924d96dea63e",
"callbackNumberName": "test1",
"callbackNumberClid": "+48600000000"
},
{
"callbackNumberId": "c480e33b-611f-4744-a4cf-e99e17e11fbf",
"callbackNumberName": "test2",
"callbackNumberClid": "+48600000050"
},
{
"callbackNumberId": "3f33b43b-81c5-4638-ba38-3ece9047886a",
"callbackNumberName": "test3",
"callbackNumberClid": "+48600000009"
}
]
} |
where:
userId
. The unique ID of the user.agentDisplayId
. The agent's unique ID.callbackNumbers
. The callback numbers assigned to the user.callbackNumberId
. The unique ID of the callback number.callbackNumberName
. The name of the callback number.callbackNumberClid
. The actual callback number.