- 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
- Sites
- Call Center
- Answer Rules
- Call Blocking
- Auto Attendant
- Media
- Voicemail
- Greetings
- Read 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
- 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
- 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)
- 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
- 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
- Images
- Templates
- Timeframes
- Domain (Shared)
- User
- Holiday Information
- Firebase
- SSL Certificates
Get Specific Connection for a Domain
GET
/domains/{domain}/connections/{connection-orig-match-pattern}
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
domain
stringÂ
required
connection-orig-match-pattern
stringÂ
required
Request 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/domains//connections/'
Responses
🟢200OK
application/json
Body
array of:
connection-orig-match-pattern
stringÂ
required
domain
stringÂ
required
<= 64 characters
Examples:
example.commyDomaintest.12123
Match pattern:
^[A-Za-z0-9._-]+|\*
description
stringÂ
optional
connection-term-match-pattern
stringÂ
optional
connection-audio-relay-enabled
stringÂ
optional
connection-address
stringÂ
optional
dial-plan
stringÂ
optional
dial-policy
stringÂ
optional
limits-max-active-calls-orig
integerÂ
optional
limits-max-active-calls-term
integerÂ
optional
limits-max-active-calls-total
integerÂ
optional
connection-linked-billing-user
stringÂ
optional
connection-sip-registration-username
stringÂ
optional
connection-sip-registration-password
stringÂ
optional
connection-sip-registration-realm
stringÂ
optional
connection-orig-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
yes
connection-term-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
yes
connection-translation-request-host
stringÂ
optional
connection-translation-destination-host
stringÂ
optional
Default:
''
Example:
[*]
connection-translation-request-user
stringÂ
optional
Default:
''
Example:
[*]
connection-translation-destination-user
stringÂ
optional
Default:
''
Example:
[*]
connection-translation-source-user
stringÂ
optional
Default:
''
Example:
[*]
connection-source-ip-checking-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-include-server-header-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-relay-comfort-noise-enabled
stringÂ
optional
Default:
system-default
Examples:
yesnosystem-default
connection-pcmu-only-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-enforce-minimum-duration-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-bind-to-alternate-interface-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-block-video-in-sdp-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-sip-get-new-dialog-destination-from
stringÂ
optional
Default:
default-ip
Examples:
contact-headervia-header
connection-sip-get-response-destination-from
stringÂ
optional
Default:
default-ip
Examples:
contact-headervia-header
connection-require-encrypted-audio-enabled
stringÂ
optional
Default:
no
Examples:
optionalyesno
connection-sip-transport-protocol
stringÂ
optional
Default:
UDP
Examples:
TCPTLS
connection-check-orig-matching-sip-header
stringÂ
optional
Default:
from
Examples:
torequestcontactfrom
connection-sip-session-timer-enabled
stringÂ
optional
Default:
system-default
Example:
no
connection-prevent-rtp-port-change-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-hide-post-dial-delay-with-ringback-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-remote-ringback-handling
stringÂ
optional
Default:
allowed
Examples:
no-ringbacklocal-onlyallowed
connection-block-media-in-sip-180-ringing
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-allow-mid-call-uri-updates-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-record-all-calls-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-custom-p-asserted-id-format
stringÂ
optional
Example:
sample
connection-require-sip-authentication-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-translation-source-host
stringÂ
optional
utc-offset
stringÂ
optional
Example:
-7
time-zone
stringÂ
optional
Example:
US/Pacific
minimum-call-duration-seconds
integerÂ
optional
Default:
0
connection-sip-registration-expires-datetime
stringÂ
optional
connection-sip-authenticate-as-client-enabled
enum<string>Â
optional
Allowed values:
yesno
Default:
no
connection-is-carrier-trunk
enum<string>Â
optional
Allowed values:
yesno
Default:
no
call-routing
string  | integer  | boolean  | array  | object  | number  | nullÂ
optional
active-calls-max-last-month
integerÂ
read-onlyoptional
active-calls-max-this-month
integerÂ
read-onlyoptional
active-calls-orig-current
integerÂ
read-onlyoptional
active-calls-orig-since-startup
integerÂ
read-onlyoptional
active-calls-term-current
integerÂ
read-onlyoptional
active-calls-term-since-startup
integerÂ
read-onlyoptional
connection-sip-registration-datetime
stringÂ
read-onlyoptional
last-modified-datetime
stringÂ
read-onlyoptional
Example
[
{
"connection-orig-match-pattern": "string",
"domain": "example.com",
"description": "string",
"connection-term-match-pattern": "string",
"connection-audio-relay-enabled": "string",
"connection-address": "string",
"dial-plan": "string",
"dial-policy": "string",
"limits-max-active-calls-orig": 0,
"limits-max-active-calls-term": 0,
"limits-max-active-calls-total": 0,
"connection-linked-billing-user": "string",
"connection-sip-registration-username": "string",
"connection-sip-registration-password": "string",
"connection-sip-registration-realm": "string",
"connection-orig-enabled": "yes",
"connection-term-enabled": "yes",
"connection-translation-request-host": "string",
"connection-translation-destination-host": "''",
"connection-translation-request-user": "''",
"connection-translation-destination-user": "''",
"connection-translation-source-user": "''",
"connection-source-ip-checking-enabled": "no",
"connection-include-server-header-enabled": "no",
"connection-relay-comfort-noise-enabled": "system-default",
"connection-pcmu-only-enabled": "no",
"connection-enforce-minimum-duration-enabled": "no",
"connection-bind-to-alternate-interface-enabled": "no",
"connection-block-video-in-sdp-enabled": "no",
"connection-sip-get-new-dialog-destination-from": "default-ip",
"connection-sip-get-response-destination-from": "default-ip",
"connection-require-encrypted-audio-enabled": "no",
"connection-sip-transport-protocol": "UDP",
"connection-check-orig-matching-sip-header": "from",
"connection-sip-session-timer-enabled": "system-default",
"connection-prevent-rtp-port-change-enabled": "no",
"connection-hide-post-dial-delay-with-ringback-enabled": "no",
"connection-remote-ringback-handling": "allowed",
"connection-block-media-in-sip-180-ringing": "no",
"connection-allow-mid-call-uri-updates-enabled": "no",
"connection-record-all-calls-enabled": "no",
"connection-custom-p-asserted-id-format": "sample",
"connection-require-sip-authentication-enabled": "no",
"connection-translation-source-host": "string",
"utc-offset": "-7",
"time-zone": "US/Pacific",
"minimum-call-duration-seconds": 0,
"connection-sip-registration-expires-datetime": "string",
"connection-sip-authenticate-as-client-enabled": "no",
"connection-is-carrier-trunk": "no",
"call-routing": "string",
"active-calls-max-last-month": 0,
"active-calls-max-this-month": 0,
"active-calls-orig-current": 0,
"active-calls-orig-since-startup": 0,
"active-calls-term-current": 0,
"active-calls-term-since-startup": 0,
"connection-sip-registration-datetime": "string",
"last-modified-datetime": "string"
}
]
🟠404Record not found
🟠400Bad Request
🟠401Authentication Required
Modified at 2023-12-21 20:52:24