Get Call Center Extension

Prev Next
Get
/api/v1/omnichannel/extension

Permission required: manage-agent-extension-association

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
userId
stringRequired

The value of the user ID. Alternatively, you can enter the username parameter.

type
stringRequired

The type of extension. The values can be: free, allocated, and available

Responses
200

OK

Success Example
{
  "extensions": "10023"
}
object
extensions
string
400

Bad Request

Example 1
{
  "success": false,
  "error": "Match error: Failed Match.OneOf, Match.Maybe or Match.Optional validation"
}
Example 2
{
  "success": false,
  "error": "Connection error"
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string
404

Not Found

Example 1
{
  "success": false,
  "error": "Extension not found"
}
object
success
boolean
error
string