Get Domains

GET

/domains

Last modified:2024-11-14 22:55:36

OperationId:GetDomains

This API is the same for both Super User and Reseller. If using Reseller scopped access there territory/reseller will be used from the access rights for the filter.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

Body

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://awqacore01.crexendocloud.com/ns-api/v2/domains?start&limit' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

[
    {
        "domain": "example.com",
        "reseller": "GlobalVoicePartners",
        "description": "Acme Corporation - Main Office",
        "music-on-hold-enabled": "yes",
        "music-on-ring-enabled": "yes",
        "music-on-hold-randomized-enabled": "yes",
        "domain-type": "Standard",
        "dial-plan": "acmecorp.voip.example.com",
        "dial-policy": "Standard-US-Domestic",
        "email-send-from-address": "noreply@globalvoicepartners.com",
        "single-sign-on-enabled": "yes",
        "area-code": 858,
        "caller-id-name": "Acme Corporation",
        "caller-id-number": "8585551234",
        "caller-id-number-emergency": "8585551200",
        "limits-max-subcriber-resources-total": 200,
        "limits-max-active-calls-total": 250,
        "limits-max-active-calls-offnet": 100,
        "limits-max-call-queues": 15,
        "limits-max-auto-attendants": 10,
        "limits-max-conferences": 20,
        "limits-max-departments": 25,
        "limits-max-users": 150,
        "limits-max-sites": 5,
        "limits-max-fax-accounts": 30,
        "time-zone": "US/Alaska",
        "email-send-smtp-hostname": "smtp.globalvoicepartners.com",
        "email-send-smtp-port": "587",
        "email-send-smtp-username": "smtp-user@globalvoicepartners.com",
        "email-send-smtp-password": "P@ssw0rd!2024",
        "active-calls-total-current": 47,
        "active-calls-against-license-count": 42,
        "active-calls-offnet-current": 23,
        "count-subcriber-resources-total": 167,
        "emergency-address-id": "addr-e911-12345-abcdef",
        "voicemail-enabled": "yes",
        "recording-configuration": "no",
        "voicemail-transcription-enabled": "no",
        "language-token": "en_US",
        "is-domain-locked": "yes",
        "is-stir-enabled": "yes",
        "is-ivr-forward-change-blocked": "yes"
    }
]

Modified at 2024-11-14 22:55:36

Get Specific Reseller

Count Domains