From Bright Pattern Documentation
Jump to: navigation, search
• 5.19 • 5.2 • 5.3 • 5.8

Create Access Numbers

This method creates a single access number or a continuous range of access numbers and assigns them to the tenant. This method can also assign the created access number to trunks and associate it with SMS accounts. The tenantUrl parameter is required, whereas parameters trunks, smsAccounts, and media are optional.

Parameter media can be set to one of the following values:

  • VOICE
  • TEXT
  • VOICE_AND_TEXT


Request

URL http[s]://<host>:<port>/configapi/v2/accessnumbers
Method POST
Request body Access number data (content type: application/JSON)
Example
{
   "number":"12345678",
   "count":10,
   "tenantUrl":"example.com",
   "trunks":[
               {
                  "name":"trunk_name",
                  "prefix":"0"
                },
                .....
            ],
   “smsAccounts”: [
                “account name 1”,
                “account name 2”,
                .....
            ],
    “media”:”VOICE_AND_TEXT”
}


Response

Code Description
204 Success
400 Bad arguments
403 Access denied
409 Already exists



< Previous | Next >
< Previous | Next >