- TODO LIST
- Version
- Authentication
- Access Token (Oauth - Username/Password)
- API Key (Machine 2 Machine)
- JWT (JSON Web Token)
- Event Subscriptions
- Resellers
- Domains
- Phone Numbers
- Users
- Devices
- Phones/Macs
- Supported Models and Servers
- Phone Configurations
- Read Mac Addresses
- Count Mac Addresses
- Read Mac Addresses in Domain
- Read Specific Mac Address
- Read Specific Mac Addresses in Domain
- Add MAC address
- Add MAC address for Domain
- Update MAC address
- Update MAC address in Domain
- Remove MAC address
- Remove MAC address in Domain
- Sites
- Call Center
- Callqueues
- Agents
- Agent Actions
- QueuedCalls
- Statistics
- Get Callqueue Statistics for a Specific Queue
- Get Callqueue Statistics for all Queues Aggregated
- Get Callqueue Statistics for all Queues by Queue
- Get Agent Statistics for all Queues by Agent
- Get Agent Statistics for Single Queues by Agent
- Get Agent Statistics for Single Agent
- Get DNIS Statistics for all Queues
- Get DNIS Statistics for Single Queue
- Get Agent Log
- Send Call Center Email Report
- Get Abandoned Calls for all Queues
- Get Abandoned Calls for a Specific Queue
- Call Dispositions
- Answer Rules
- Call Blocking
- Auto Attendant
- Media
- Voicemail
- Greetings
- Read Greetings for User
- Count Greetings for User
- Read Specific Greeting for User
- Delete Specific Greeting for User
- Create a new Greeting from TTS
- Update Greeting with TTS script
- Create a new Greeting from Upload (JSON + Base64 File)
- Update Greeting from Upload (JSON + Base64 File)
- Create a new Greeting from Upload (Multipart/Mixed Post)
- Update Greeting from Upload (Multipart/Mixed Post)
- Music on Hold
- Domain
- Read MOH for Domain
- Count MOH for Domain
- Create a new MOH for Domain from TTS
- Update MOH for Domain from TTS
- Create a new MOH for Domain from Upload (JSON + Base64 File)
- Update MOH for Domain from Upload (JSON + Base64 File)
- Create a new MOH for Domain from Upload (Multipart/Mixed Post)
- Update MOH for Domain from Upload (Multipart/Mixed Post)
- Delete MOH for Domain
- User
- Read MOH for User
- Count MOH for User
- Create a new MOH for Domain from TTS
- Create a new MOH for User from Upload (JSON + Base64 File)
- Update MOH for User from Upload (JSON + Base64 File)
- Update MOH for Domain from TTS
- Create a new MOH for User from Upload (Multipart/Mixed Post)
- Update a MOH for User from Upload (Multipart/Mixed Post)
- Delete MOH for User
- Domain
- Hold Messages
- Text to Speech
- CDR (Call History)
- CDR Schedule
- Transcriptions & Sentiment
- Call Traces & Cradle to Grave
- Calls (live/active calls)
- Contacts
- Addresses
- Get Addresses for Domain
- Validate Address
- Create Address for Domain
- Update Address for Domain
- Update Address for User
- Update Address Endpoint
- Create Address for User
- Delete Address For User
- Delete Address Endpoint
- Delete Address For Domain
- Create Address Endpoint
- Get Address Endpoints for a Domain
- Get Addresses Count for Domain
- Get Addresses for User
- Get Address Using Address ID
- Voicemail Reminders
- Dialrule
- Read Dialrules in a Dialplan
- Count Dialrules in a Dialplan
- Read Specific Dialrule in a Dialplan
- Add a new dial rule into a dial plan
- Update a dial rule by ID in a dial plan
- Delete a dial rule by ID in a dial plan
- Read Dialplans
- Create Dialplan Global
- Create Dialplan for Domain
- Update Dialplan for Domain
- Delete Dialplan for Domain
- Dial Permisions
- Read Permissions/Policies
- Read Permissions in a DialPolicy
- Read Specific Permission in a Dialpolicy
- Add a new dial rule into a dial plan
- Update a dial rule by ID in a dial plan
- Delete a dial rule by ID in a dial plan
- Create Dialplan Global
- Create Dialplan for Domain
- Update Dialplan for Domain
- Delete Dialplan for Domain
- Messages
- Get Messagesessions for Domain
- Start a new Message Session
- Get Messagesessions for User
- Get Messages for Messagesession
- Send a message (Chat)
- Send a message (Group Chat)
- Send a message (Media Chat)
- Send a message (SMS)
- Send a message (Group SMS)
- Send a message (MMS)
- Update Messagesession (Participants)
- Update Messagesession (Session Name)
- Update Messagesession (Leave)
- Delete Messagesession
- SMS Numbers
- Recordings
- Email
- Connections
- Routes
- Meetings
- Event Logs
- Iotum
- Read Iotum Video Domain Resellers
- Read Iotum Video Host
- Read All Iotum Video Hosts in a Domain
- Read Iotum Video Host Conferences
- Read Iotum Video Host Contacts
- Read Iotum Video Company
- Read Iotum Video Company Products
- Read Iotum Video Available Products
- Create a Host
- Create Host Contacts
- Create Iotum Video Subscription
- Update Domain's Iotum Company
- Update Domain's Iotum Subscriptions
- Update User's Iotum Host
- Delete Iotum Video Subscription
- Delete a Host
- Create Iotum Video Company
- Create a Ad-hoc Conference
- Delete a Video Company
- Create a Meeting with Id
- Create a Meeting
- Read Meeting
- Count Domains Meetings
- Count Meeting
- Register Meeting
- Update a Meeting
- Delete a Meeting
- Request a Meeting ID
- Read Meetings for User
- Backup & Restore
- Configs
- Configurations
- Configuration Definitions
- Images
- Templates
- Timeframes
- Domain (Shared)
- User
- Holiday Information
- Firebase
- SSL Certificates
- Manage Code
- iNSight
- Conference
- SnapBuilder
- Charts
- Dashboards
- Quotas
- Departments
- Presence
Read a Specific Configuration Definition
GET
/config-definitions/{config-name}
Last modified:2023-12-21 20:52:24
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Path Params
Query Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://awqacore01.crexendocloud.com/ns-api/v2/config-definitions/PORTAL_NEW_CUSTOM_CONFIG'Responses
🟢200OK
application/json
Body
Example
[
{
"config-name": "PORTAL_NEW_CUSTOM_CONFIG",
"description": "new description",
"default": "yes",
"code-version": "v42.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "string",
"tags": "portal,emergency"
},
{
"config-name": "PORTAL_NEW_CUSTOM_CONFIG2",
"description": "new description",
"default": "no",
"code-version": "v42.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "string",
"tags": "portal,emergency"
},
{
"config-name": "PORTAL_NEW_CUSTOM_CONFIG3",
"description": "new description",
"default": "no",
"code-version": "v42.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "string",
"tags": "portal,emergency"
},
{
"config-name": "PORTAL_EMERG_USE_DROPDOWN_DID_LIST_STRIP_1",
"description": "This setting will allow the portal to suggest 11 digit domestic numbers as options for the emergency callerid. Default is to strip 1+ US domestic numbers to 10 digits for the dropdown. This setting is only valid when using PORTAL_USERS_911_USE_DROPDOWN_DID_LIST as well as having PORTAL_USERS_911_USE_DROPDOWN_EMERG_LIST disabled.",
"default": "yes",
"code-version": "42.1.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "no",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "binary",
"tags": "portal,emergency"
},
{
"config-name": "PORTAL_DOMAINS_EMERGENCY_TAB",
"description": "Show a emergency tab including the options for emergency notifications in the domain edit modal.",
"default": "no",
"code-version": "42.0.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "binary",
"tags": "portal,domain,emergency"
},
{
"config-name": "PORTAL_EMERGENCY_NOTIFICATION_DIAL_NUMBERS",
"description": "When emergency notifications are enabled for features like Kari's law support this will adjust which dial translations dial stings will be modified. The default is 911,933 to allow for a real string and a test string of 933 which is common service offering among emergency service vendors.",
"default": "911,933",
"code-version": "42.0.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "list",
"tags": "portal,emergency"
},
{
"config-name": "PORTAL_EMERGENCY_NOTIFICATION_MESSAGE",
"description": "This is the default message that will be send when using SIP message notification option.",
"default": "There is a emergency call from <OwnName> at <OwnUser>",
"code-version": "42.0.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "string",
"tags": "portal,emergency"
},
{
"config-name": "PORTAL_EMERGENCY_NOTIFICATION_SHOW_CALL",
"description": "When emergency notifications are enabled setting will enabled the voice call options.",
"default": "no",
"code-version": "42.0.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "binary",
"tags": "portal,emergency"
},
{
"config-name": "PORTAL_EMERGENCY_NOTIFICATION_SHOW_EMAIL",
"description": "When emergency notifications are enabled setting will enabled the Email notificaion options.",
"default": "no",
"code-version": "42.0.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "binary",
"tags": "portal,emergency"
},
{
"config-name": "PORTAL_EMERGENCY_NOTIFICATION_SHOW_MESSAGE",
"description": "When emergency notifications are enabled setting will enabled the SIP message options to supported devices.",
"default": "no",
"code-version": "42.0.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "binary",
"tags": "portal,emergency"
},
{
"config-name": "PORTAL_SITES_EMERGENCY_NOTIFICATIONS",
"description": "Allows the site edit settings to show emergency notification settings. Will also need to enable each notification type.",
"default": "no",
"code-version": "42.0.0",
"config-def-allow-hostname": "yes",
"config-def-allow-reseller-access": "yes",
"config-def-default-basic-user": "",
"config-def-default-call-center-supervisor": "",
"config-def-default-office-manager": "",
"config-def-default-reseller": "",
"config-def-default-super-user": "",
"data-type": "binary",
"tags": "portal,emergency,sites"
}
]🟠404Record not found
🟠400Bad Request
🟠401Authentication Required
Modified at 2023-12-21 20:52:24