From Bright Pattern Documentation
Jump to: navigation, search
imported>Tracy
 
(Updated via BpDeleteTranslateTags script)
 
Line 1: Line 1:
<translate>= Get List of Access Numbers=
+
= Get List of Access Numbers=
 
This method returns the list of access numbers assigned to the specified tenant with ''tenantUrl''. If the tenant is not specified (i.e., if ''tenantUrl'' is absent), it returns the list of unassigned access numbers.
 
This method returns the list of access numbers assigned to the specified tenant with ''tenantUrl''. If the tenant is not specified (i.e., if ''tenantUrl'' is absent), it returns the list of unassigned access numbers.
  
Line 52: Line 52:
  
 
<center>[[provider-api-specification/ImportTenant|< Previous]]  |  [[provider-api-specification/CreateAccessNumbers|Next >]]</center>
 
<center>[[provider-api-specification/ImportTenant|< Previous]]  |  [[provider-api-specification/CreateAccessNumbers|Next >]]</center>
</translate>
 

Latest revision as of 04:09, 29 May 2024

• 5.19 • 5.2 • 5.3 • 5.8

Get List of Access Numbers

This method returns the list of access numbers assigned to the specified tenant with tenantUrl. If the tenant is not specified (i.e., if tenantUrl is absent), it returns the list of unassigned access numbers.

For more information about access number parameters, see the Bright Pattern Contact Center Service Provider Guide, section Access Numbers.


Request

URL http[s]://<host>:<port>/configapi/v2/accessnumbers[/tenantUrl]
Method GET


Response

Content Type Access number data (content type: application/JSON)
Body
{
   "number":"12345678",
   "count":10,
   "tenantUrl":"example.com",
   "trunks":[
               {
                  "name":"trunk_name",
                  "prefix":"0"
                },
                .....
            ],
   “smsAccounts”: [
                “account name 1”,
                “account name 2”,
                .....
            ],
    “media”:”VOICE_AND_TEXT”
}
Code 200 - Success

403 - Access denied



< Previous | Next >
< Previous | Next >